Inheritance diagram for SCR_ScenarioFrameworkTriggerEntity:

Protected Member Functions
void	SetActivationPresence (SCR_EScenarioFrameworkTriggerActivation EActivationPresence)
	Sets Activation Presence.
void	SetSpecificClassName (notnull array< string > aClassName)
	Sets specific classnames to be searched in the trigger.
void	AddSpecificEntityNameFilter (notnull array< string > aEntityName)
	Adds specific entity name to be searched in the trigger.
void	SetPrefabFilters (notnull array< ref SCR_ScenarioFrameworkPrefabFilter > aPrefabFilter)
	Sets specific prefab filters to be searched in the trigger.
void	SetSearchVehicleInventory (bool search)
	Sets if trigger should also search vehicle inventory when looking for prefabs/classnames inside.
void	SetOnce (bool bOnce)
	Sets if trigger can be finished just once.
void	SetActivateOnEmpty (bool activateOnEmpty)
void	SetNotificationEnabled (bool notificationEnabled)
	Sets if HUD notifications are enabled.
void	SetTriggerConditionsStatus (bool status)
	Sets trigger conditions status.
void	SetEnableAudio (bool enableAudio)
	Sets if audio features from this trigger are enabled.
void	SetMinimumPlayersNeeded (float minimumPlayersNeededPercentage)
	Sets minimum player percentage needed to finish this trigger.
void	SetPlayerActivationNotificationTitle (string sTitle)
	Sets HUD activation notification title.
void	SetActivationCountdownTimer (float activationCountdownTimer)
	Sets activation coundown timer.
void	SetCountdownAudio (string sAudioName)
	Sets which audio can be played from activating this trigger.
void	SetCustomTriggerConditions (notnull array< ref SCR_ScenarioFrameworkActivationConditionBase > triggerConditions)
void	SetCustomTriggerConditionLogic (SCR_EScenarioFrameworkLogicOperators customTriggerConditionLogic)
	Sets Custom Trigger Condition Logic.
void	SetEntityEnteredActions (array< ref SCR_ScenarioFrameworkActionBase > entityEnteredActions)
void	SetEntityLefActions (array< ref SCR_ScenarioFrameworkActionBase > entityLefActions)
void	SetFinishedActions (array< ref SCR_ScenarioFrameworkActionBase > finishedActions)
void	SetOwnerFaction (FactionKey sFaction)
	Sets faction that "owns" this trigger.
bool	IsMaster ()
	Returns if this is executed in a server environment.
Faction	GetOwnerFaction ()
	Returns trigger faction owner.
ResourceName	GetCountdownHUD ()
	Returns the countdown HUD resource name.
float	GetActivationCountdownTimer ()
	Returns activation countdown timer.
float	GetActivationCountdownTimerTemp ()
	Returns activation countdown timer temporary value which is calculated by the trigger but changes over time.
float	GetMinimumPlayersNeededPercentage ()
	Returns minimum players needed percentage.
string	GetPlayerActivationNotificationTitle ()
	Returns player activation notification title.
bool	GetNotificationEnabled ()
	Returns if HUD notifications are enabled.
bool	GetTriggerConditionsStatus ()
	Returns trigger conditions status.
int	GetCountInsideTrigger ()
	Returns number of all the entities that are inside this trigger.
int	GetCountEntitiesInside ()
	Returns all entities that are inside this trigger.
int	GetPlayersCountByFaction ()
	Returns number of players in game by the faction set for this trigger.
int	GetSpecificClassCountInsideTrigger (string className, int targetCount=-1)
	Returns number of specific class that is inside of this trigger.
int	GetSpecificPrefabCountInsideTrigger (BaseContainer prefabContainer, int targetCount=-1, bool includeInheritance=false)
	Returns number of specific prefab that is inside of this trigger.
int	GetCharacterCountByFactionInsideTrigger (Faction faction, int targetCount=-1)
	Returns number of characters from the selected faction that are inside this trigger.
int	GetPlayersCountByFactionInsideTrigger (Faction faction)
	Returns number of players from the selected faction that are inside this trigger.
void	GetPlayersByFactionInsideTrigger (notnull out array< IEntity > aOut)
	Returns all the players by the faction set for this trigger.
void	GetPlayersByFaction (notnull out array< IEntity > aOut)
	Returns all the players in the game.
override bool	ScriptedEntityFilterForQuery (IEntity ent)
	Override this method in inherited class to define a new filter.
void	FinishTrigger (IEntity ent)
	Finishes trigger.
void	ActivationPresenceConditions ()
	Checks activation presesence conditions.
void	CustomTriggerConditions ()
	This method handles custom conditions.
void	HandleNetworkComponentForPlayersInside (IEntity ent)
	Handles players inside the trigger or those who left it.
void	ProcessPlayerNetworkComponent (IEntity entity, bool leftTrigger=false)
	Processes the entity and its Network component to replicate only for each player inside the trigger.
void	HandleTimer ()
	Handles if timer should be ticking or not.
void	UpdateTimer ()
	Updates the timer value and passes info to HUD.
event void	OnActivate (IEntity ent)
void	OnQueryFinished (bool bIsEmpty)
event void	OnDeactivate (IEntity ent)
void	OnDeactivateCalledLater (IEntity ent)
void	HandleAudio ()
	Checks if trigger conditions are met, plays countdown music if true, stops if false.
void	PlayMusic (string sAudio)
void	RpcDo_PlayMusic (string sAudio)
void	StopMusic (string sAudio)
void	RpcDo_StopMusic (string sAudio)
void	OnChange (IEntity ent)
ScriptInvoker	GetOnChange ()
void	SetInitSequenceDone (bool init)
	Sets Init sequence as done or not.
void	EOnInit (IEntity owner)
	Initializes the trigger.

Protected Attributes
FactionKey	m_sOwnerFactionKey
SCR_EScenarioFrameworkTriggerActivation	m_eActivationPresence
ref array< string >	m_aSpecificEntityNames
ref array< string >	m_aSpecificClassNames
ref array< ref SCR_ScenarioFrameworkPrefabFilter >	m_aPrefabFilter
ref array< ref SCR_ScenarioFrameworkActivationConditionBase >	m_aCustomTriggerConditions
SCR_EScenarioFrameworkLogicOperators	m_eCustomTriggerConditionLogic
bool	m_bSearchVehicleInventory
bool	m_bOnce
bool	m_bActivateOnEmpty
float	m_fMinimumPlayersNeededPercentage
float	m_fActivationCountdownTimer
bool	m_bNotificationEnabled
ResourceName	m_sCountdownHUD
string	m_sPlayerActivationNotificationTitle
bool	m_bEnableAudio
string	m_sCountdownAudio
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aEntityEnteredActions = {}
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aEntityLeftActions = {}
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aFinishedActions = {}
ref set< BaseContainer >	m_aPrefabContainerSet = new set<BaseContainer>()
ref ScriptInvoker	m_OnChange
Faction	m_OwnerFaction
float	m_fTempWaitTime = m_fActivationCountdownTimer
bool	m_bInitSequenceDone = false
bool	m_bCountdownMusicPlaying
ref array< IEntity >	m_aEntitiesInside = {}
ref array< IEntity >	m_aPlayersInside = {}
MusicManager	m_MusicManager
bool	m_bTriggerConditionsStatus
bool	m_bTimerActive
int	m_iCountInsideTrigger

Static Protected Attributes
static ref ScriptInvokerBase< ScriptInvokerTriggerUpdated >	s_OnTriggerUpdated = new ScriptInvokerBase<ScriptInvokerTriggerUpdated>()
static ref ScriptInvokerInt	s_OnTriggerUpdatedPlayerNotPresent = new ScriptInvokerInt()

Detailed Description

Definition at line 9 of file SCR_ScenarioFrameworkTriggerEntity.c.

Member Function Documentation

◆ ActivationPresenceConditions()

void SCR_ScenarioFrameworkTriggerEntity::ActivationPresenceConditions ( )

inlineprotected

Checks activation presesence conditions.

Definition at line 658 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ AddSpecificEntityNameFilter()

void SCR_ScenarioFrameworkTriggerEntity::AddSpecificEntityNameFilter ( notnull array< string > aEntityName )

inlineprotected

Adds specific entity name to be searched in the trigger.

Definition at line 102 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ CustomTriggerConditions()

void SCR_ScenarioFrameworkTriggerEntity::CustomTriggerConditions ( )

inlineprotected

This method handles custom conditions.

Definition at line 677 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ EOnInit()

void SCR_ScenarioFrameworkTriggerEntity::EOnInit ( IEntity owner )

inlineprotected

Initializes the trigger.

Definition at line 966 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ FinishTrigger()

void SCR_ScenarioFrameworkTriggerEntity::FinishTrigger ( IEntity ent )

inlineprotected

Finishes trigger.

Definition at line 639 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetActivationCountdownTimer()

float SCR_ScenarioFrameworkTriggerEntity::GetActivationCountdownTimer ( )

inlineprotected

Returns activation countdown timer.

Definition at line 280 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetActivationCountdownTimerTemp()

float SCR_ScenarioFrameworkTriggerEntity::GetActivationCountdownTimerTemp ( )

inlineprotected

Returns activation countdown timer temporary value which is calculated by the trigger but changes over time.

Definition at line 287 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetCharacterCountByFactionInsideTrigger()

int SCR_ScenarioFrameworkTriggerEntity::GetCharacterCountByFactionInsideTrigger	(	Faction	faction,
		int	targetCount = -1 )

inlineprotected

Returns number of characters from the selected faction that are inside this trigger.

Definition at line 487 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetCountdownHUD()

ResourceName SCR_ScenarioFrameworkTriggerEntity::GetCountdownHUD ( )

inlineprotected

Returns the countdown HUD resource name.

Definition at line 273 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetCountEntitiesInside()

int SCR_ScenarioFrameworkTriggerEntity::GetCountEntitiesInside ( )

inlineprotected

Returns all entities that are inside this trigger.

Definition at line 329 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetCountInsideTrigger()

int SCR_ScenarioFrameworkTriggerEntity::GetCountInsideTrigger ( )

inlineprotected

Returns number of all the entities that are inside this trigger.

Definition at line 322 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetMinimumPlayersNeededPercentage()

float SCR_ScenarioFrameworkTriggerEntity::GetMinimumPlayersNeededPercentage ( )

inlineprotected

Returns minimum players needed percentage.

Definition at line 294 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetNotificationEnabled()

bool SCR_ScenarioFrameworkTriggerEntity::GetNotificationEnabled ( )

inlineprotected

Returns if HUD notifications are enabled.

Definition at line 308 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetOnChange()

ScriptInvoker SCR_ScenarioFrameworkTriggerEntity::GetOnChange ( )

inlineprotected

Returns: a ScriptInvoker object for handling changes in the script.

Definition at line 949 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetOwnerFaction()

Faction SCR_ScenarioFrameworkTriggerEntity::GetOwnerFaction ( )

inlineprotected

Returns trigger faction owner.

Definition at line 266 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetPlayerActivationNotificationTitle()

string SCR_ScenarioFrameworkTriggerEntity::GetPlayerActivationNotificationTitle ( )

inlineprotected

Returns player activation notification title.

Definition at line 301 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetPlayersByFaction()

void SCR_ScenarioFrameworkTriggerEntity::GetPlayersByFaction ( notnull out array< IEntity > aOut )

inlineprotected

Returns all the players in the game.

Definition at line 576 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetPlayersByFactionInsideTrigger()

void SCR_ScenarioFrameworkTriggerEntity::GetPlayersByFactionInsideTrigger ( notnull out array< IEntity > aOut )

inlineprotected

Returns all the players by the faction set for this trigger.

Definition at line 544 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetPlayersCountByFaction()

int SCR_ScenarioFrameworkTriggerEntity::GetPlayersCountByFaction ( )

inlineprotected

Returns number of players in game by the faction set for this trigger.

Definition at line 337 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetPlayersCountByFactionInsideTrigger()

int SCR_ScenarioFrameworkTriggerEntity::GetPlayersCountByFactionInsideTrigger ( Faction faction )

inlineprotected

Returns number of players from the selected faction that are inside this trigger.

Definition at line 514 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetSpecificClassCountInsideTrigger()

int SCR_ScenarioFrameworkTriggerEntity::GetSpecificClassCountInsideTrigger	(	string	className,
		int	targetCount = -1 )

inlineprotected

Returns number of specific class that is inside of this trigger.

Definition at line 365 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetSpecificPrefabCountInsideTrigger()

int SCR_ScenarioFrameworkTriggerEntity::GetSpecificPrefabCountInsideTrigger	(	BaseContainer	prefabContainer,
		int	targetCount = -1,
		bool	includeInheritance = false )

inlineprotected

Returns number of specific prefab that is inside of this trigger.

Definition at line 414 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ GetTriggerConditionsStatus()

bool SCR_ScenarioFrameworkTriggerEntity::GetTriggerConditionsStatus ( )

inlineprotected

Returns trigger conditions status.

Definition at line 315 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ HandleAudio()

void SCR_ScenarioFrameworkTriggerEntity::HandleAudio ( )

inlineprotected

Checks if trigger conditions are met, plays countdown music if true, stops if false.

Definition at line 840 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ HandleNetworkComponentForPlayersInside()

void SCR_ScenarioFrameworkTriggerEntity::HandleNetworkComponentForPlayersInside ( IEntity ent )

inlineprotected

Handles players inside the trigger or those who left it.

Definition at line 687 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ HandleTimer()

void SCR_ScenarioFrameworkTriggerEntity::HandleTimer ( )

inlineprotected

Handles if timer should be ticking or not.

Definition at line 721 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ IsMaster()

bool SCR_ScenarioFrameworkTriggerEntity::IsMaster ( )

inlineprotected

Returns if this is executed in a server environment.

Definition at line 258 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ OnActivate()

event void SCR_ScenarioFrameworkTriggerEntity::OnActivate ( IEntity ent )

inlineprotected

Parameters

[in] ent Entity reference for the object being activated.

Definition at line 756 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ OnChange()

void SCR_ScenarioFrameworkTriggerEntity::OnChange ( IEntity ent )

inlineprotected

Parameters

[in] ent Entity ent is an input parameter representing an entity in the game world that triggers the method's action when its state changes

Definition at line 938 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ OnDeactivate()

event void SCR_ScenarioFrameworkTriggerEntity::OnDeactivate ( IEntity ent )

inlineprotected

Parameters

[in] ent Entity reference representing the object being deactivated.

Definition at line 803 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ OnDeactivateCalledLater()

void SCR_ScenarioFrameworkTriggerEntity::OnDeactivateCalledLater ( IEntity ent )

inlineprotected

Parameters

[in] ent The ent represents an entity inside the method, which is removed from the list of players inside when the method is called.

Definition at line 812 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ OnQueryFinished()

void SCR_ScenarioFrameworkTriggerEntity::OnQueryFinished ( bool bIsEmpty )

inlineprotected

Parameters

[in] bIsEmpty Checks if query is empty, if true, checks if it should finish it and returns without further action processing the trigger.

Definition at line 766 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ PlayMusic()

void SCR_ScenarioFrameworkTriggerEntity::PlayMusic ( string sAudio )

inlineprotected

Plays specified audio track, sets countdown music playing flag, and calls RPC.

Parameters

[in] sAudio is the name of the music file to play.

Definition at line 856 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ ProcessPlayerNetworkComponent()

void SCR_ScenarioFrameworkTriggerEntity::ProcessPlayerNetworkComponent	(	IEntity	entity,
		bool	leftTrigger = false )

inlineprotected

Processes the entity and its Network component to replicate only for each player inside the trigger.

Definition at line 704 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ RpcDo_PlayMusic()

void SCR_ScenarioFrameworkTriggerEntity::RpcDo_PlayMusic ( string sAudio )

inlineprotected

Plays specified audio in music manager if available.

Parameters

[in] sAudio is the name of the music file to play.

Definition at line 879 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ RpcDo_StopMusic()

void SCR_ScenarioFrameworkTriggerEntity::RpcDo_StopMusic ( string sAudio )

inlineprotected

Stops music with given audio name.

Parameters

[in] sAudio is the name of the music track to stop playing.

Definition at line 920 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ ScriptedEntityFilterForQuery()

override bool SCR_ScenarioFrameworkTriggerEntity::ScriptedEntityFilterForQuery ( IEntity ent )

inlineprotected

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

Definition at line 594 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetActivateOnEmpty()

void SCR_ScenarioFrameworkTriggerEntity::SetActivateOnEmpty ( bool activateOnEmpty )

inlineprotected

Parameters

[in] activateOnEmpty Sets if trigger can be finished when it is empty

Definition at line 140 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetActivationCountdownTimer()

void SCR_ScenarioFrameworkTriggerEntity::SetActivationCountdownTimer ( float activationCountdownTimer )

inlineprotected

Sets activation coundown timer.

Definition at line 182 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetActivationPresence()

void SCR_ScenarioFrameworkTriggerEntity::SetActivationPresence ( SCR_EScenarioFrameworkTriggerActivation EActivationPresence )

inlineprotected

Sets Activation Presence.

Definition at line 85 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetCountdownAudio()

void SCR_ScenarioFrameworkTriggerEntity::SetCountdownAudio ( string sAudioName )

inlineprotected

Sets which audio can be played from activating this trigger.

Definition at line 189 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetCustomTriggerConditionLogic()

void SCR_ScenarioFrameworkTriggerEntity::SetCustomTriggerConditionLogic ( SCR_EScenarioFrameworkLogicOperators customTriggerConditionLogic )

inlineprotected

Sets Custom Trigger Condition Logic.

Definition at line 212 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetCustomTriggerConditions()

void SCR_ScenarioFrameworkTriggerEntity::SetCustomTriggerConditions ( notnull array< ref SCR_ScenarioFrameworkActivationConditionBase > triggerConditions )

inlineprotected

Parameters

[in] triggerConditions Sets custom trigger conditions for trigger activation.

Definition at line 196 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetEnableAudio()

void SCR_ScenarioFrameworkTriggerEntity::SetEnableAudio ( bool enableAudio )

inlineprotected

Sets if audio features from this trigger are enabled.

Definition at line 161 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetEntityEnteredActions()

void SCR_ScenarioFrameworkTriggerEntity::SetEntityEnteredActions ( array< ref SCR_ScenarioFrameworkActionBase > entityEnteredActions )

inlineprotected

Parameters

[in] entityEnteredActions Array of actions triggered when an entity entered the trigger.

Definition at line 219 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetEntityLefActions()

void SCR_ScenarioFrameworkTriggerEntity::SetEntityLefActions ( array< ref SCR_ScenarioFrameworkActionBase > entityLefActions )

inlineprotected

Parameters

[in] entityEnteredActions Array of actions triggered when an entity left the trigger.

Definition at line 229 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetFinishedActions()

void SCR_ScenarioFrameworkTriggerEntity::SetFinishedActions ( array< ref SCR_ScenarioFrameworkActionBase > finishedActions )

inlineprotected

Parameters

[in] entityEnteredActions Array of actions triggered when trigger is finished.

Definition at line 239 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetInitSequenceDone()

void SCR_ScenarioFrameworkTriggerEntity::SetInitSequenceDone ( bool init )

inlineprotected

Sets Init sequence as done or not.

Definition at line 959 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetMinimumPlayersNeeded()

void SCR_ScenarioFrameworkTriggerEntity::SetMinimumPlayersNeeded ( float minimumPlayersNeededPercentage )

inlineprotected

Sets minimum player percentage needed to finish this trigger.

Definition at line 168 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetNotificationEnabled()

void SCR_ScenarioFrameworkTriggerEntity::SetNotificationEnabled ( bool notificationEnabled )

inlineprotected

Sets if HUD notifications are enabled.

Definition at line 147 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetOnce()

void SCR_ScenarioFrameworkTriggerEntity::SetOnce ( bool bOnce )

inlineprotected

Sets if trigger can be finished just once.

Definition at line 133 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetOwnerFaction()

void SCR_ScenarioFrameworkTriggerEntity::SetOwnerFaction ( FactionKey sFaction )

inlineprotected

Sets faction that "owns" this trigger.

Definition at line 249 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetPlayerActivationNotificationTitle()

void SCR_ScenarioFrameworkTriggerEntity::SetPlayerActivationNotificationTitle ( string sTitle )

inlineprotected

Sets HUD activation notification title.

Definition at line 175 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetPrefabFilters()

void SCR_ScenarioFrameworkTriggerEntity::SetPrefabFilters ( notnull array< ref SCR_ScenarioFrameworkPrefabFilter > aPrefabFilter )

inlineprotected

Sets specific prefab filters to be searched in the trigger.

Definition at line 112 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetSearchVehicleInventory()

void SCR_ScenarioFrameworkTriggerEntity::SetSearchVehicleInventory ( bool search )

inlineprotected

Sets if trigger should also search vehicle inventory when looking for prefabs/classnames inside.

Definition at line 126 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetSpecificClassName()

void SCR_ScenarioFrameworkTriggerEntity::SetSpecificClassName ( notnull array< string > aClassName )

inlineprotected

Sets specific classnames to be searched in the trigger.

Definition at line 92 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ SetTriggerConditionsStatus()

void SCR_ScenarioFrameworkTriggerEntity::SetTriggerConditionsStatus ( bool status )

inlineprotected

Sets trigger conditions status.

Definition at line 154 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ StopMusic()

void SCR_ScenarioFrameworkTriggerEntity::StopMusic ( string sAudio )

inlineprotected

Stops music with given audio name, also stops countdown music if playing.

Parameters

[in] sAudio is the name of the music track to stop playing.

Definition at line 898 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ UpdateTimer()

void SCR_ScenarioFrameworkTriggerEntity::UpdateTimer ( )

inlineprotected

Updates the timer value and passes info to HUD.

Definition at line 741 of file SCR_ScenarioFrameworkTriggerEntity.c.

Member Data Documentation

◆ m_aCustomTriggerConditions

ref array<ref SCR_ScenarioFrameworkActivationConditionBase> SCR_ScenarioFrameworkTriggerEntity::m_aCustomTriggerConditions

protected

Definition at line 27 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aEntitiesInside

ref array<IEntity> SCR_ScenarioFrameworkTriggerEntity::m_aEntitiesInside = {}

protected

Definition at line 73 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aEntityEnteredActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkTriggerEntity::m_aEntityEnteredActions = {}

protected

Definition at line 62 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aEntityLeftActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkTriggerEntity::m_aEntityLeftActions = {}

protected

Definition at line 63 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aFinishedActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkTriggerEntity::m_aFinishedActions = {}

protected

Definition at line 64 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aPlayersInside

ref array<IEntity> SCR_ScenarioFrameworkTriggerEntity::m_aPlayersInside = {}

protected

Definition at line 74 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aPrefabContainerSet

ref set<BaseContainer> SCR_ScenarioFrameworkTriggerEntity::m_aPrefabContainerSet = new set<BaseContainer>()

protected

Definition at line 66 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aPrefabFilter

ref array<ref SCR_ScenarioFrameworkPrefabFilter> SCR_ScenarioFrameworkTriggerEntity::m_aPrefabFilter

protected

Definition at line 24 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aSpecificClassNames

ref array<string> SCR_ScenarioFrameworkTriggerEntity::m_aSpecificClassNames

protected

Definition at line 21 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_aSpecificEntityNames

ref array<string> SCR_ScenarioFrameworkTriggerEntity::m_aSpecificEntityNames

protected

Definition at line 18 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bActivateOnEmpty

bool SCR_ScenarioFrameworkTriggerEntity::m_bActivateOnEmpty

protected

Definition at line 39 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bCountdownMusicPlaying

bool SCR_ScenarioFrameworkTriggerEntity::m_bCountdownMusicPlaying

protected

Definition at line 72 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bEnableAudio

bool SCR_ScenarioFrameworkTriggerEntity::m_bEnableAudio

protected

Definition at line 57 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bInitSequenceDone

bool SCR_ScenarioFrameworkTriggerEntity::m_bInitSequenceDone = false

protected

Definition at line 71 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bNotificationEnabled

bool SCR_ScenarioFrameworkTriggerEntity::m_bNotificationEnabled

protected

Definition at line 48 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bOnce

bool SCR_ScenarioFrameworkTriggerEntity::m_bOnce

protected

Definition at line 36 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bSearchVehicleInventory

bool SCR_ScenarioFrameworkTriggerEntity::m_bSearchVehicleInventory

protected

Definition at line 33 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bTimerActive

bool SCR_ScenarioFrameworkTriggerEntity::m_bTimerActive

protected

Definition at line 77 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_bTriggerConditionsStatus

bool SCR_ScenarioFrameworkTriggerEntity::m_bTriggerConditionsStatus

protected

Definition at line 76 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_eActivationPresence

SCR_EScenarioFrameworkTriggerActivation SCR_ScenarioFrameworkTriggerEntity::m_eActivationPresence

protected

Definition at line 15 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_eCustomTriggerConditionLogic

SCR_EScenarioFrameworkLogicOperators SCR_ScenarioFrameworkTriggerEntity::m_eCustomTriggerConditionLogic

protected

Definition at line 30 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_fActivationCountdownTimer

float SCR_ScenarioFrameworkTriggerEntity::m_fActivationCountdownTimer

protected

Definition at line 45 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_fMinimumPlayersNeededPercentage

float SCR_ScenarioFrameworkTriggerEntity::m_fMinimumPlayersNeededPercentage

protected

Definition at line 42 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_fTempWaitTime

float SCR_ScenarioFrameworkTriggerEntity::m_fTempWaitTime = m_fActivationCountdownTimer

protected

Definition at line 70 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_iCountInsideTrigger

int SCR_ScenarioFrameworkTriggerEntity::m_iCountInsideTrigger

protected

Definition at line 78 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_MusicManager

MusicManager SCR_ScenarioFrameworkTriggerEntity::m_MusicManager

protected

Definition at line 75 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_OnChange

ref ScriptInvoker SCR_ScenarioFrameworkTriggerEntity::m_OnChange

protected

Definition at line 68 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_OwnerFaction

Faction SCR_ScenarioFrameworkTriggerEntity::m_OwnerFaction

protected

Definition at line 69 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_sCountdownAudio

string SCR_ScenarioFrameworkTriggerEntity::m_sCountdownAudio

protected

Definition at line 60 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_sCountdownHUD

ResourceName SCR_ScenarioFrameworkTriggerEntity::m_sCountdownHUD

protected

Definition at line 51 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_sOwnerFactionKey

FactionKey SCR_ScenarioFrameworkTriggerEntity::m_sOwnerFactionKey

protected

Definition at line 12 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ m_sPlayerActivationNotificationTitle

string SCR_ScenarioFrameworkTriggerEntity::m_sPlayerActivationNotificationTitle

protected

Definition at line 54 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ s_OnTriggerUpdated

ref ScriptInvokerBase<ScriptInvokerTriggerUpdated> SCR_ScenarioFrameworkTriggerEntity::s_OnTriggerUpdated = new ScriptInvokerBase<ScriptInvokerTriggerUpdated>()

staticprotected

Definition at line 80 of file SCR_ScenarioFrameworkTriggerEntity.c.

◆ s_OnTriggerUpdatedPlayerNotPresent

ref ScriptInvokerInt SCR_ScenarioFrameworkTriggerEntity::s_OnTriggerUpdatedPlayerNotPresent = new ScriptInvokerInt()

staticprotected

Definition at line 81 of file SCR_ScenarioFrameworkTriggerEntity.c.

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

scripts/Game/ScenarioFramework/Entities/Triggers/SCR_ScenarioFrameworkTriggerEntity.c

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ ActivationPresenceConditions()

◆ AddSpecificEntityNameFilter()

◆ CustomTriggerConditions()

◆ EOnInit()

◆ FinishTrigger()

◆ GetActivationCountdownTimer()

◆ GetActivationCountdownTimerTemp()

◆ GetCharacterCountByFactionInsideTrigger()

◆ GetCountdownHUD()

◆ GetCountEntitiesInside()

◆ GetCountInsideTrigger()

◆ GetMinimumPlayersNeededPercentage()

◆ GetNotificationEnabled()

◆ GetOnChange()

◆ GetOwnerFaction()

◆ GetPlayerActivationNotificationTitle()

◆ GetPlayersByFaction()

◆ GetPlayersByFactionInsideTrigger()

◆ GetPlayersCountByFaction()

◆ GetPlayersCountByFactionInsideTrigger()

◆ GetSpecificClassCountInsideTrigger()

◆ GetSpecificPrefabCountInsideTrigger()

◆ GetTriggerConditionsStatus()

◆ HandleAudio()

◆ HandleNetworkComponentForPlayersInside()

◆ HandleTimer()

◆ IsMaster()

◆ OnActivate()

◆ OnChange()

◆ OnDeactivate()

◆ OnDeactivateCalledLater()

◆ OnQueryFinished()

◆ PlayMusic()

◆ ProcessPlayerNetworkComponent()

◆ RpcDo_PlayMusic()

◆ RpcDo_StopMusic()

◆ ScriptedEntityFilterForQuery()

◆ SetActivateOnEmpty()

◆ SetActivationCountdownTimer()

◆ SetActivationPresence()

◆ SetCountdownAudio()

◆ SetCustomTriggerConditionLogic()

◆ SetCustomTriggerConditions()

◆ SetEnableAudio()

◆ SetEntityEnteredActions()

◆ SetEntityLefActions()

◆ SetFinishedActions()

◆ SetInitSequenceDone()

◆ SetMinimumPlayersNeeded()

◆ SetNotificationEnabled()

◆ SetOnce()

◆ SetOwnerFaction()

◆ SetPlayerActivationNotificationTitle()

◆ SetPrefabFilters()

◆ SetSearchVehicleInventory()

◆ SetSpecificClassName()

◆ SetTriggerConditionsStatus()

◆ StopMusic()

◆ UpdateTimer()

Member Data Documentation

◆ m_aCustomTriggerConditions

◆ m_aEntitiesInside

◆ m_aEntityEnteredActions

◆ m_aEntityLeftActions

◆ m_aFinishedActions

◆ m_aPlayersInside

◆ m_aPrefabContainerSet

◆ m_aPrefabFilter

◆ m_aSpecificClassNames

◆ m_aSpecificEntityNames

◆ m_bActivateOnEmpty

◆ m_bCountdownMusicPlaying

◆ m_bEnableAudio

◆ m_bInitSequenceDone

◆ m_bNotificationEnabled