SCR_PlayersPresentTriggerEntity Interface Reference

Inheritance diagram for SCR_PlayersPresentTriggerEntity:

Public Member Functions
void	SetOwnerFaction (Faction faction)
bool	IsMaster ()
override bool	ScriptedEntityFilterForQuery (IEntity ent)
	Override this method in inherited class to define a new filter.
Public Member Functions inherited from SCR_BaseTriggerEntity
ScriptInvoker	GetOnActivate ()
ScriptInvoker	GetOnDeactivate ()
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
int	GetPlayersCountByFaction ()
void	GetPlayersByFaction (notnull out array< IEntity > aOut)
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
override void	EOnInit (IEntity owner)
Protected Member Functions inherited from SCR_BaseTriggerEntity
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
FactionKey	m_sOwnerFactionKey
SCR_EScenarioFrameworkTriggerActivation	m_eActivationPresence
Faction	m_OwnerFaction
int	m_iEntitiesInside = 0
Protected Attributes inherited from SCR_BaseTriggerEntity
ref ScriptInvoker	m_OnActivate = new ScriptInvoker()
ref ScriptInvoker	m_OnDeactivate = new ScriptInvoker()
Protected Attributes inherited from BaseGameTriggerEntity
ref ScriptInvoker	Event_OnQueryFinished = new ScriptInvoker()

Member Function Documentation

EOnInit()

override void SCR_PlayersPresentTriggerEntity.EOnInit ( IEntity  owner )

protected

GetPlayersByFaction()

void SCR_PlayersPresentTriggerEntity.GetPlayersByFaction ( notnull out array< IEntity >  aOut )

protected

GetPlayersCountByFaction()

int SCR_PlayersPresentTriggerEntity.GetPlayersCountByFaction ( )

protected

IsMaster()

bool SCR_PlayersPresentTriggerEntity.IsMaster

(

)

OnActivate()

override void SCR_PlayersPresentTriggerEntity.OnActivate ( IEntity  ent )

protected

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

Implements SCR_BaseTriggerEntity.

OnDeactivate()

override void SCR_PlayersPresentTriggerEntity.OnDeactivate ( IEntity  ent )

protected

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

Implements SCR_BaseTriggerEntity.

ScriptedEntityFilterForQuery()

override bool SCR_PlayersPresentTriggerEntity.ScriptedEntityFilterForQuery

(

IEntity

ent

)

Override this method in inherited class to define a new filter.

Implements ScriptedGameTriggerEntity.

SetOwnerFaction()

void SCR_PlayersPresentTriggerEntity.SetOwnerFaction

(

Faction

faction

)

Member Data Documentation

m_eActivationPresence

SCR_EScenarioFrameworkTriggerActivation SCR_PlayersPresentTriggerEntity.m_eActivationPresence

protected

m_iEntitiesInside

int SCR_PlayersPresentTriggerEntity.m_iEntitiesInside = 0

protected

m_OwnerFaction

Faction SCR_PlayersPresentTriggerEntity.m_OwnerFaction

protected

m_sOwnerFactionKey

FactionKey SCR_PlayersPresentTriggerEntity.m_sOwnerFactionKey

protected

---

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

• Game/ScenarioFramework/Entities/Triggers/SCR_PlayersPresentTriggerEntity.c