Entity utility functions

Commonly used Entity utility functions.

Functions

• #DumpEntities
• #CompareEntitiesByName
• #CompareEntitiesByDistanceFromPoint
• #BroadcastEvent
• #MakeDerivedEntity
• #MakeDerivedEntityOverride
• #MakeUsable
• #MakePickable
• #MakeSpawnable
• #EntityCommon.PhysicalizeRigid

DumpEntities()

Dumps all entity identifiers (EntityId), names, classes, positions and angles, which are currently used in the map, to console.
e.g:

[userdata: 00000002]..name=Grunt1 clsid=Grunt pos=1016.755,1042.764,100.000 ang=0.000,0.000,1.500
[userdata: 00000003]..name=Grunt2 clsid=Grunt pos=1020.755,1072.784,100.000 ang=0.000,0.000,0.500
...

CompareEntitiesByName(ent1, ent2)

Compares two entities by name, which is commonly used while sorting tables.

Example:

local entities = System.GetEntitiesByClass("SomeEntityClass");
table.sort(entities, CompareEntitiesByName);

CompareEntitiesByDistanceFromPoint(ent1, ent2, point)

Compares two entities by their squared distance. If the distance to the point from entity one is greater than the distance to the point from entity two it returns true, otherwise it returns false.

Example:

local ent1 = System.GetEntityByName("NameEntityOne");
local ent2 = System.GetEntityByName("NameEntityTwo");

if(CompareEntitiesByDistanceFromPoint( ent1, ent2, g_localActor:GetPos()))then
   Log("Entity One is further away from the Player than Entity two...");
end

BroadcastEvent( sender, event )

Processes an entity event broadcast.

Example:

BroadcastEvent(self, "Used");

MakeDerivedEntity( _DerivedClass, _Parent )

Creates a new table that is a derived version of a parent entity table. Commonly used to simplify the creation of a new entity script based on another entity.

MakeDerivedEntityOverride( _DerivedClass, _Parent )

Creates a new table that is derived class of parent entity. The Child's Properties will override the ones from the parent.

MakeUsable( entity )

Adds usable functionality, like OnUsed event, to a given entity table.

Example:

MyEntity = { ... whatever you usually put here ... }

MakeUsable(MyEntity)

function MyEntity:OnSpawn() ...

function MyEntity:OnReset()
  self:ResetOnUsed()
  ...
end

MakePickable( entity )

Adds a bPickable property to the entity properties table to add a basic pickable functionality to a given entity.

MakeSpawnable( entity )

Adds spawn functionality to a given entity. Commonly used for AI actors during the creation.

EntityCommon.PhysicalizeRigid( entity, nSlot, Properties, bActive )

Physicalizes an entity based on the given entity slot and physics properties.