EntityUtils Interface Reference

Static Public Member Functions
static proto bool	IsPlayer (IEntity pEntity)
	Returns true if.
static proto bool	IsPlayerVehicle (IEntity pEntity)
	Returns true if.
static proto IEntity	GetPlayer ()
	Returns the local player entity if any.
static proto bool	CanTreatAsProxy (IEntity pEntity, IEntity pParent)
	Returns true if.
static proto bool	GetAncestorToChildTransform (IEntity child, IEntity ancestor, out vector result[4])
	Returns a matrix that transforms a point in ancestor-space to child-space.
static proto bool	GetChildToAncestorTransform (IEntity child, IEntity ancestor, out vector result[4])
	Returns a matrix that transforms a point in child-space to ancestor-space.

Member Function Documentation

CanTreatAsProxy()

static proto bool EntityUtils.CanTreatAsProxy ( IEntity pEntity, IEntity pParent )

static

Returns true if.

Parameters

pEntity

can be treated as PROXY. Currently true for all non-STATIC and non-particle effect entities

GetAncestorToChildTransform()

static proto bool EntityUtils.GetAncestorToChildTransform ( IEntity child, IEntity ancestor, out vector result[4] )

static

Returns a matrix that transforms a point in ancestor-space to child-space.

Parameters

	child	The Entity whose space is the target of the transformation. Can't be null.
	ancestor	The Entity whose space is the source of the transformation. Can't be null.
[out]	outResult	The output matrix transformation.

Returns

true, if ancestor-descendant relationship was valid. Else false, in which case outResult is undefined.

GetChildToAncestorTransform()

static proto bool EntityUtils.GetChildToAncestorTransform ( IEntity child, IEntity ancestor, out vector result[4] )

static

Returns a matrix that transforms a point in child-space to ancestor-space.

Parameters

	child	The Entity whose space is the source of the transformation. Can't be null.
	ancestor	The Entity whose space is the target of the transformation. Can't be null.
[out]	outResult	The output matrix transformation.

Returns

true, if ancestor-descendant relationship was valid. Else false, in which case outResult is undefined.

GetPlayer()

static proto IEntity EntityUtils.GetPlayer ( )

static

Returns the local player entity if any.

IsPlayer()

static proto bool EntityUtils.IsPlayer ( IEntity pEntity )

static

Returns true if.

Parameters

pEntity

is a player

IsPlayerVehicle()

static proto bool EntityUtils.IsPlayerVehicle ( IEntity pEntity )

static

Returns true if.

Parameters

pEntity

is a vehicle the local player is controlling

---

The documentation for this interface was generated from the following file:

• Game/generated/Entities/EntityUtils.c