CryEngine.EntityClassAttribute

Public Member Functions | Properties | List of all members

Allows creating an entity class containing a default entity component that is spawned with every instance. Only used for types inheriting from 'EntityComponent'. More...

Inherits Attribute.

Public Member Functions
	EntityClassAttribute (string name="", string category="Game", string helper=null, string icon="prompt.bmp", bool hide=false)
	Initializes a new instance of the obsolete T:CryEngine.EntityClassAttribute class. More...

	EntityClassAttribute (string name="", string category="Game", string helper=null, IconType icon=IconType.None, bool hide=false)
	Initializes a new instance of the obsolete T:CryEngine.EntityClassAttribute class. More...

Properties
string	Name `[get, set]`
	Display name inside CRYENGINE's EntitySystem as well as Sandbox. More...

string	EditorPath `[get, set]`
	Entity category inside Sandbox. More...

string	Helper `[get, set]`
	Geometry path for 3D helper. More...

string	Icon `[get, set]`
	Bitmap path for 2D helper. More...

bool	Hide `[get, set]`
	If set to `true` the marked entity class will not be displayed inside Sandbox. More...

Detailed Description

Allows creating an entity class containing a default entity component that is spawned with every instance. Only used for types inheriting from 'EntityComponent'.

Constructor & Destructor Documentation

◆ EntityClassAttribute() [1/2]

CryEngine.EntityClassAttribute.EntityClassAttribute	(	string	name = `""`,
		string	category = `"Game"`,
		string	helper = `null`,
		string	icon = `"prompt.bmp"`,
		bool	hide = `false`
	)

inline

Initializes a new instance of the obsolete T:CryEngine.EntityClassAttribute class.

Parameters

name	Display name inside CRYENGINE's EntitySystem as well as Sandbox..
category	Entity category inside Sandbox..
helper	Geometry path for 3D helper..
icon	Bitmap path for 2D helper..
hide	If set to `true` the marked entity class will not be displayed inside Sandbox.

◆ EntityClassAttribute() [2/2]

CryEngine.EntityClassAttribute.EntityClassAttribute	(	string	name = `""`,
		string	category = `"Game"`,
		string	helper = `null`,
		IconType	icon = `IconType.None`,
		bool	hide = `false`
	)

inline

Initializes a new instance of the obsolete T:CryEngine.EntityClassAttribute class.

Parameters

name
category
helper
icon
hide

Display name inside CRYENGINE's EntitySystem as well as Sandbox.