Trigger

Data Structures
class	BaseGameTriggerEntityClass
class	PrefabFilter
class	PreloadEntry
class	ScriptedGameTriggerEntityClass

Functions
ScriptInvoker	GetOnQueryFinished ()
proto external bool	QueryEntityInside (notnull IEntity ent)
proto external void	QueryEntitiesInside ()
proto external bool	DefaultEntityFilterForQuery (IEntity ent)
proto external int	GetEntitiesInside (out notnull array< IEntity > outEntities)
proto external void	SetSphereRadius (float radius)
proto external float	GetSphereRadius ()
proto external void	SetUpdateRate (float updateRate)
proto external float	GetUpdateRate ()
proto external void	EnablePeriodicQueries (bool enable)
proto external bool	IsPeriodicQueriesEnabled ()
proto external void	AddFilterName (string name)
	Add a name to the filter. More...
proto external bool	RemoveFilterName (string name)
	Remove a name from the filter. More...
proto external void	AddClassType (typename classType)
	Add a class type to the filter. More...
proto external bool	RemoveClassType (typename classType)
	Remove a class type from the filter. More...
proto external void	AddPrefabFilter (PrefabFilter prefabFilter)
	Add a prefab filter to the filters. More...
proto external bool	RemovePrefabFilter (PrefabFilter prefabFilter)
	Remove a prefab filter from the filters. More...
proto external EQueryEntitiesFlags	GetTraceMask ()
	Get flag(s) from the traces done by the the trigger. More...
proto external void	SetTraceMask (EQueryEntitiesFlags flags)
proto external void	ClearTraceMask (EQueryEntitiesFlags flags)
	Clears trace mask. More...
event protected void	OnActivate (IEntity ent)
	callback - activation - occurs when and entity which fulfills the filter definitions enters the Trigger More...
event protected void	OnDeactivate (IEntity ent)
	callback - deactivation - occurs when and entity which was activated (OnActivate) leaves the Trigger More...
event protected void	OnQueryFinished (bool bIsEmpty)
	callback - query finished - occurs when the current query finished being processd and has updated results More...
ScriptedGameTriggerEntityClass BaseGameTriggerEntityClass	OnInit (IEntity owner)
event protected event void	OnFrame (IEntity owner, float timeSlice)
event bool	ScriptedEntityFilterForQuery (IEntity ent)
	Override this method in inherited class to define a new filter. This base filter will not be used unless overridden! More...

Variables
BaseGameTriggerEntityClass	Event_OnQueryFinished = new ScriptInvoker()

Detailed Description

Function Documentation

AddClassType()

proto external void AddClassType

(

typename classType

)

Add a class type to the filter.

AddFilterName()

proto external void AddFilterName

(

string

name

)

Add a name to the filter.

AddPrefabFilter()

proto external void AddPrefabFilter

(

PrefabFilter

prefabFilter

)

Add a prefab filter to the filters.

ClearTraceMask()

proto external void ClearTraceMask

(

EQueryEntitiesFlags

flags

)

Clears trace mask.

DefaultEntityFilterForQuery()

proto external bool DefaultEntityFilterForQuery

(

IEntity

ent

)

EnablePeriodicQueries()

proto external void EnablePeriodicQueries

(

bool

enable

)

GetEntitiesInside()

proto external int GetEntitiesInside

(

out notnull array< IEntity >

outEntities

)

Get the entities inside the triggers. IMPORTANT* This doesn't force the searching of entities. If you want to search entities, use the QueryEntitiesInside function.

GetOnQueryFinished()

ScriptInvoker GetOnQueryFinished

(

)

Definition at line 20 of file BaseGameTriggerEntity.c.

GetSphereRadius()

proto external float GetSphereRadius

(

)

GetTraceMask()

proto external EQueryEntitiesFlags GetTraceMask

(

)

Get flag(s) from the traces done by the the trigger.

GetUpdateRate()

proto external float GetUpdateRate

(

)

IsPeriodicQueriesEnabled()

proto external bool IsPeriodicQueriesEnabled

(

)

OnActivate()

event protected void OnActivate

(

IEntity

entity

)

callback - activation - occurs when and entity which fulfills the filter definitions enters the Trigger

Parameters

[in]

entity

Definition at line 35 of file SCR_BaseTriggerEntity.c.

OnDeactivate()

event protected void OnDeactivate

(

IEntity

ent

)

callback - deactivation - occurs when and entity which was activated (OnActivate) leaves the Trigger

Definition at line 41 of file SCR_BaseTriggerEntity.c.

OnFrame()

event protected event void OnFrame	(	IEntity	owner,
		float	timeSlice
	)

OnInit()

ScriptedGameTriggerEntityClass BaseGameTriggerEntityClass OnInit

(

IEntity

owner

)

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

Definition at line 523 of file SCR_CharacterCommandHandler_Tests.c.

OnQueryFinished()

event protected void OnQueryFinished

(

bool

bIsEmpty

)

callback - query finished - occurs when the current query finished being processd and has updated results

Definition at line 77 of file BaseGameTriggerEntity.c.

QueryEntitiesInside()

proto external void QueryEntitiesInside

(

)

QueryEntityInside()

proto external bool QueryEntityInside

(

notnull IEntity

ent

)

RemoveClassType()

proto external bool RemoveClassType

(

typename classType

)

Remove a class type from the filter.

RemoveFilterName()

proto external bool RemoveFilterName

(

string

name

)

Remove a name from the filter.

RemovePrefabFilter()

proto external bool RemovePrefabFilter

(

PrefabFilter

prefabFilter

)

Remove a prefab filter from the filters.

ScriptedEntityFilterForQuery()

event bool ScriptedEntityFilterForQuery

(

IEntity

ent

)

Override this method in inherited class to define a new filter. This base filter will not be used unless overridden!

Definition at line 21 of file ScriptedGameTriggerEntity.c.

SetSphereRadius()

proto external void SetSphereRadius

(

float

radius

)

SetTraceMask()

proto external void SetTraceMask

(

EQueryEntitiesFlags

flags

)

Sets trace mask. Bits are or'ed with existing mask.

SetUpdateRate()

proto external void SetUpdateRate

(

float

updateRate

)

Variable Documentation

Event_OnQueryFinished

BaseGameTriggerEntityClass Event_OnQueryFinished = new ScriptInvoker()