DIFF

class IEntitySource

IEntity › Managed

Derived classes
GenericEntityObject
View all 2,060 descendants

Part of Entity editor attribute system

All members, including inherited

Internal ancestor of all Entity implementations.

Constructors 1

protected void IEntity(IEntitySource src, IEntity parent)COMPONENT_SYSTEM

Constructor

Methods 81

event protected void EOnTouch(IEntity other, int extra)

\name Event methods Event method stubs. Reimplement these in inherited entities to receive event calls

event protected void EOnInit(IEntity other, int extra)

EntityEvent.TOUCH

event protected void EOnExtra(IEntity other, int extra)

EntityEvent.INIT

event protected void EOnNotVisible(IEntity other, int extra)

EntityEvent.EXTRA

event protected void EOnFrame(IEntity other, float timeSlice)

EntityEvent.NOTVISIBLE

event protected int EOnVisible(IEntity other, int extra)

EntityEvent.FRAME

event protected void EOnPostFrame(IEntity other, int extra)

EntityEvent.VISIBLE

event protected void EOnWorldProcess(IEntity other, int extra)

EntityEvent.POSTFRAME

event protected void EOnAnimEvent(IEntity other, AnimEvent extra)

EntityEvent.WORLDPROCESS

event protected void EOnSoundEvent(IEntity other, SoundEvent extra)

EntityEvent.ANIMEVENT

event protected void EOnSimulate(IEntity other, float dt)

EntityEvent.SOUNDEVENT

event protected void EOnPostSimulate(IEntity other, float timeSlice)

EntityEvent.SIMULATE

Referenced by Fireplace.EOnPostSimulate()
event protected void EOnJointBreak(IEntity other, int extra)

EntityEvent.POSTSIMULATE

event protected void EOnPhysicsMove(IEntity other, int extra)

EntityEvent.JOINTBREAK

event protected void EOnContact(IEntity other, Contact extra)

EntityEvent.PHYSICSMOVE

protected void EOnUser0(IEntity other, int extra)

EntityEvent.CONTACT

protected void EOnUser1(IEntity other, int extra)

EntityEvent.EV_USER+0

event protected void EOnEnter(IEntity other, int extra)

EntityEvent.EV_USER+1

event protected void EOnLeave(IEntity other, int extra)

EntityEvent.ENTER

protected void EOnUser4(IEntity other, int extra)

EntityEvent.LEAVE

protected void EOnDummy020(IEntity other, int extra)

EntityEvent.EV_USER+4

protected void EOnDummy021(IEntity other, int extra)

Placeholder

protected void EOnDummy022(IEntity other, int extra)

Placeholder

protected void EOnDummy023(IEntity other, int extra)

Placeholder

protected void EOnDummy024(IEntity other, int extra)

Placeholder

protected void EOnDummy025(IEntity other, int extra)

Placeholder

protected void EOnDummy026(IEntity other, int extra)

Placeholder

protected void EOnDummy027(IEntity other, int extra)

Placeholder

protected void EOnDummy028(IEntity other, int extra)

Placeholder

protected void EOnDummy029(IEntity other, int extra)

Placeholder

protected void EOnDummy030(IEntity other, int extra)

Placeholder

protected void EOnDummy031(IEntity other, int extra)

Placeholder

proto external void GetRenderTransform(out vector mat[])

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>
proto external void GetLocalTransform(out vector mat[])

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>
proto native external vector GetTransformAxis(int axis)

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>
proto native external void SetTransform(vector mat[4])

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>
Referenced by ArrowManagerBase.DropArrow(), CameraToolsMenu.Stop(), DayZCreature.AddArrow()
Show 7 more, MiscGameplayFunctions.RemoveAllAttachedChildrenByTypename(), Object.AddArrow(), Object.Gizmo_SetWorldTransform(), PlayerBase.AddArrow(), PlayerBase.ContaminatedParticleAdjustment(), ScriptCamera.FreeFly(), and ZombieBase.AddArrow()
proto native external vector GetOrigin()

Returns origin of Entity

Returns: vector entity origin

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

>> <2577.02,15.6837,2924.27>
Referenced by DayZPlayerCamera3rdPersonJump.DayZPlayerCamera3rdPersonJump(), DayZPlayerCamera3rdPersonJump.OnUpdate(), DayZPlayerCamera3rdPersonVehicle.OnUpdate()
Show 5 more, FlareSimulation.FlareParticleUpdate(), FlareSimulation.OnActivation(), ScriptCamera.DebugInfo(), ScriptCamera.FreeFly(), and ScriptCamera.ScriptCamera()
proto external vector GetLocalPosition()

Returns local position of Entity

Returns: vector entity local position

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

>> <2577.02,15.6837,2924.27>
Referenced by ArrowManagerPlayer.Save(), and ParticleSource.SetWiggle()
proto native external vector GetYawPitchRoll()

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>
Referenced by MapMenu.Update(), ParticleSource.SetWiggle(), ScriptCamera.DebugInfo()
Show 2 more, ScriptCamera.FreeFly(), and ScriptCamera.ScriptCamera()
proto native external vector GetAngles()

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

Referenced by PluginDoorRuler.OnUpdate()
proto native external vector GetLocalYawPitchRoll()

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>
Referenced by ArrowManagerPlayer.Save(), and ParticleSource.SetWiggle()
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)

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

>> <-180,50,-180>
Referenced by ArrowManagerPlayer.Load(), CameraToolsMenu.SetCameraData(), and FireworksLauncherClientEvent.OnFired()
proto native external void SetAngles(vector angles)

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

Referenced by PluginDoorRuler.OnUpdate()
proto native external void SetOrigin(vector orig)

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>
proto native external vector VectorToParent(vector vec)

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>
Referenced by BoatScript.EOnSimulate(), and BoatScript.OnEngineStop()
proto native external vector CoordToParent(vector coord)

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>
Referenced by ActionDigGardenPlot.CheckSurfaceBelowGardenPlot(), BoatScript.HandleBoatSplashSound(), EffectBoatWaterBase.UpdatePosToSeaLevel()
Show 6 more, EffectBoatWaterFront.Update(), EffectBoatWaterSide.Update(), Hologram.DrawBaseSpheres(), Hologram.IsBaseViable(), Hologram.IsInTerrain(), and Hologram.IsUnderwater()
proto native external vector VectorToLocal(vector vec)

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>
Referenced by Weapon_Base.LiftWeaponCheckEx()
proto native external vector CoordToLocal(vector coord)

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>
Referenced by EffectBoatWaterBase.UpdatePosToSeaLevel()
proto native void SetID(int id)

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
proto native void SetName(string name)
proto native external bool AddChild(notnull IEntity child, int pivot, bool positionOnly = false)

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.

NoteMake sure the parent is not ToDelete
Referenced by ArrowManagerPlayer.Load(), BleedingSource.CreateParticle(), DayZCreature.AddArrow()
Show 14 more, Headtorch_ColorBase.AttachLightOnHead(), Object.AddArrow(), Particle.AddAsChild(), Particle.CreateParticleEffect(), PlayerBase.AddArrow(), PlayerBase.OnParticleEvent(), PlayerBase.SetDecayEffects(), PlayerBase.SpawnBreathVaporEffect(), PlayerBase.SpawnDrowningBubbles(), ScriptedLightBase.AttachOnObject(), ScriptedLightBase.HandleDancingShadows(), SpookyArea23.OnPlayerEnterServer(), UndergroundTriggerCarrier.SpawnTrigger(), and ZombieBase.AddArrow()
proto native external bool RemoveChild(notnull IEntity child, bool keepTransform = false)

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.

NoteMake sure the child is not ToDelete
Referenced by ArrowManagerBase.AcquireFirstArrow(), ArrowManagerBase.DropArrow(), CarWheel.EEHealthLevelChanged()
Show 7 more, MiscGameplayFunctions.DeleteAttachedChildrenByTypename(), MiscGameplayFunctions.RemoveAllAttachedChildrenByTypename(), Particle.AddAsChild(), Particle.StopParticle(), ScriptedLightBase.AttachOnObject(), ScriptedLightBase.DetachFromParent(), and ScriptedLightBase.HandleDancingShadows()
proto native external Physics GetPhysics()
Referenced by DayZCreature.OnAction(), ItemBase.OnAction(), PlayerBase.OnAction()
Show 1 more, Transport.OnAction()
proto native bool IsHierarchyPositionOnly()

Returns if the hierarchy component was created with positionOnly

Referenced by EffectParticle.IsParticleCurrentRotationRelativeToWorld(), EffectParticle.IsParticleRotationRelativeToWorld(), and ParticleSource.SetWiggle()
proto native int GetHierarchyPivot()

Returns the hierarchy component pivot

Referenced by ArrowManagerPlayer.Save()
proto external void GetBounds(out vector mins, out vector maxs)

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>
Referenced by ScriptModel.ScriptModel()
proto external void GetWorldBounds(out vector mins, out vector maxs)

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>
Referenced by EasterEgg.ResizeParticle(), and InventoryItem.GetImpactSurfaceTypeEx()
proto native external EntityFlags GetFlags()

Returns Entity flags

Returns: EntityFlags entity flags

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

>> 1610612745
proto native external bool IsFlagSet(EntityFlags flags)

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
Referenced by EntityAI.OnWasDetached(), and HeadtorchLight.PerformVisibilityCheck()
proto native external EntityFlags SetFlags(EntityFlags flags, bool recursively)

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
Referenced by DayZCreatureAI.DayZCreatureAI(), DynamicArea_Flare.DynamicArea_Flare(), EasterEgg.EasterEgg()
Show 7 more, Man.Man(), Particle.ParticleInit(), RenderTarget.RenderTarget(), ScriptCamera.ScriptCamera(), ScriptModel.ScriptModel(), Trigger.Trigger(), and WorldsMenu.WorldsMenu()
proto native external EntityFlags ClearFlags(EntityFlags flags, bool recursively)

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
Referenced by Ammo_40mm_ChemGas.OnDamageDestroyed(), Ammo_40mm_Explosive.OnDamageDestroyed(), and Grenade_ChemGas.OnDamageDestroyed()
proto native external EntityEvent GetEventMask()

Returns current event mask

Returns: int current event mask

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

>> 0
Referenced by TrapTrigger.TrapTrigger()
proto native external EntityEvent ClearEventMask(EntityEvent e)

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
Referenced by AreaDamageTrigger.AreaDamageTrigger(), Land_Underground_EntranceBase.OnDoorStateChangedClient(), and ScriptedLightBase.Destroy()
proto external volatile void SendEvent(notnull IEntity actor, EntityEvent e, void extra)

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

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

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']
Referenced by Particle.CreateParticleEffect(), and ScriptModel.ScriptModel()
proto native vobject GetVObject()

Returns visual object set to this Entity. No reference is added

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()

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

Referenced by EffectArea.CreateTrigger(), ParticleSource.SetWiggle(), ScriptedLightBase.AttachOnObject()
Show 1 more, ScriptedLightBase.HandleDancingShadows()