SCR_ScenarioFrameworkPluginTrigger Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkPluginTrigger:

Public Member Functions
override void	Init (SCR_ScenarioFrameworkLayerBase object)
	Initializes scenario framework trigger entity with provided parameters.
override void	OnWBKeyChanged (SCR_ScenarioFrameworkLayerBase object)
override array< ref SCR_ScenarioFrameworkActionBase >	GetActions ()
Public Member Functions inherited from SCR_ScenarioFrameworkPlugin
SCR_ScenarioFrameworkLayerBase	GetObject ()
Public Member Functions inherited from BaseContainerObject
proto external string	GetStoreName ()
	Retrieve the store name, usually just a GUID.

Public Attributes
float	m_fAreaRadius
SCR_EScenarioFrameworkTriggerActivation	m_eActivationPresence
ref array< string >	m_aSpecificEntityNames
ref array< string >	m_aSpecificClassNames
ref array< ref SCR_ScenarioFrameworkPrefabFilter >	m_aPrefabFilter
FactionKey	m_sActivatedByThisFaction
ref array< ref SCR_ScenarioFrameworkActivationConditionBase >	m_aCustomTriggerConditions
SCR_EScenarioFrameworkLogicOperators	m_eCustomTriggerConditionLogic
bool	m_bSearchVehicleInventory
bool	m_bOnce
bool	m_bActivateOnEmpty
float	m_fUpdateRate
float	m_fMinimumPlayersNeededPercentage
float	m_fActivationCountdownTimer
bool	m_bNotificationEnabled
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
Public Attributes inherited from SCR_ScenarioFrameworkPlugin
bool	m_bDebug
SCR_ScenarioFrameworkLayerBase	m_Object

Member Function Documentation

GetActions()

override array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkPluginTrigger.GetActions

(

)

Returns

[out] Actions

Implements SCR_ScenarioFrameworkPlugin.

Init()

override void SCR_ScenarioFrameworkPluginTrigger.Init

(

SCR_ScenarioFrameworkLayerBase

object

)

Initializes scenario framework trigger entity with provided parameters.

Parameters

[in]

object

of layer base from which entity is further retrieved

Implements SCR_ScenarioFrameworkPlugin.

OnWBKeyChanged()

override void SCR_ScenarioFrameworkPluginTrigger.OnWBKeyChanged

(

SCR_ScenarioFrameworkLayerBase

object

)

Parameters

[in]

object

of layer base from which entity is further retrieved

Implements SCR_ScenarioFrameworkPlugin.

Member Data Documentation

m_aCustomTriggerConditions

ref array<ref SCR_ScenarioFrameworkActivationConditionBase> SCR_ScenarioFrameworkPluginTrigger.m_aCustomTriggerConditions

m_aEntityEnteredActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkPluginTrigger.m_aEntityEnteredActions

m_aEntityLeftActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkPluginTrigger.m_aEntityLeftActions

m_aFinishedActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkPluginTrigger.m_aFinishedActions

m_aPrefabFilter

ref array<ref SCR_ScenarioFrameworkPrefabFilter> SCR_ScenarioFrameworkPluginTrigger.m_aPrefabFilter

m_aSpecificClassNames

ref array<string> SCR_ScenarioFrameworkPluginTrigger.m_aSpecificClassNames

m_aSpecificEntityNames

ref array<string> SCR_ScenarioFrameworkPluginTrigger.m_aSpecificEntityNames

m_bActivateOnEmpty

bool SCR_ScenarioFrameworkPluginTrigger.m_bActivateOnEmpty

m_bEnableAudio

bool SCR_ScenarioFrameworkPluginTrigger.m_bEnableAudio

m_bNotificationEnabled

bool SCR_ScenarioFrameworkPluginTrigger.m_bNotificationEnabled

m_bOnce

bool SCR_ScenarioFrameworkPluginTrigger.m_bOnce

m_bSearchVehicleInventory

bool SCR_ScenarioFrameworkPluginTrigger.m_bSearchVehicleInventory

m_eActivationPresence

SCR_EScenarioFrameworkTriggerActivation SCR_ScenarioFrameworkPluginTrigger.m_eActivationPresence

m_eCustomTriggerConditionLogic

SCR_EScenarioFrameworkLogicOperators SCR_ScenarioFrameworkPluginTrigger.m_eCustomTriggerConditionLogic

m_fActivationCountdownTimer

float SCR_ScenarioFrameworkPluginTrigger.m_fActivationCountdownTimer

m_fAreaRadius

float SCR_ScenarioFrameworkPluginTrigger.m_fAreaRadius

m_fMinimumPlayersNeededPercentage

float SCR_ScenarioFrameworkPluginTrigger.m_fMinimumPlayersNeededPercentage

m_fUpdateRate

float SCR_ScenarioFrameworkPluginTrigger.m_fUpdateRate

m_sActivatedByThisFaction

FactionKey SCR_ScenarioFrameworkPluginTrigger.m_sActivatedByThisFaction

m_sCountdownAudio

string SCR_ScenarioFrameworkPluginTrigger.m_sCountdownAudio

m_sPlayerActivationNotificationTitle

string SCR_ScenarioFrameworkPluginTrigger.m_sPlayerActivationNotificationTitle

---

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

• Game/ScenarioFramework/Plugins/SCR_ScenarioFrameworkPluginTrigger.c