Entity editor attribute system

Data Structures
class	Attribute
class	IEntity
	Internal ancestor of all Entity implementations. More...
class	ParamEnum

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
void	Attribute (string defvalue, string uiwidget, string desc="", string rangescale="", ParamEnumArray enums=NULL)
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)
ParamEnum Managed	FromEnum (typename e)
proto bool	Get (int varIndex, out void val)
proto native IEntitySource	GetChildren ()
proto native WidgetSource	GetChildren ()
proto native owned string	GetClassName ()
proto native owned string	GetName ()
proto native IEntitySource	GetParent ()
proto native WidgetSource	GetParent ()
proto native IEntitySource	GetSibling ()
proto native WidgetSource	GetSibling ()
proto bool	IsType (int varIndex, typename type)
proto native bool	IsVariableSet (int varIndex)
void	ParamEnum (string key, string value, string desc="")
proto native int	VarIndex (string varName)

Variables
string	m_Category
	folder structure eg. StaticEntities/Walls
string	m_Color
string	m_Color2
string	m_DefValue
string	m_Desc
string	m_Desc
string	m_Desc
string	m_Description
	class purpose description
bool	m_DynamicBox
ref ParamEnumArray	m_Enums
	Only ints and floats are currently supported. Array can be defined this way: { ParamEnum("Choice 1", "1"), ParamEnum("Choicen 2", "2") }.
bool	m_Insertable
string	m_Key
string	m_Key
string	m_RangeScale
	defined as "MIN_VALUE MAX_VALUE STEP" eg. "1 100 0.5"
vector	m_SizeMax
	max vector of a bounding box
vector	m_SizeMin
	min vector of a bounding box
class Attribute	m_Style
	can be "box", "sphere", "cylinder", "pyramid", "diamond" or custom style name
string	m_UiWidget
	can be "editbox", "combobox", "spinbox", "slider", "font", "fileeditbox", "colorPicker", "flags", "resourceNamePicker"
string	m_Value
string	m_Value
bool	m_Visible

Event methods
Event method stubs. Reimplement these in inherited entities to receive event calls
void	EOnTouch (IEntity other, int extra)
	EntityEvent.TOUCH.
void	EOnInit (IEntity other, int extra)
	EntityEvent.INIT.
void	EOnExtra (IEntity other, int extra)
	EntityEvent.EXTRA.
void	EOnNotVisible (IEntity other, int extra)
	EntityEvent.NOTVISIBLE.
void	EOnFrame (IEntity other, float timeSlice)
	EntityEvent.FRAME.
int	EOnVisible (IEntity other, int extra)
	EntityEvent.VISIBLE.
void	EOnPostFrame (IEntity other, int extra)
	EntityEvent.POSTFRAME.
void	EOnWorldProcess (IEntity other, int extra)
	EntityEvent.WORLDPROCESS.
void	EOnAnimEvent (IEntity other, AnimEvent extra)
	EntityEvent.ANIMEVENT.
void	EOnSoundEvent (IEntity other, SoundEvent extra)
	EntityEvent.SOUNDEVENT.
void	EOnSimulate (IEntity other, float dt)
	EntityEvent.SIMULATE.
void	EOnPostSimulate (IEntity other, float timeSlice)
	EntityEvent.POSTSIMULATE.
void	EOnJointBreak (IEntity other, int extra)
	EntityEvent.JOINTBREAK.
void	EOnPhysicsMove (IEntity other, int extra)
	EntityEvent.PHYSICSMOVE.
void	EOnContact (IEntity other, Contact extra)
	EntityEvent.CONTACT.
void	EOnUser0 (IEntity other, int extra)
	EntityEvent.EV_USER+0.
void	EOnUser1 (IEntity other, int extra)
	EntityEvent.EV_USER+1.
void	EOnEnter (IEntity other, int extra)
	EntityEvent.ENTER.
void	EOnLeave (IEntity other, int extra)
	EntityEvent.LEAVE.
void	EOnUser4 (IEntity other, int extra)
	EntityEvent.EV_USER+4.
void	EOnDummy020 (IEntity other, int extra)
	Placeholder.
void	EOnDummy021 (IEntity other, int extra)
	Placeholder.
void	EOnDummy022 (IEntity other, int extra)
	Placeholder.
void	EOnDummy023 (IEntity other, int extra)
	Placeholder.
void	EOnDummy024 (IEntity other, int extra)
	Placeholder.
void	EOnDummy025 (IEntity other, int extra)
	Placeholder.
void	EOnDummy026 (IEntity other, int extra)
	Placeholder.
void	EOnDummy027 (IEntity other, int extra)
	Placeholder.
void	EOnDummy028 (IEntity other, int extra)
	Placeholder.
void	EOnDummy029 (IEntity other, int extra)
	Placeholder.
void	EOnDummy030 (IEntity other, int extra)
	Placeholder.
void	EOnDummy031 (IEntity other, int extra)
	Placeholder.

Transformation methods
Setting and getting of entity transformation
proto external void	GetTransform (out vector mat[])
	Returns transformation of Entity.
proto external void	GetRenderTransform (out vector mat[])
	Returns render transformation of Entity.
proto external void	GetLocalTransform (out vector mat[])
	Returns local transformation of Entity.
proto native external vector	GetTransformAxis (int axis)
	Returns one row of Entity transformation matrix.
proto native external void	SetTransform (vector mat[4])
	Sets entity transformation.
proto native external vector	GetOrigin ()
	Returns origin of Entity.
proto external vector	GetLocalPosition ()
	Returns local position of Entity.
proto native external vector	GetYawPitchRoll ()
	Returns orientation of Entity in world space (Yaw, Pitch, Roll).
proto native external vector	GetAngles ()
	Same as GetYawPitchRoll, but returns rotation vector around X, Y and Z axis.
proto native external vector	GetLocalYawPitchRoll ()
	Returns local orientation when it's in hierarchy (Yaw, Pitch, Roll).
proto native external vector	GetLocalAngles ()
	Same as GetLocalYawPitchRoll, but returns rotation vector around X, Y and Z axis.
proto native external void	SetYawPitchRoll (vector angles)
	Sets angles for entity (Yaw, Pitch, Roll).
proto native external void	SetAngles (vector angles)
	Same as SetYawPitchRoll, but sets rotation around X, Y and Z axis.
proto native external void	SetOrigin (vector orig)
	Sets origin for entity.
proto native external float	GetScale ()
proto native external void	SetScale (float scale)
proto native external vector	VectorToParent (vector vec)
	Transforms local vector to world space.
proto native external vector	CoordToParent (vector coord)
	Transforms local position to world space.
proto native external vector	VectorToLocal (vector vec)
	Transforms world space vector to local space.
proto native external vector	CoordToLocal (vector coord)
	Transforms world space position to local space.

Name/ID methods
proto native int	GetID ()
	Return unique entity ID.
proto native void	SetID (int id)
	Set unique entity ID.
proto native void	SetName (string name)
proto native external owned string	GetName ()

Hierarchy methods
Scene hierarchy management
proto native external bool	AddChild (notnull IEntity child, int pivot, bool positionOnly=false)
	Adds child entity to this entity.
proto native external bool	RemoveChild (notnull IEntity child, bool keepTransform=false)
	Removes child entity from hierarchy.
proto native external Physics	GetPhysics ()
proto native bool	IsHierarchyPositionOnly ()
	Returns if the hierarchy component was created with positionOnly.
proto native int	GetHierarchyPivot ()
	Returns the hierarchy component pivot.
proto native IEntity	GetParent ()
	Returns pointer to parent Entity in hierarchy.
proto native IEntity	GetChildren ()
	Returns pointer to first child Entity in hierarchy.
proto native IEntity	GetSibling ()
	Returns pointer to next child Entity on the same hierarchy.
proto external void	GetBounds (out vector mins, out vector maxs)
	Returns local bounding box of model on Entity.
proto external void	GetWorldBounds (out vector mins, out vector maxs)
	Returns quantized world-bound-box of Entity.

Simulation/handling properties
Flags that affects simulation and entity handling behavior
proto native external EntityFlags	GetFlags ()
	Returns Entity flags.
proto native external bool	IsFlagSet (EntityFlags flags)
	Test if one or more of specified flags are set.
proto native external EntityFlags	SetFlags (EntityFlags flags, bool recursively)
	Sets Entity flags.
proto native external EntityFlags	ClearFlags (EntityFlags flags, bool recursively)
	Clear Entity flags.
proto native external EntityEvent	GetEventMask ()
	Returns current event mask.
proto native external EntityEvent	SetEventMask (EntityEvent e)
	Sets event mask.
proto native external EntityEvent	ClearEventMask (EntityEvent e)
	Clears event mask.
proto external volatile void	SendEvent (notnull IEntity actor, EntityEvent e, void extra)
	Dynamic event invokation. Parameters are the same as in IEntity::EOnXXXX() methods.

Visual component methods
Manipulation with visual component - model, particle effect etc
proto native external void	SetObject (vobject object, string options)
proto native vobject	GetVObject ()
	Returns visual object set to this Entity.
proto native external int	Animate (float speed, int loop)
	Updates animation (either xob, or particle, whatever).
proto native external int	AnimateEx (float speed, int loop, out vector lin, out vector ang)
	Updates animation (either xob, or particle, whatever).
proto native external int	SetCameraMask (int mask)
	Sets visibility mask for cameras, where Entity will be rendered.
proto native external void	FilterNextTrace ()
	When called, the Entity is excluded from consequent TraceMove/TraceLine.
proto native external int	Update ()

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.

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	Tells that this entity will represent mostly static object, so we can use more precise but slower methods for scene-tree linking. Static objects are included in the query. 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

Attribute()

void Attribute ( string defvalue, string uiwidget, string desc = "", string rangescale = "", ParamEnumArray enums = NULL )

inlineprivate

Definition at line 833 of file enentity.c.

References m_DefValue, m_Desc, m_Enums, m_RangeScale, and m_UiWidget.

ParamEnum() [1/2]

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

inlineprivate

Definition at line 796 of file enentity.c.

References m_Desc, m_Key, and m_Value.

AddChild()

proto native external bool AddChild ( notnull IEntity child, int pivot, bool positionOnly = false )

protected

Adds child entity to this entity.

Note

Make sure the parent is not ToDelete

Parameters

child	IEntity Pointer to entity which become our child
pivot	int Pivot is pivot index, or -1 for center of parent.
positionOnly	bool When set to true, the orientation will still be in WS.

Returns

bool True when entity has been attached. False otherwise.

Animate()

proto native external int Animate ( float speed, int loop )

protected

Updates animation (either xob, or particle, whatever).

AnimateEx()

proto native external int AnimateEx ( float speed, int loop, out vector lin, out vector ang )

protected

Updates animation (either xob, or particle, whatever).

ClearEventMask()

proto native external EntityEvent ClearEventMask ( EntityEvent e )

protected

Clears event mask.

Parameters

e	int event mask

Returns

int event mask

Man player = g_Game.GetPlayer();
player.SetEventMask(EntityEvent.VISIBLE );
Print( player.GetEventMask() );
player.ClearEventMask(EntityEvent.ALL );
Print( player.GetEventMask() );
 
>> 128
>> 0

ClearFlags()

proto native external EntityFlags ClearFlags ( EntityFlags flags, bool recursively )

protected

Clear Entity flags.

Returns cleared flags

Parameters

flags	int flags to be set
recursively	flags will be recursively applied to children of hierarchy too

Returns

int cleared flags

Man player = g_Game.GetPlayer();
player.ClearFlags(EntityFlags.VISIBLE|EntityFlags.SOLID );
Print( player.GetFlags() );
 
>> 1610612744

CoordToLocal()

proto native external vector CoordToLocal ( vector coord )

protected

Transforms world space position to local space.

Parameters

coord

vector world space position to transform

Returns

vector position in local space

Man player = g_Game.GetPlayer();
Print( player.CoordToLocal("500 10 155") );
 
>> <15254,-54.2004,8745.53>

CoordToParent()

proto native external vector CoordToParent ( vector coord )

protected

Transforms local position to world space.

Parameters

coord

vector local position to transform

Returns

vector position in world space

Man player = g_Game.GetPlayer();
Print( player.CoordToParent("1 2 3") );
 
>> <2549,17.6478,2857>

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 856 of file enentity.c.

References m_Category, m_Color, m_Color2, m_Description, m_DynamicBox, m_Insertable, m_SizeMax, m_SizeMin, m_Style, and m_Visible.

EOnAnimEvent()

void EOnAnimEvent ( IEntity other, AnimEvent extra )

inlineprotected

EntityEvent.ANIMEVENT.

Definition at line 195 of file enentity.c.

EOnContact()

void EOnContact ( IEntity other, Contact extra )

inlineprotected

EntityEvent.CONTACT.

Definition at line 213 of file enentity.c.

EOnDummy020()

void EOnDummy020 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 231 of file enentity.c.

EOnDummy021()

void EOnDummy021 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 234 of file enentity.c.

EOnDummy022()

void EOnDummy022 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 237 of file enentity.c.

EOnDummy023()

void EOnDummy023 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 240 of file enentity.c.

EOnDummy024()

void EOnDummy024 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 243 of file enentity.c.

EOnDummy025()

void EOnDummy025 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 246 of file enentity.c.

EOnDummy026()

void EOnDummy026 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 249 of file enentity.c.

EOnDummy027()

void EOnDummy027 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 252 of file enentity.c.

EOnDummy028()

void EOnDummy028 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 255 of file enentity.c.

EOnDummy029()

void EOnDummy029 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 258 of file enentity.c.

EOnDummy030()

void EOnDummy030 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 261 of file enentity.c.

EOnDummy031()

void EOnDummy031 ( IEntity other, int extra )

inlineprotected

Placeholder.

Definition at line 264 of file enentity.c.

EOnEnter()

void EOnEnter ( IEntity other, int extra )

inlineprotected

EntityEvent.ENTER.

Definition at line 222 of file enentity.c.

EOnExtra()

void EOnExtra ( IEntity other, int extra )

inlineprotected

EntityEvent.EXTRA.

Definition at line 177 of file enentity.c.

EOnFrame()

void EOnFrame ( IEntity other, float timeSlice )

inlineprotected

EntityEvent.FRAME.

Definition at line 183 of file enentity.c.

EOnInit()

void EOnInit ( IEntity other, int extra )

inlineprotected

EntityEvent.INIT.

Definition at line 174 of file enentity.c.

EOnJointBreak()

void EOnJointBreak ( IEntity other, int extra )

inlineprotected

EntityEvent.JOINTBREAK.

Definition at line 207 of file enentity.c.

EOnLeave()

void EOnLeave ( IEntity other, int extra )

inlineprotected

EntityEvent.LEAVE.

Definition at line 225 of file enentity.c.

EOnNotVisible()

void EOnNotVisible ( IEntity other, int extra )

inlineprotected

EntityEvent.NOTVISIBLE.

Definition at line 180 of file enentity.c.

EOnPhysicsMove()

void EOnPhysicsMove ( IEntity other, int extra )

inlineprotected

EntityEvent.PHYSICSMOVE.

Definition at line 210 of file enentity.c.

EOnPostFrame()

void EOnPostFrame ( IEntity other, int extra )

inlineprotected

EntityEvent.POSTFRAME.

Definition at line 189 of file enentity.c.

EOnPostSimulate()

void EOnPostSimulate ( IEntity other, float timeSlice )

inlineprotected

EntityEvent.POSTSIMULATE.

Definition at line 204 of file enentity.c.

EOnSimulate()

void EOnSimulate ( IEntity other, float dt )

inlineprotected

EntityEvent.SIMULATE.

Definition at line 201 of file enentity.c.

EOnSoundEvent()

void EOnSoundEvent ( IEntity other, SoundEvent extra )

inlineprotected

EntityEvent.SOUNDEVENT.

Definition at line 198 of file enentity.c.

EOnTouch()

void EOnTouch ( IEntity other, int extra )

inlineprotected

EntityEvent.TOUCH.

Definition at line 171 of file enentity.c.

EOnUser0()

void EOnUser0 ( IEntity other, int extra )

inlineprotected

EntityEvent.EV_USER+0.

Definition at line 216 of file enentity.c.

EOnUser1()

void EOnUser1 ( IEntity other, int extra )

inlineprotected

EntityEvent.EV_USER+1.

Definition at line 219 of file enentity.c.

EOnUser4()

void EOnUser4 ( IEntity other, int extra )

inlineprotected

EntityEvent.EV_USER+4.

Definition at line 228 of file enentity.c.

EOnVisible()

int EOnVisible ( IEntity other, int extra )

inlineprotected

EntityEvent.VISIBLE.

Definition at line 186 of file enentity.c.

EOnWorldProcess()

void EOnWorldProcess ( IEntity other, int extra )

inlineprotected

EntityEvent.WORLDPROCESS.

Definition at line 192 of file enentity.c.

FilterNextTrace()

proto native external void FilterNextTrace ( )

protected

When called, the Entity is excluded from consequent TraceMove/TraceLine.

FromEnum()

ParamEnum Managed FromEnum

(

typename e

)

Definition at line 3 of file enentity.c.

Get()

proto bool Get ( int varIndex, out void val )

private

Referenced by CheckLocalisationPlugin::FindTexts().

GetAngles()

proto native external vector GetAngles ( )

protected

Same as GetYawPitchRoll, but returns rotation vector around X, Y and Z axis.

GetBounds()

proto external void GetBounds ( out vector mins, out vector maxs )

protected

Returns local bounding box of model on Entity.

Parameters

[out]	mins	vector minimum point of bounding box
[out]	maxs	vector maximum point of bounding box Man player = g_Game.GetPlayer(); vector mins, maxs; player.GetBounds(mins, maxs ); Print( mins ); Print( maxs ); >> <0,0,0> >> <0,0,0>

GetChildren() [1/3]

proto native IEntity GetChildren ( )

protected

Returns pointer to first child Entity in hierarchy.

Referenced by GetAttachedChildren().

GetChildren() [2/3]

proto native IEntitySource GetChildren ( )

private

GetChildren() [3/3]

proto native WidgetSource GetChildren ( )

private

Referenced by CheckLocalisationPlugin::FindTexts().

GetClassName()

proto native owned string GetClassName ( )

private

GetEventMask()

proto native external EntityEvent GetEventMask ( )

protected

Returns current event mask.

Returns

int current event mask

Man player = g_Game.GetPlayer();
Print( player.GetEventMask() );
 
>> 0

GetFlags()

proto native external EntityFlags GetFlags ( )

protected

Returns Entity flags.

Returns

EntityFlags entity flags

Man player = g_Game.GetPlayer();
Print( player.GetFlags() );
 
>> 1610612745

GetHierarchyPivot()

proto native int GetHierarchyPivot ( )

protected

Returns the hierarchy component pivot.

GetID()

proto native int GetID ( )

protected

Return unique entity ID.

Returns

int unique entity ID

ItemBase apple = g_Game.CreateObject( "FruitApple", String2Vector("0 10 0"), false );
Print( apple.GetID() );
 
>> 0

GetLocalAngles()

proto native external vector GetLocalAngles ( )

protected

Same as GetLocalYawPitchRoll, but returns rotation vector around X, Y and Z axis.

GetLocalPosition()

proto external vector GetLocalPosition ( )

protected

Returns local position of Entity.

Returns

vector entity local position

Man player = g_Game.GetPlayer();
Print( player.GetOrigin() );
 
>> <2577.02,15.6837,2924.27>

GetLocalTransform()

proto external void GetLocalTransform ( out vector mat[] )

protected

Returns local transformation of Entity.

It returns only so much vectors as array is big

Parameters

mat	vector[1...4] matrix to be get Man player = g_Game.GetPlayer(); vector mat[4]; player.GetTransform(mat); Print( mat ); >> <0.989879,-0,0.141916>,<0,1,0>,<-0.141916,0,0.989879>,<2545.08,15.6754,2867.49>

GetLocalYawPitchRoll()

proto native external vector GetLocalYawPitchRoll ( )

protected

Returns local orientation when it's in hierarchy (Yaw, Pitch, Roll).

Returns

vector local orientation

Man player = g_Game.GetPlayer();
Print( player.GetLocalYawPitchRoll() );
 
>> <180,-57.2585,180>

GetName() [1/2]

proto native owned string GetName ( )

private

Referenced by CheckLocalisationPlugin::FindTexts().

GetName() [2/2]

proto native external owned string GetName ( )

protected

GetOrigin()

proto native external vector GetOrigin ( )

protected

Returns origin of Entity.

Returns

vector entity origin

Man player = g_Game.GetPlayer();
Print( player.GetOrigin() );
 
>> <2577.02,15.6837,2924.27>

Referenced by OnUpdate().

GetParent() [1/3]

proto native IEntity GetParent ( )

protected

Returns pointer to parent Entity in hierarchy.

GetParent() [2/3]

proto native IEntitySource GetParent ( )

private

GetParent() [3/3]

proto native WidgetSource GetParent ( )

private

GetPhysics()

proto native external Physics GetPhysics ( )

protected

GetRenderTransform()

proto external void GetRenderTransform ( out vector mat[] )

protected

Returns render transformation of Entity.

Must pass in vector array size of 4

Parameters

mat	vector[4] matrix to be get Man player = g_Game.GetPlayer(); vector mat[4]; player.GetRenderTransform(mat); Print( mat ); >> <0.989879,-0,0.141916>,<0,1,0>,<-0.141916,0,0.989879>,<2545.08,15.6754,2867.49>

GetScale()

proto native external float GetScale ( )

protected

Referenced by AddArrow().

GetSibling() [1/3]

proto native IEntity GetSibling ( )

protected

Returns pointer to next child Entity on the same hierarchy.

Referenced by GetAttachedChildren().

GetSibling() [2/3]

proto native IEntitySource GetSibling ( )

private

GetSibling() [3/3]

proto native WidgetSource GetSibling ( )

private

Referenced by CheckLocalisationPlugin::FindTexts().

GetTransform()

proto external void GetTransform ( out vector mat[] )

protected

Returns transformation of Entity.

It returns only so much vectors as array is big

Parameters

mat	vector[1...4] matrix to be get Man player = g_Game.GetPlayer(); vector mat[4]; player.GetTransform(mat); Print( mat ); >> <0.989879,-0,0.141916>,<0,1,0>,<-0.141916,0,0.989879>,<2545.08,15.6754,2867.49>

Referenced by AddArrow(), and Gizmo_GetWorldTransform().

GetTransformAxis()

proto native external vector GetTransformAxis ( int axis )

protected

Returns one row of Entity transformation matrix.

Parameters

axis	int matrix axis. Can be 0..3

Returns

vector axis row of Entity matrix

Man player = g_Game.GetPlayer();
Print( player.GetTransformAxis(0) );
Print( player.GetTransformAxis(1) );
Print( player.GetTransformAxis(2) );
Print( player.GetTransformAxis(3) );
 
>> <-0.386781,0,0.922171>
>> <0,1,0>
>> <-0.922171,0,-0.386782>
>> <2551.34,15.6439,2856.72>

GetVObject()

proto native vobject GetVObject ( )

protected

Returns visual object set to this Entity.

No reference is added

GetWorldBounds()

proto external void GetWorldBounds ( out vector mins, out vector maxs )

protected

Returns quantized world-bound-box of Entity.

Parameters

[out]	mins	vector minimum point of bounding box
[out]	maxs	vector maximum point of bounding box Man player = g_Game.GetPlayer(); vector mins, maxs; player.GetWorldBounds( mins, maxs ); Print( mins ); Print( maxs ); >> <2547.2,15.5478,2852.85> >> <2548.8,17.5478,2855.05>

GetYawPitchRoll()

proto native external vector GetYawPitchRoll ( )

protected

Returns orientation of Entity in world space (Yaw, Pitch, Roll).

Returns

vector entity orientation

Man player = g_Game.GetPlayer();
Print( player.GetYawPitchRoll() );
 
>> <180,-76.5987,180>

IsFlagSet()

proto native external bool IsFlagSet ( EntityFlags flags )

protected

Test if one or more of specified flags are set.

Returns

bool True if is set, false otherwise.

Man player = g_Game.GetPlayer();
player.SetFlags(EntityFlags.VISIBLE);
Print( player.IsFlagSet(EntityFlags.VISIBLE) );
 
>> true

IsHierarchyPositionOnly()

proto native bool IsHierarchyPositionOnly ( )

protected

Returns if the hierarchy component was created with positionOnly.

IsType()

proto bool IsType ( int varIndex, typename type  )

private

IsVariableSet()

proto native bool IsVariableSet ( int varIndex )

private

ParamEnum() [2/2]

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

Definition at line 811 of file enentity.c.

References ParamEnum().

Referenced by ParamEnum().

RemoveChild()

proto native external bool RemoveChild ( notnull IEntity child, bool keepTransform = false )

protected

Removes child entity from hierarchy.

Note

Make sure the child is not ToDelete

Parameters

child	IEntity Pointer to child entity we want to remove.
keepTransform	bool When set to true, Entity is kept on her world position. Otherwise it's local transform is used as world-space one.

Returns

bool True if it was removed, false when this entity is not our child.

SendEvent()

proto external volatile void SendEvent ( notnull IEntity actor, EntityEvent e, void extra )

protected

Dynamic event invokation. Parameters are the same as in IEntity::EOnXXXX() methods.

SetAngles()

proto native external void SetAngles ( vector angles )

protected

Same as SetYawPitchRoll, but sets rotation around X, Y and Z axis.

SetCameraMask()

proto native external int SetCameraMask ( int mask )

protected

Sets visibility mask for cameras, where Entity will be rendered.

SetEventMask()

proto native external EntityEvent SetEventMask ( EntityEvent e )

protected

Sets event mask.

Parameters

e	combined mask of one or more members of EntityEvent enum Man player = g_Game.GetPlayer(); Print( player.GetEventMask() ); player.SetEventMask( EntityEvent.VISIBLE ); Print( player.GetEventMask() ); >> 0 >> 128

SetFlags()

proto native external EntityFlags SetFlags ( EntityFlags flags, bool recursively )

protected

Sets Entity flags.

It's OR operation, not rewrite. Returns previous flags

Parameters

flags	int flags to be set
recursively	flags will be recursively applied to children of hierarchy too

Returns

int previous flags

Man player = g_Game.GetPlayer();
player.SetFlags(EntityFlags.VISIBLE|EntityFlags.SOLID );
Print( player.GetFlags() );
 
>> 1610612747

SetID()

proto native void SetID ( int id )

protected

Set unique entity ID.

Parameters

id	int unique entity ID to be set ItemBase apple = g_Game.CreateObject( "Fruit_Apple", String2Vector("0 10 0"), false ); apple.SetID(101); Print( apple.GetID() ); >> 101

SetName()

proto native void SetName ( string name )

protected

References name.

SetObject()

proto native external void SetObject ( vobject object, string options )

protected

\brief Sets the visual object to this entity. Reference is added and released upon entity destruction
\param object handle to object got by GetObject()
\param options String, dependant on object type.

Only supported one for XOB objects: $remap 'original material name' 'new material'; [$remap 'another original material name' 'anothernew material']

SetOrigin()

proto native external void SetOrigin ( vector orig )

protected

Sets origin for entity.

Parameters

orig	vector origin to be set Man player = g_Game.GetPlayer(); player.SetOrigin("2550 10 2900" ); Print( player.GetOrigin() ); >> <2550,10,2900>

SetScale()

proto native external void SetScale ( float scale )

protected

SetTransform()

proto native external void SetTransform ( vector mat[4] )

protected

Sets entity transformation.

Parameters

mat	vector[4] matrix to be set vector mat[4]; Math3D.MatrixIdentity( mat ) Man player = g_Game.GetPlayer(); player.SetTransform( mat ); vector outmat[4]; player.GetTransform(outmat ); Print( outmat ); >> <1,0,0>,<0,1,0>,<0,0,1>,<0,0,0>

SetYawPitchRoll()

proto native external void SetYawPitchRoll ( vector angles )

protected

Sets angles for entity (Yaw, Pitch, Roll).

Parameters

angles

vector angles to be set Man player = g_Game.GetPlayer(); player.SetYawPitchRoll("180 50 180" ); Print( player.GetYawPitchRoll() ); >> <-180,50,-180>

Update()

proto native external int Update ( )

protected

Updates entity state/position. Should be called when you want to manually commit position changes etc
before trace methods etc. Entity is updated automatically at the end and the beginning of simulation step,
when it has EntityFlags.TFL_ACTIVE flag set.
\returns mask with flags

EntityFlags.UPDATE - hierarchy has been updated EntityFlags.UPDATE_MDL - model hierarchy has been updated

VarIndex()

proto native int VarIndex ( string varName )

private

Referenced by CheckLocalisationPlugin::FindTexts().

VectorToLocal()

proto native external vector VectorToLocal ( vector vec )

protected

Transforms world space vector to local space.

Parameters

vec	vector world space vector to transform

Returns

vector local space vector

Man player = g_Game.GetPlayer();
Print( player.VectorToLocal("2 1 5") );
 
>> <-0.166849,1,5.38258>

VectorToParent()

proto native external vector VectorToParent ( vector vec )

protected

Transforms local vector to world space.

Parameters

vec	vector local space vector to transform

Returns

vector world space vector

Man player = g_Game.GetPlayer();
Print( player.VectorToParent("1 2 3") );
 
>> <2.89791,2,1.26575>

Variable Documentation

m_Category

string m_Category

folder structure eg. StaticEntities/Walls

Definition at line 846 of file enentity.c.

Referenced by EditorAttribute(), GestureMenuItem(), GetCategory(), GetItemCategory(), and RadialQuickbarItem().

m_Color

string m_Color

Definition at line 850 of file enentity.c.

Referenced by EditorAttribute(), and InitDefaults().

m_Color2

string m_Color2

Definition at line 851 of file enentity.c.

Referenced by EditorAttribute().

m_DefValue

string m_DefValue

private

Definition at line 827 of file enentity.c.

Referenced by Attribute().

m_Desc [1/3]

string m_Desc

private

Definition at line 830 of file enentity.c.

Referenced by Attribute().

m_Desc [2/3]

string m_Desc

Definition at line 809 of file enentity.c.

m_Desc [3/3]

string m_Desc

private

Definition at line 794 of file enentity.c.

Referenced by ParamEnum().

m_Description

string m_Description

class purpose description

Definition at line 847 of file enentity.c.

Referenced by EditorAttribute().

m_DynamicBox

bool m_DynamicBox

Definition at line 854 of file enentity.c.

Referenced by EditorAttribute().

m_Enums

ref ParamEnumArray m_Enums

private

Only ints and floats are currently supported. Array can be defined this way: { ParamEnum("Choice 1", "1"), ParamEnum("Choicen 2", "2") }.

Definition at line 831 of file enentity.c.

Referenced by Attribute().

m_Insertable

bool m_Insertable

Definition at line 853 of file enentity.c.

Referenced by EditorAttribute().

m_Key [1/2]

string m_Key

Definition at line 807 of file enentity.c.

Referenced by DisplayElementBadge::BadgeBleeding(), DisplayElementBadge::BadgeFracture(), DisplayElementBadge::BadgeHeartbeat(), DisplayElementBadge::BadgeLegs(), DisplayElementBadge::BadgePills(), DisplayElementBadge::BadgePoisoned(), DisplayElementBadge::BadgeSick(), DisplayElementBadge::BadgeStuffed(), DisplayElementBadge::BadgeWet(), DisplayElementTendency::TendencyBacteria(), DisplayElementTendency::TendencyBlood(), DisplayElementTendency::TendencyHealth(), DisplayElementTendency::TendencyHunger(), DisplayElementTendency::TendencyTemperature(), DisplayElementTendency::TendencyThirst(), and DisplayElementBase::UpdateHUD().

m_Key [2/2]

string m_Key

private

Definition at line 792 of file enentity.c.

Referenced by ParamEnum().

m_RangeScale

string m_RangeScale

private

defined as "MIN_VALUE MAX_VALUE STEP" eg. "1 100 0.5"

Definition at line 829 of file enentity.c.

Referenced by Attribute().

m_SizeMax

vector m_SizeMax

max vector of a bounding box

Definition at line 849 of file enentity.c.

Referenced by EditorAttribute().

m_SizeMin

vector m_SizeMin

min vector of a bounding box

Definition at line 848 of file enentity.c.

Referenced by EditorAttribute().

m_Style

class Attribute m_Style

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

Referenced by EditorAttribute().

m_UiWidget

string m_UiWidget

private

can be "editbox", "combobox", "spinbox", "slider", "font", "fileeditbox", "colorPicker", "flags", "resourceNamePicker"

Definition at line 828 of file enentity.c.

Referenced by Attribute().

m_Value [1/2]

string m_Value

Definition at line 808 of file enentity.c.

Referenced by Add(), Get(), GetValue(), OnStoreLoad(), OnStoreSave(), PlayerStat(), PresenceNotifierNoiseEvent(), PrintElements(), Set(), DisplayElementBase::SetSeriousnessLevel(), DisplayElementBase::SetTendency(), SyncedValueAgent(), SyncedValueLevel(), and DisplayElementBase::UpdateHUD().

m_Value [2/2]

string m_Value

private

Definition at line 793 of file enentity.c.

Referenced by ParamEnum().

m_Visible

bool m_Visible

Definition at line 852 of file enentity.c.

Referenced by EditorAttribute().