Entity editor attribute system

Adds child entity to this entity.

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.

Clears event mask

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

Clear Entity flags. Returns cleared flags

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

Transforms world space position to local space

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>

Transforms local position to world space

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>

Returns local bounding box of model on Entity

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>

Returns current event mask

Returns: int current event mask

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

>> 0

Returns Entity flags

Returns: EntityFlags entity flags

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

>> 1610612745

Return unique entity ID

Returns: int unique entity ID

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

>> 0

Returns local position of Entity

Returns: vector entity local position

Man player = g_Game.GetPlayer();
Print( player.GetOrigin() );

>> <2577.02,15.6837,2924.27>

Returns local transformation of Entity. It returns only so much vectors as array is big

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>

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>

Returns origin of Entity

Returns: vector entity origin

Man player = g_Game.GetPlayer();
Print( player.GetOrigin() );

>> <2577.02,15.6837,2924.27>

Returns render transformation of Entity. Must pass in vector array size of 4

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>

Returns transformation of Entity. It returns only so much vectors as array is big

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>

Returns one row of Entity transformation matrix

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>

Returns quantized world-bound-box of Entity

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>

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>

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

Removes child entity from hierarchy.

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.

Sets event mask

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

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

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

Set unique entity ID

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

Sets the visual object to this entity. Reference is added and released upon entity destruction

object

handle to object got by GetObject()

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']

Sets origin for entity

orig

vector origin to be set

Man player = g_Game.GetPlayer();
player.SetOrigin("2550 10 2900" );
Print( player.GetOrigin() );

>> <2550,10,2900>

Sets entity transformation

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>

Sets angles for entity (Yaw, Pitch, Roll)

angles

vector angles to be set

Man player = g_Game.GetPlayer();
player.SetYawPitchRoll("180 50 180" );
Print( player.GetYawPitchRoll() );

>> <-180,50,-180>

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

Transforms world space vector to local space

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>

Transforms local vector to world space

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>