ScriptedGameTriggerEntity Interface Reference

Inheritance diagram for ScriptedGameTriggerEntity:

Public Member Functions
bool	ScriptedEntityFilterForQuery (IEntity ent)
	Override this method in inherited class to define a new filter. This base filter will not be used unless overridden!
Public Member Functions inherited from BaseGameTriggerEntity
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)
	Get the entities inside the triggers.
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.
proto external bool	RemoveFilterName (string name)
	Remove a name from the filter.
proto external void	AddClassType (TypeName classType)
	Add a class type to the filter.
proto external bool	RemoveClassType (TypeName classType)
	Remove a class type from the filter.
proto external void	AddPrefabFilter (PrefabFilter prefabFilter)
	Add a prefab filter to the filters.
proto external bool	RemovePrefabFilter (PrefabFilter prefabFilter)
	Remove a prefab filter from the filters.
proto external EQueryEntitiesFlags	GetTraceMask ()
	Get flag(s) from the traces done by the the trigger.
proto external void	SetTraceMask (EQueryEntitiesFlags flags)
	Sets trace mask.
proto external void	ClearTraceMask (EQueryEntitiesFlags flags)
	Clears trace mask.

Protected Member Functions
void	OnInit (IEntity owner)
void	OnFrame (IEntity owner, float timeSlice)
Protected Member Functions inherited from BaseGameTriggerEntity
void	OnActivate (IEntity ent)
	callback - activation - occurs when and entity which fulfills the filter definitions enters the Trigger
void	OnDeactivate (IEntity ent)
	callback - deactivation - occurs when and entity which was activated (OnActivate) leaves the Trigger
void	OnQueryFinished (bool bIsEmpty)
	callback - query finished - occurs when the current query finished being processd and has updated results

Additional Inherited Members
Protected Attributes inherited from BaseGameTriggerEntity
ref ScriptInvoker	Event_OnQueryFinished = new ScriptInvoker()

Member Function Documentation

OnFrame()

void ScriptedGameTriggerEntity.OnFrame ( IEntity  owner, float  timeSlice  )

protected

Implemented in SCR_CaptureArea, SCR_SpawnArea, SCR_CaptureAndHoldArea, and SCR_CaptureAndHoldSpawnArea.

OnInit()

void ScriptedGameTriggerEntity.OnInit ( IEntity  owner )

protected

Implemented in SCR_CaptureArea, SCR_SpawnArea, SCR_CaptureAndHoldArea, and SCR_CaptureAndHoldSpawnArea.

ScriptedEntityFilterForQuery()

bool ScriptedGameTriggerEntity.ScriptedEntityFilterForQuery

(

IEntity

ent

)

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

Implemented in SCR_BaseFactionTriggerEntity, SCR_FactionControlTriggerEntity, SCR_FactionPlayerTriggerEntity, SCR_CaptureArea, SCR_SpawnArea, SCR_PlayersPresentTriggerEntity, and SCR_ScenarioFrameworkTriggerEntity.

---

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

• Game/generated/Trigger/ScriptedGameTriggerEntity.c