Blueprint Class

Blueprint Class

Blueprint for creating an entity with a specific set of components and initial attribute values.

Inheritance Hierarchy

SystemObject
Slash.ECS.BlueprintsBlueprint

Namespace: Slash.ECS.Blueprints
Assembly: Slash.ECS.Blueprints (in Slash.ECS.Blueprints.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

[SerializableAttribute]
public sealed class Blueprint : IXmlSerializable, 
	IBinarySerializable

<SerializableAttribute>
Public NotInheritable Class Blueprint
	Implements IXmlSerializable, IBinarySerializable

[SerializableAttribute]
public ref class Blueprint sealed : IXmlSerializable, 
	IBinarySerializable

[<SealedAttribute>]
[<SerializableAttribute>]
type Blueprint =  
    class
        interface IXmlSerializable
        interface IBinarySerializable
    end

The Blueprint type exposes the following members.

Constructors

	Name	Description
	Blueprint	Constructs a new blueprint without any components or data.
	Blueprint(Blueprint)	Creates a deep copy of the specified blueprint.

Top

Properties

	Name	Description
	AttributeTable	Data for initializing the components of entities created with this blueprint.
	AttributeTableSerialized	Wrapper for AttributeTable property for xml serialization.
	ComponentTypes	Collection of types of components to add to entities created with this blueprint.
	ComponentTypesSerialized	Wrapper for ComponentTypes property for xml serialization.
	Parent	Parent blueprint of this one. All components and attributes of the parent are also available for this one. Attributes can be overwritten though.
	ParentId	Id of parent blueprint. Used for serialization/deserialization.

Top

Methods

	Name	Description
	Deserialize	Reads this object from its binary representation.
	Equals	Determines whether the specified Object is equal to the current Object. (Overrides ObjectEquals(Object).)
	GetAllComponentTypes	Returns an enumeration of all component types of this and all ancestor blueprints.
	GetAttributeTable	Returns the final attribute table to use for entity creation. Considers the attribute tables of the ancestors of this blueprint if there are any.
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode.)
	GetSchema	This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.
	ReadXml	Generates an object from its XML representation.
	Serialize	Converts this object to its binary representation.
	ShouldSerializeAttributeTableSerialized	Indicates if the AttributeTableSerialized property should be serialized via Xml.
	ShouldSerializeComponentTypesSerialized	Indicates if the ComponentTypesSerialized property should be serialized via Xml.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	TryGetValue	Tries to retrieve the value the specified key is mapped to within this blueprint. Searches for the key in a parent blueprint if existent.
	WriteXml	Converts an object into its XML representation.

Top

Reference

Slash.ECS.Blueprints Namespace