Entity editor attribute system

Data Structures
class	IEntity
class	ParamEnum
class	Attribute

Enumerations
enum	EntityEvent {   TOUCH, VISIBLE, NOTVISIBLE, FRAME,   POSTFRAME, INIT, JOINTBREAK, SIMULATE,   POSTSIMULATE, PHYSICSMOVE, CONTACT, EXTRA,   ANIMEVENT, SOUNDEVENT, PHYSICSSTEADY, USER,   ENTER, LEAVE, ALL }
	Entity events for event-mask, or throwing event from code. More...
enum	EntityFlags {   VISIBLE, SOLID, TRIGGER, TOUCHTRIGGERS,   SYNCHRONIZATION_DIRTY, FEATURE, TRANSLUCENT, WATER,   ACTIVE, STATIC, USER1, USER2,   USER3, USER4, USER5, USER6 }
	Entity flags. More...

Functions
ParamEnum Managed	FromEnum (typename e)
void	ParamEnum (string key, string value, string desc="")
void	EditorAttribute (string style, string category, string description, vector sizeMin, vector sizeMax, string color, string color2="0 0 0 0", bool visible=true, bool insertable=true, bool dynamicBox=false)

Variables
string	m_Key
string	m_Value
string	m_Desc
class Attribute	m_Style
	can be "box", "sphere", "cylinder", "pyramid", "diamond" or custom style name More...
string	m_Category
	folder structure eg. StaticEntities/Walls More...
string	m_Description
	class purpose description More...
vector	m_SizeMin
	min vector of a bounding box More...
vector	m_SizeMax
	max vector of a bounding box More...
string	m_Color
string	m_Color2
bool	m_Visible
bool	m_Insertable
bool	m_DynamicBox

Detailed Description

Enumeration Type Documentation

EntityEvent

enum EntityEvent

Entity events for event-mask, or throwing event from code.

Enumerator
TOUCH	entity was touched by other entity
VISIBLE	entity is visible, so part of the rendering other WorldClass extra frame index result false should be rendered, true shoudn't be rendered Entity is visible. Is rendered if there is some attached object and event EntityEvent.VISIBLE is invoked, when event mask is set.
NOTVISIBLE	entity is not visible, will not be part of rendering other WorldClass extra frame index
FRAME	new frame event, called each frame other WorldClass extra frame index
POSTFRAME	event at the end of each frame or when entity is moved during the frame other WorldClass
INIT	event called after the world is created, including all entities other WorldClass
JOINTBREAK
SIMULATE
POSTSIMULATE
PHYSICSMOVE
CONTACT
EXTRA
ANIMEVENT
SOUNDEVENT
PHYSICSSTEADY
USER
ENTER	Object entered Trigger.
LEAVE	Object left Trigger.
ALL	Mask of all events. Looks in archives and fs directories.

Definition at line 44 of file enentity.c.

EntityFlags

enum EntityFlags

Entity flags.

Enumerator
VISIBLE	entity is visible, so part of the rendering other WorldClass extra frame index result false should be rendered, true shoudn't be rendered Entity is visible. Is rendered if there is some attached object and event EntityEvent.VISIBLE is invoked, when event mask is set.
SOLID	Is collidable by various trace methods.
TRIGGER	Is not collidable, but invokes touch events.
TOUCHTRIGGERS	Interacts with triggers.
SYNCHRONIZATION_DIRTY	Entity wants to synchronize (network)
FEATURE	Scene rendering hint for dominant objects that are not culled by standard way.
TRANSLUCENT	Used by tracing methods. When tracing with TraceFlags.PASSTRANSLUCENT, then this entity is ignored. Used for glass for example.
WATER	Used by tracing methods. Traceable only with flag TraceFlags.WATER.
ACTIVE	Tells that this entity has to be actively updated by engine, its EntityEvent.FRAME has to be called etc.
STATIC	Static objects are included in the query. Tells that this entity will represent mostly static object, so we can use more precise but slower methods for scene-tree linking. Also it tells to scene tree that he can count with this entity as tree-split hint.
USER1	Flags for custom usage and filterings.
USER2
USER3
USER4
USER5
USER6

Definition at line 114 of file enentity.c.

Function Documentation

EditorAttribute()

void EditorAttribute	(	string	style,
		string	category,
		string	description,
		vector	sizeMin,
		vector	sizeMax,
		string	color,
		string	color2 = "0 0 0 0",
		bool	visible = true,
		bool	insertable = true,
		bool	dynamicBox = false
	)

Definition at line 854 of file enentity.c.

FromEnum()

ParamEnum Managed FromEnum

(

typename e

)

Definition at line 804 of file enentity.c.

ParamEnum()

void FromEnum::ParamEnum	(	string	key,
		string	value,
		string	desc = ""
	)

Definition at line 8 of file enentity.c.

Variable Documentation

m_Category

string m_Category

folder structure eg. StaticEntities/Walls

Definition at line 844 of file enentity.c.

m_Color

string m_Color

Definition at line 848 of file enentity.c.

m_Color2

string m_Color2

Definition at line 849 of file enentity.c.

m_Desc

string m_Desc

Definition at line 6 of file enentity.c.

m_Description

string m_Description

class purpose description

Definition at line 845 of file enentity.c.

m_DynamicBox

bool m_DynamicBox

Definition at line 852 of file enentity.c.

m_Insertable

bool m_Insertable

Definition at line 851 of file enentity.c.

m_Key

string m_Key

Definition at line 4 of file enentity.c.

m_SizeMax

vector m_SizeMax

max vector of a bounding box

Definition at line 847 of file enentity.c.

m_SizeMin

vector m_SizeMin

min vector of a bounding box

Definition at line 846 of file enentity.c.

m_Style

class Attribute m_Style

can be "box", "sphere", "cylinder", "pyramid", "diamond" or custom style name

m_Value

string m_Value

Definition at line 5 of file enentity.c.

m_Visible

bool m_Visible

Definition at line 850 of file enentity.c.