SCR_EntityHelper Class Reference

Static Protected Member Functions
static bool	OnlyStaticCallback (notnull IEntity entity)
static IEntity	GetMainParent (IEntity entity, bool self=false)
static void	SetHierarchyTransform (notnull IEntity entity, vector newTransform[4])
static void	SetHierarchyChildTransform (notnull IEntity entity, vector oldTransform[4], vector newTransform[4], bool recursive=true)
static bool	GetRelativeLocalTransform (notnull IEntity owner, notnull IEntity member, out vector relativeTransform[4])
static RplComponent	GetEntityRplComponent (notnull IEntity entity)
static void	QuickSortEntitiesByDistanceToPoint (notnull inout array< IEntity > arr, vector pos, int low, int high)
static int	Partition (notnull inout array< IEntity > arr, vector pos, int low, int high)
static RplId	EntityToRplId (IEntity ent)
static IEntity	RplIdToEntity (RplId id)

Detailed Description

Definition at line 1 of file SCR_EntityHelper.c.

Member Function Documentation

EntityToRplId()

RplId SCR_EntityHelper::EntityToRplId ( IEntity ent )

inlinestaticprotected

Definition at line 507 of file SCR_EntityHelper.c.

GetEntityRplComponent()

RplComponent SCR_EntityHelper::GetEntityRplComponent ( notnull IEntity entity )

inlinestaticprotected

Atempts to find RplComponent in the fastest possible way

Parameters

[in]

entity

from which RplComponent should be retrived

Definition at line 451 of file SCR_EntityHelper.c.

GetMainParent()

IEntity SCR_EntityHelper::GetMainParent ( IEntity entity, bool self = false )

inlinestaticprotected

Returns the main parent of the input entity

Parameters

[in]	entity	Entity to get the main parent from
[in]	self	return entity if there is no parent, false otherwise

Returns

Definition at line 325 of file SCR_EntityHelper.c.

GetRelativeLocalTransform()

bool SCR_EntityHelper::GetRelativeLocalTransform ( notnull IEntity owner, notnull IEntity member, out vector relativeTransform[4] )

inlinestaticprotected

Get relative transform from member to owner local space.

Parameters

[in]	owner	Starting entity.
[in]	member	Ending entity.
[out]	relativeTransform	transformation from member to owner local space

Returns

whether the result is reliable

Definition at line 398 of file SCR_EntityHelper.c.

OnlyStaticCallback()

bool SCR_EntityHelper::OnlyStaticCallback ( notnull IEntity entity )

inlinestaticprotected

Parameters

[in]

entity

Returns

true if entity does not have physics or is not dynamic, false otherwise

Definition at line 311 of file SCR_EntityHelper.c.

Partition()

int SCR_EntityHelper::Partition ( notnull inout array< IEntity > arr, vector pos, int low, int high )

inlinestaticprotected

Method used for sorting part of the provided array of entities based on their distance to the specified position

Parameters

[in,out]	arr	array whose content will be sorted
[in]	pos	world space position to which distance will be measured
[in]	low	index from the array that will be used as a starting point for sorting
[in]	high	index from the array that will be used as the end point for sorting

Returns

Definition at line 488 of file SCR_EntityHelper.c.

QuickSortEntitiesByDistanceToPoint()

void SCR_EntityHelper::QuickSortEntitiesByDistanceToPoint ( notnull inout array< IEntity > arr, vector pos, int low, int high )

inlinestaticprotected

QuickSort algorithm for ordering an array of Entities by distance to the specified world position

Parameters

[in,out]	arr	array whose content will be sorted
[in]	pos	world space position to which distance will be measured
[in]	low	index from the array that will be used as a starting point for sorting
[in]	high	index from the array that will be used as the end point for sorting

Definition at line 470 of file SCR_EntityHelper.c.

RplIdToEntity()

IEntity SCR_EntityHelper::RplIdToEntity ( RplId id )

inlinestaticprotected

Definition at line 521 of file SCR_EntityHelper.c.

SetHierarchyChildTransform()

void SCR_EntityHelper::SetHierarchyChildTransform ( notnull IEntity entity, vector oldTransform[4], vector newTransform[4], bool recursive = true )

inlinestaticprotected

Set child transformation

Parameters

[in]	entity
[in]	oldTransform
[in]	newTransform
[in]	recursive

Definition at line 366 of file SCR_EntityHelper.c.

SetHierarchyTransform()

void SCR_EntityHelper::SetHierarchyTransform ( notnull IEntity entity, vector newTransform[4] )

inlinestaticprotected

Set transform for the whole hierarchy

Parameters

[in]	entity
[in]	newTransform

Definition at line 345 of file SCR_EntityHelper.c.

---

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

• scripts/Game/Helpers/SCR_EntityHelper.c