Used to specify specific parameters for entity components. If a parameter is not set, a default value will be set by the engine. Default name is the entity component class name. Default category is General. Default description will be empty. Default icon will be empty (entity components still receive an icon in the Sandbox by default). Default guid will be retrieved from a GUID-attribute if available. Otherwise it will be generated based on the class's fullname. More...
Inherits Attribute.
Public Member Functions | |
| EntityComponentAttribute (string uiName="", string category="", string description="", string icon="", string guid="") | |
| Used to specify specific parameters for entity components. If a parameter is not set, a default value will be set by the engine. Default name is the entity component class name. Default category is General. Default description will be empty. Default icon will be empty (entity components still receive an icon in the Sandbox by default). Default guid will be retrieved from a GUID-attribute if available. Otherwise it will be generated based on the class's fullname. More... | |
Properties | |
| string | Name [get, set] |
| Display name inside CRYENGINE's EntitySystem as well as Sandbox. More... | |
| string | Category [get, set] |
| Entity category inside Sandbox. More... | |
| string | Description [get, set] |
| User friendly description of what the component is for. More... | |
| string | Icon [get, set] |
| Editor icon string, i.e. "icons:designer/Designer_Box.ico" More... | |
| string | Guid [get, set] |
Systems reference entity components by GUID, for example when serializing to file to detect which type a component belongs to. By default we generate a GUID automatically based on the EntityComponent implementation type, however this will result in serialization breaking if you rename it. To circumvent this you can explicitly specify your desired GUID. Default GUID format is "C47DF64B-E1F9-40D1-8063-2C533A1CE7D5". More... | |
Used to specify specific parameters for entity components. If a parameter is not set, a default value will be set by the engine. Default name is the entity component class name. Default category is General. Default description will be empty. Default icon will be empty (entity components still receive an icon in the Sandbox by default). Default guid will be retrieved from a GUID-attribute if available. Otherwise it will be generated based on the class's fullname.
|
inline |
Used to specify specific parameters for entity components. If a parameter is not set, a default value will be set by the engine. Default name is the entity component class name. Default category is General. Default description will be empty. Default icon will be empty (entity components still receive an icon in the Sandbox by default). Default guid will be retrieved from a GUID-attribute if available. Otherwise it will be generated based on the class's fullname.
| uiName | The name of the component as it will be shown in the Sandbox. |
| category | The category in the Create Object and Add Component menu of the Sandbox that this component will be shown in. |
| description | Description of the component that will be shown in tooltips. |
| icon | Path to an icon in the icon folder. |
| guid | GUID in the format of XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
|
get set |
Entity category inside Sandbox.
|
get set |
User friendly description of what the component is for.
|
get set |
Systems reference entity components by GUID, for example when serializing to file to detect which type a component belongs to. By default we generate a GUID automatically based on the EntityComponent implementation type, however this will result in serialization breaking if you rename it. To circumvent this you can explicitly specify your desired GUID. Default GUID format is "C47DF64B-E1F9-40D1-8063-2C533A1CE7D5".
The string value of the GUID.
|
get set |
Editor icon string, i.e. "icons:designer/Designer_Box.ico"
|
get set |
Display name inside CRYENGINE's EntitySystem as well as Sandbox.