SCR_FactionControlTriggerEntity Interface Reference

Inheritance diagram for SCR_FactionControlTriggerEntity:

Public Member Functions
void	GetSideCounts (out int outFriendlyCount, out int outEnemyCount)
	Get number of entities inside trigger for each side.
override 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 SCR_BaseFactionTriggerEntity
void	SetOwnerFaction (Faction faction)
	Set owner faction.
override bool	ScriptedEntityFilterForQuery (IEntity ent)
	Override this method in inherited class to define a new filter. This base filter will not be used unless overridden!
void	SCR_BaseFactionTriggerEntity (IEntitySource src, IEntity parent)
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
override void	OnQueryFinished (bool bIsEmpty)
	callback - query finished - occurs when the current query finished being processd and has updated results
Protected Member Functions inherited from SCR_BaseFactionTriggerEntity
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)
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
int	m_iRatioMethod
float	m_fFriendlyRatioLimit
int	m_iFriendlyCount
int	m_iEnemyCount
bool	m_bResult
bool	m_bEvaluateResult
Protected Attributes inherited from SCR_BaseFactionTriggerEntity
FactionKey	m_sOwnerFactionKey
Faction	m_OwnerFaction
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

GetSideCounts()

void SCR_FactionControlTriggerEntity.GetSideCounts	(	out int	outFriendlyCount,
		out int	outEnemyCount
	)

Get number of entities inside trigger for each side.

Parameters

[out]	outFriendlyCount	Number of friendlies
[out]	outEnemyCount	Number of enemies

OnQueryFinished()

override void SCR_FactionControlTriggerEntity.OnQueryFinished ( bool  bIsEmpty )

protected

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

Implements BaseGameTriggerEntity.

Implemented in SCR_FactionDominanceTriggerEntity.

ScriptedEntityFilterForQuery()

override bool SCR_FactionControlTriggerEntity.ScriptedEntityFilterForQuery

(

IEntity

ent

)

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

Implements SCR_BaseFactionTriggerEntity.

Member Data Documentation

m_bEvaluateResult

bool SCR_FactionControlTriggerEntity.m_bEvaluateResult

protected

m_bResult

bool SCR_FactionControlTriggerEntity.m_bResult

protected

m_fFriendlyRatioLimit

float SCR_FactionControlTriggerEntity.m_fFriendlyRatioLimit

protected

m_iEnemyCount

int SCR_FactionControlTriggerEntity.m_iEnemyCount

protected

m_iFriendlyCount

int SCR_FactionControlTriggerEntity.m_iFriendlyCount

protected

m_iRatioMethod

int SCR_FactionControlTriggerEntity.m_iRatioMethod

protected

---

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

• Game/Entities/Triggers/SCR_FactionControlTriggerEntity.c