BaseGameTriggerEntity Interface Reference

Inheritance diagram for BaseGameTriggerEntity:

Public Member 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)
	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	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

Protected Attributes
ref ScriptInvoker	Event_OnQueryFinished = new ScriptInvoker()

Member Function Documentation

AddClassType()

proto external void BaseGameTriggerEntity.AddClassType

(

TypeName

classType

)

Add a class type to the filter.

AddFilterName()

proto external void BaseGameTriggerEntity.AddFilterName

(

string

name

)

Add a name to the filter.

AddPrefabFilter()

proto external void BaseGameTriggerEntity.AddPrefabFilter

(

PrefabFilter

prefabFilter

)

Add a prefab filter to the filters.

ClearTraceMask()

proto external void BaseGameTriggerEntity.ClearTraceMask

(

EQueryEntitiesFlags

flags

)

Clears trace mask.

DefaultEntityFilterForQuery()

proto external bool BaseGameTriggerEntity.DefaultEntityFilterForQuery

(

IEntity

ent

)

EnablePeriodicQueries()

proto external void BaseGameTriggerEntity.EnablePeriodicQueries

(

bool

enable

)

GetEntitiesInside()

proto external int BaseGameTriggerEntity.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 BaseGameTriggerEntity.GetOnQueryFinished

(

)

GetSphereRadius()

proto external float BaseGameTriggerEntity.GetSphereRadius

(

)

GetTraceMask()

proto external EQueryEntitiesFlags BaseGameTriggerEntity.GetTraceMask

(

)

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

GetUpdateRate()

proto external float BaseGameTriggerEntity.GetUpdateRate

(

)

IsPeriodicQueriesEnabled()

proto external bool BaseGameTriggerEntity.IsPeriodicQueriesEnabled

(

)

OnActivate()

void BaseGameTriggerEntity.OnActivate ( IEntity ent )

protected

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

Implemented in SCR_BaseTriggerEntity, SCR_CaptureArea, SCR_FiringRangeManager, SCR_FreeRoamBuildingClientTriggerEntity, SCR_PlayerHubAreaTriggerEntity, SCR_PlayersPresentTriggerEntity, SCR_ScenarioFrameworkTriggerEntity, and SCR_SpawnArea.

OnDeactivate()

void BaseGameTriggerEntity.OnDeactivate ( IEntity ent )

protected

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

Implemented in SCR_BaseTriggerEntity, SCR_CaptureArea, SCR_FiringRangeLineArea, SCR_FiringRangeManager, SCR_FreeRoamBuildingClientTriggerEntity, SCR_PlayerHubAreaTriggerEntity, SCR_PlayersPresentTriggerEntity, SCR_ScenarioFrameworkTriggerEntity, and SCR_SpawnArea.

OnQueryFinished()

void BaseGameTriggerEntity.OnQueryFinished ( bool bIsEmpty )

protected

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

Implemented in SCR_FactionControlTriggerEntity, SCR_FactionDominanceTriggerEntity, and SCR_ScenarioFrameworkTriggerEntity.

QueryEntitiesInside()

proto external void BaseGameTriggerEntity.QueryEntitiesInside

(

)

QueryEntityInside()

proto external bool BaseGameTriggerEntity.QueryEntityInside

(

notnull IEntity

ent

)

RemoveClassType()

proto external bool BaseGameTriggerEntity.RemoveClassType

(

TypeName

classType

)

Remove a class type from the filter.

RemoveFilterName()

proto external bool BaseGameTriggerEntity.RemoveFilterName

(

string

name

)

Remove a name from the filter.

RemovePrefabFilter()

proto external bool BaseGameTriggerEntity.RemovePrefabFilter

(

PrefabFilter

prefabFilter

)

Remove a prefab filter from the filters.

SetSphereRadius()

proto external void BaseGameTriggerEntity.SetSphereRadius

(

float

radius

)

SetTraceMask()

proto external void BaseGameTriggerEntity.SetTraceMask

(

EQueryEntitiesFlags

flags

)

Sets trace mask.

Bits are or'ed with existing mask.

SetUpdateRate()

proto external void BaseGameTriggerEntity.SetUpdateRate

(

float

updateRate

)

Member Data Documentation

Event_OnQueryFinished

ref ScriptInvoker BaseGameTriggerEntity.Event_OnQueryFinished = new ScriptInvoker()

protected

---

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

• Game/generated/Trigger/BaseGameTriggerEntity.c