SCR_BaseTriggerEntity Interface Reference

Basic scripted trigger which offers external invoekrs for major events like activation or deactivation. More...

Inheritance diagram for SCR_BaseTriggerEntity:

Public Member Functions
ScriptInvoker	GetOnActivate ()
ScriptInvoker	GetOnDeactivate ()
Public Member Functions inherited from ScriptedGameTriggerEntity
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
bool	IsAlive (IEntity entity)
override void	OnActivate (IEntity ent)
	callback - activation - occurs when and entity which fulfills the filter definitions enters the Trigger
override void	OnDeactivate (IEntity ent)
	callback - deactivation - occurs when and entity which was activated (OnActivate) leaves the Trigger
Protected Member Functions inherited from ScriptedGameTriggerEntity
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

Protected Attributes
ref ScriptInvoker	m_OnActivate = new ScriptInvoker()
ref ScriptInvoker	m_OnDeactivate = new ScriptInvoker()
Protected Attributes inherited from BaseGameTriggerEntity
ref ScriptInvoker	Event_OnQueryFinished = new ScriptInvoker()

Detailed Description

Basic scripted trigger which offers external invoekrs for major events like activation or deactivation.

Member Function Documentation

GetOnActivate()

ScriptInvoker SCR_BaseTriggerEntity.GetOnActivate

(

)

Returns

Invoker called on server when the trigger is activated

GetOnDeactivate()

ScriptInvoker SCR_BaseTriggerEntity.GetOnDeactivate

(

)

Returns

Invoker called on server when the trigger is deactivated

IsAlive()

bool SCR_BaseTriggerEntity.IsAlive ( IEntity  entity )

protected

OnActivate()

override void SCR_BaseTriggerEntity.OnActivate ( IEntity  ent )

protected

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

Implements BaseGameTriggerEntity.

Implemented in SCR_PlayersPresentTriggerEntity, and SCR_ScenarioFrameworkTriggerEntity.

OnDeactivate()

override void SCR_BaseTriggerEntity.OnDeactivate ( IEntity  ent )

protected

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

Implements BaseGameTriggerEntity.

Implemented in SCR_PlayersPresentTriggerEntity, and SCR_ScenarioFrameworkTriggerEntity.

Member Data Documentation

m_OnActivate

ref ScriptInvoker SCR_BaseTriggerEntity.m_OnActivate = new ScriptInvoker()

protected

m_OnDeactivate

ref ScriptInvoker SCR_BaseTriggerEntity.m_OnDeactivate = new ScriptInvoker()

protected

---

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

• Game/Entities/Triggers/SCR_BaseTriggerEntity.c