Inheritance diagram for SCR_ScenarioFrameworkSystem:

Public Member Functions
override bool	ShouldBePaused ()
	Is this system should be paused while the simulation is paused?

void	RpcDo_SetSignalOnEntity (EntityID pEntID, string signalName, int val)
	Sets signal value on entity by ID.

void	SetSignalValue (IEntity entity, string signalName, int val)
	Sets signal value on entity via RPC.

void	RpcDo_PlaySoundOnEntity (EntityID pEntID, string sSndName)
	Plays sound on entity by ID.

void	PlaySoundOnEntity (IEntity entity, string sSndName)
	Plays sound on entity or game mode if entity is null.

void	RpcDo_PlayCommunicationSoundOnEntity (EntityID pEntID, string sSndName)
	Plays sound on entity by ID.

void	PlayCommunicationSoundOnEntity (IEntity entity, string sSndName)
	Plays communication sound on entity or game mode if entity is null.

void	PlayIntroVoiceline (int playerID, string eventName, EntityID entityID)
	Plays intro voiceline for player with specified event name and entity ID.

void	RpcDo_PlayIntroVoiceline (int playerID, string eventName, EntityID entityID)
	Plays intro voiceline event for player, sets objectives based on indexes, and plays sound event.

void	RpcDo_PlaySoundOnEntityPosition (RplId objectID, string soundFile, string soundEventName)
	Plays sound on entity position with given sound file and event name.

void	PlaySoundOnEntityPosition (IEntity object, string soundFile, string soundEventName)
	Plays sound event on the position of provided entity.

SCR_Task	GetLastFinishedTask ()

SCR_ScenarioFrameworkLayerBase	GetLastFinishedTaskLayer ()

array< SCR_ScenarioFrameworkArea >	GetAreas ()

void	OnTaskAdded (SCR_Task task)

void	OnTaskAddedCalledLater (SCR_Task task)

void	OnTaskUpdate (SCR_Task task, SCR_ETaskState taskState)
	Updates task properties, checks if task is finished, and triggers pop-up messages or slot task updates based on event.

void	SetMissionEndScreen (EGameOverTypes GameOverType)

void	Finish ()
	Finishes current game mode, sets match over flag, and ends game mode with specified type.

bool	GetIsMatchOver ()

ScriptInvoker	GetOnAllAreasInitiated ()

SCR_ScenarioFrameworkArea	SelectNearestAreaByTaskType (SCR_ESFTaskType eTaskType)
	Selects nearest area with suitable task type for last finished task position.

bool	IsMaster ()
	Checks if current game mode has RplComponent and is not a proxy.

void	RegisterArea (SCR_ScenarioFrameworkArea area)
	Registers new area in scenario framework areas list.

void	LoadComponentSettings ()
	Loads component settings from SCR_GameModeSFManager.

void	LoadHeaderSettings ()
	Loads mission header settings.

bool	Init ()
	Initializes scenario framework system.

void	PostInit ()
	Generates tasks for debug shape layers on player connect, if any.

void	OnPlayerConnected (int playerID)

void	SyncDebugShapes (int playerID)
	Synchronizes debug shapes for player with ID, manages layer visibility and position.

void	SpawnRandomTask (int countSafe=0)
	Spawns random tasks in an area, removing duplicates and ensuring task type balance.

void	GenerateTasks ()
	Main function responsible for selecting available tasks and spawning the areas related to the tasks.

void	CreateVariableValue (string key, string value)
	Create a new global variable at the scenario.

void	RpcDo_CreateVariableValue (string key, string value, int playerID)
	Create a new global variable at the scenario.

void	SetVariableValue (string key, string value)
	Set a value to global variable at the scenario.

void	RpcDo_SetVariableValue (string key, string value)
	Set a value to global variable at the scenario.

bool	GetVariable (string key, out string value)
	Get value of given variable.

void	ProcessVoicelineEnumAndString (TypeName targetEnum, string targetString)
	Processes voice line enum and string, assigns index if match found.

void	AfterLayerTasksInit ()
	Executes AfterTasksInitActions after all Layer Tasks are finished spawning.

void	GenerateSingleTask (int index)
	Generates an area with a layer and slot tasks, if valid indices provided.

SCR_ScenarioFrameworkArea	SelectRandomAreaByTaskType (SCR_ESFTaskType eTaskType)
	Selects random area with suitable task type from list of areas.

SCR_ScenarioFrameworkArea	GetParentArea (IEntity child)
	Get parent area the object is nested into.

void	PrepareAreaSpecificDynamicDespawn (SCR_ScenarioFrameworkArea area, bool staySpawned=false, int despawnRange=0)
	Prepares dynamic spawn/despawn for specific area (Intended for runtime usage)

void	RemoveAreaSpecificDynamicDespawn (SCR_ScenarioFrameworkArea area, bool staySpawned=false)
	Removes dynamic spawn/despawn for specific area (Intended for runtime usage)

void	PrepareDynamicDespawn ()
	Prepares dynamic spawn/despawn.

void	CheckDistance ()
	Refreshes array of player characters and checks which areas should spawn/despawn.

void	DynamicSpawn ()
	Goes over despawned areas and checks whether or not said area should spawn.

void	DynamicDespawn ()
	Goes over spawned areas and checks whether or not said area should despawn.

void	ShowHint (string sTitle, string sSubtitle, int timeOut, FactionKey factionKey="", int playerID=-1)
	Displays hint with title, subtitle, timeout, faction key, and player ID, then calls RpcDo.

void	RpcDo_ShowHint (string sTitle, string sSubtitle, int timeOut, FactionKey factionKey, int playerID)
	Displays hint with title, subtitle, timeout, and fact/playerID checks.

void	HideHint (FactionKey factionKey="", int playerID=-1)
	Hide current hint.

void	RpcDo_HideHint (FactionKey factionKey, int playerID)
	Hide current hint.

void	PopUpMessage (string sTitle, string sSubtitle, FactionKey factionKey="", int playerID=-1, string titleParam1="", string titleParam2="", string subtitleParam1="", string subtitleParam2="")
	Displays a pop-up message with title, subtitle, optional faction key, and optional player ID.

void	RpcDo_PopUpMessage (string sTitle, string sSubtitle, FactionKey factionKey, int playerID, string titleParam1, string titleParam2, string subtitleParam1, string subtitleParam2)
	Displays pop-up message with title, subtitle, and checks if player is in specified faction or not.

void	ManageLayerDebugShape (EntityID id, bool draw, float radius, bool runtime)
	Manages layer debug shape visibility and radius, updates event mask if draw is true, stores layer IDs for runtime in session.

void	RpcDo_ManageLayerDebugShape (int playerID, EntityID id, bool draw, float radius)
	Manages layer debug shape visibility and radius for specified player.

void	ShowLayout (int playerId=-1, EntityID actionOwnerEntId=EntityID.INVALID, int layoutId=-1, float fadeIn=-1, float fadeOut=-1, float visibilityTime=-1, float opacity=-1)
	Displays a pop-up message with title, subtitle, optional faction key, and optional player ID.

void	RpcDo_ShowLayout (int playerID, EntityID actionOwnerEntId, int layoutId, float fadeIn, float fadeOut, float visibilityTime, float opacity)
	Displays a pop-up message with title, subtitle, optional faction key, and optional player ID.

void	FadeOut (Widget imgWidget, float fadeOut)

SCR_ScenarioFrameworkActionShowLayout	GetLayoutComponent (SCR_ScenarioFrameworkLayerBase layerBase, int layoutId)

SCR_ScenarioFrameworkActionShowLayout	CheckSubActions (SCR_ScenarioFrameworkActionBase action, int layoutId)

void	~SCR_ScenarioFrameworkSystem ()
	Clears CallQueue after destruction of this system.

Public Member Functions inherited from GameSystem
bool	ShouldBeEnabledInEditMode ()
	Is this system should be enabled inside the editor.

Static Public Member Functions
static override void	InitInfo (WorldSystemInfo outInfo)

static SCR_ScenarioFrameworkSystem	GetInstance ()

static ScriptCallQueue	GetCallQueuePausable ()

static ScriptInvokerScenarioFrameworkSlotAI	GetOnSlotAISpawned ()

static void	InvokeSlotAISpawned (SCR_ScenarioFrameworkLayerBase layer, IEntity entity)

static bool	IsSaveGameLoading ()

static bool	IsWorldLoadInit ()

Public Attributes
ref array< ref SCR_ScenarioFrameworkTaskType >	m_aTaskTypesAvailable

int	m_iMaxNumberOfTasks

ref array< ref SCR_ScenarioFrameworkActionBase >	m_aAfterTasksInitActions

ref array< ref SCR_ScenarioFrameworkDebugAction >	m_aDebugActions

ref array< string >	m_aCoreAreas

ref array< ref SCR_ScenarioFrameworkDebugArea >	m_aDebugAreas

bool	m_bDynamicDespawn

int	m_iUpdateRate

ResourceName	m_sVoiceOverDataConfig

bool	m_bMatchOver

bool	m_bDebugInit

bool	m_bIsWorldLoadInit

bool	m_bIsSaveGameLoad

ref ScriptInvoker	m_OnAllAreasInitiated

ref ScriptInvoker	m_OnTaskStateChanged

SCR_ScenarioFrameworkLayerBase	m_LastFinishedTaskLayer

SCR_Task	m_LastFinishedTask

EGameOverTypes	m_eGameOverType = EGameOverTypes.COMBATPATROL_DRAW

ref array< SCR_ScenarioFrameworkArea >	m_aAreas = {}

ref array< SCR_ScenarioFrameworkArea >	m_aSelectedAreas = {}

ref array< SCR_ScenarioFrameworkLayerTask >	m_aLayerTasksToBeInitialized = {}

ref array< SCR_ScenarioFrameworkLayerTask >	m_aLayerTasksForRandomization = {}

ref array< int >	m_aIntroVoicelineIndexes = {}

ref array< string >	m_aAreasTasksToSpawn = {}

ref array< string >	m_aLayersTaskToSpawn = {}

ref array< string >	m_aSlotsTaskToSpawn = {}

ref array< SCR_ESFTaskType >	m_aESFTaskTypesAvailable = {}

ref array< SCR_ESFTaskType >	m_aESFTaskTypeForRandomization = {}

ref array< ref Tuple3< SCR_ScenarioFrameworkArea, vector, int > >	m_aSpawnedAreas = {}

ref array< ref Tuple3< SCR_ScenarioFrameworkArea, vector, int > >	m_aDespawnedAreas = {}

ref array< ref Tuple3< EntityID, bool, float > >	m_aDebugShapesLayers = {}

ref array< vector >	m_aObservers = {}

ref map< string, string >	m_mVariableMap = new map<string, string>

Static Public Attributes
static ref ScriptInvokerBase< ScriptInvokerScenarioFrameworkSlotAIMethod >	m_OnSlotAISpawned

Protected Member Functions
override void	OnInit ()
	Registers debug menus for ScenarioFramework in DiagMenu.

override void	OnUpdatePoint (WorldUpdatePointArgs args)

override void	OnDiag (float timeSlice)

Protected Attributes
FactionManager	m_FactionManager

SCR_TaskSystem	m_TaskSystem

float	m_fTimer

float	m_fCheckInterval

Static Protected Attributes
static ref ScriptCallQueue	s_CallQueuePausable = new ScriptCallQueue()

Constructor & Destructor Documentation

◆ ~SCR_ScenarioFrameworkSystem()

void SCR_ScenarioFrameworkSystem.~SCR_ScenarioFrameworkSystem ( )

Clears CallQueue after destruction of this system.

Member Function Documentation

◆ AfterLayerTasksInit()

void SCR_ScenarioFrameworkSystem.AfterLayerTasksInit ( )

Executes AfterTasksInitActions after all Layer Tasks are finished spawning.

◆ CheckDistance()

void SCR_ScenarioFrameworkSystem.CheckDistance ( )

Refreshes array of player characters and checks which areas should spawn/despawn.

◆ CheckSubActions()

SCR_ScenarioFrameworkActionShowLayout SCR_ScenarioFrameworkSystem.CheckSubActions	(	SCR_ScenarioFrameworkActionBase	action,
		int	layoutId )

◆ CreateVariableValue()

void SCR_ScenarioFrameworkSystem.CreateVariableValue	(	string	key,
		string	value )

Create a new global variable at the scenario.

◆ DynamicDespawn()

void SCR_ScenarioFrameworkSystem.DynamicDespawn ( )

Goes over spawned areas and checks whether or not said area should despawn.

◆ DynamicSpawn()

void SCR_ScenarioFrameworkSystem.DynamicSpawn ( )

Goes over despawned areas and checks whether or not said area should spawn.

◆ FadeOut()

void SCR_ScenarioFrameworkSystem.FadeOut	(	Widget	imgWidget,
		float	fadeOut )

◆ Finish()

void SCR_ScenarioFrameworkSystem.Finish ( )

Finishes current game mode, sets match over flag, and ends game mode with specified type.

◆ GenerateSingleTask()

void SCR_ScenarioFrameworkSystem.GenerateSingleTask ( int index )

Generates an area with a layer and slot tasks, if valid indices provided.

Parameters

[in] index Index represents the specific task configuration for slot, layer, and area in the scenario.

◆ GenerateTasks()

void SCR_ScenarioFrameworkSystem.GenerateTasks ( )

Main function responsible for selecting available tasks and spawning the areas related to the tasks.

◆ GetAreas()

array< SCR_ScenarioFrameworkArea > SCR_ScenarioFrameworkSystem.GetAreas ( )

Returns: Array of scenario framework areas.

◆ GetCallQueuePausable()

static ScriptCallQueue SCR_ScenarioFrameworkSystem.GetCallQueuePausable ( )

static

Returns: the instance of ScenarioFramework Call Queue.

◆ GetInstance()

static SCR_ScenarioFrameworkSystem SCR_ScenarioFrameworkSystem.GetInstance ( )

static

Returns: the instance of ScenarioFrameworkSystem.

◆ GetIsMatchOver()

bool SCR_ScenarioFrameworkSystem.GetIsMatchOver ( )

Returns: whether match is over.

◆ GetLastFinishedTask()

SCR_Task SCR_ScenarioFrameworkSystem.GetLastFinishedTask ( )

Returns: Last finished task.

◆ GetLastFinishedTaskLayer()

SCR_ScenarioFrameworkLayerBase SCR_ScenarioFrameworkSystem.GetLastFinishedTaskLayer ( )

Returns: Last finished task layer in scenario execution.

◆ GetLayoutComponent()

SCR_ScenarioFrameworkActionShowLayout SCR_ScenarioFrameworkSystem.GetLayoutComponent	(	SCR_ScenarioFrameworkLayerBase	layerBase,
		int	layoutId )

◆ GetOnAllAreasInitiated()

ScriptInvoker SCR_ScenarioFrameworkSystem.GetOnAllAreasInitiated ( )

Returns: a ScriptInvoker object for handling all area initiation events.

◆ GetOnSlotAISpawned()

static ScriptInvokerScenarioFrameworkSlotAI SCR_ScenarioFrameworkSystem.GetOnSlotAISpawned ( )

static

Returns: a ScriptInvokerBase object representing the invoker triggered when SlotAI spawned AI character/group.

◆ GetParentArea()

SCR_ScenarioFrameworkArea SCR_ScenarioFrameworkSystem.GetParentArea ( IEntity child )

Get parent area the object is nested into.

Parameters

[in] child

◆ GetVariable()

bool SCR_ScenarioFrameworkSystem.GetVariable	(	string	key,
		out string	value )

Get value of given variable.

◆ HideHint()

void SCR_ScenarioFrameworkSystem.HideHint	(	FactionKey	factionKey = "",
		int	playerID = -1 )

Hide current hint.

Parameters

[in]	factionKey	represents the identifier for the faction in the game world.
[in]	playerID	represents the unique identifier for the player receiving the hint.

◆ Init()

bool SCR_ScenarioFrameworkSystem.Init ( )

Initializes scenario framework system.

Returns: The return value represents whether the initialization process was successful or not.

◆ InitInfo()

static override void SCR_ScenarioFrameworkSystem.InitInfo ( WorldSystemInfo outInfo )

static

◆ InvokeSlotAISpawned()

static void SCR_ScenarioFrameworkSystem.InvokeSlotAISpawned	(	SCR_ScenarioFrameworkLayerBase	layer,
		IEntity	entity )

static

◆ IsMaster()

bool SCR_ScenarioFrameworkSystem.IsMaster ( )

Checks if current game mode has RplComponent and is not a proxy.

Returns: true if the current game mode is not a proxy RplComponent, otherwise false.

◆ IsSaveGameLoading()

static bool SCR_ScenarioFrameworkSystem.IsSaveGameLoading ( )

static

◆ IsWorldLoadInit()

static bool SCR_ScenarioFrameworkSystem.IsWorldLoadInit ( )

static

◆ LoadComponentSettings()

void SCR_ScenarioFrameworkSystem.LoadComponentSettings ( )

Loads component settings from SCR_GameModeSFManager.

◆ LoadHeaderSettings()

void SCR_ScenarioFrameworkSystem.LoadHeaderSettings ( )

Loads mission header settings.

◆ ManageLayerDebugShape()

void SCR_ScenarioFrameworkSystem.ManageLayerDebugShape	(	EntityID	id,
		bool	draw,
		float	radius,
		bool	runtime )

Manages layer debug shape visibility and radius, updates event mask if draw is true, stores layer IDs for runtime in session.

Parameters

[in]	id	Entity ID represents the unique identifier for an entity in the game world, used to find and manipulate specific objects in the simulation
[in]	draw	represents whether to display debug shape for the layer during runtime.
[in]	radius	represents the size of debug shape drawn around the layer entity in the game world.
[in]	runtime	determines if debug shapes should be drawn during gameplay or not.

◆ OnDiag()

override void SCR_ScenarioFrameworkSystem.OnDiag ( float timeSlice )

protected

Parameters

[in] timeSlice interval for diagnostics update.

◆ OnInit()

override void SCR_ScenarioFrameworkSystem.OnInit ( )

protected

Registers debug menus for ScenarioFramework in DiagMenu.

◆ OnPlayerConnected()

void SCR_ScenarioFrameworkSystem.OnPlayerConnected ( int playerID )

◆ OnTaskAdded()

void SCR_ScenarioFrameworkSystem.OnTaskAdded ( SCR_Task task )

Parameters

[in] task Displays a message when a new task is created, indicating if it's for a specific faction or not.

◆ OnTaskAddedCalledLater()

void SCR_ScenarioFrameworkSystem.OnTaskAddedCalledLater ( SCR_Task task )

Parameters

[in] task Displays a message when a new task is created, indicating if it's for a specific faction or not.

◆ OnTaskUpdate()

void SCR_ScenarioFrameworkSystem.OnTaskUpdate	(	SCR_Task	task,
		SCR_ETaskState	taskState )

Updates task properties, checks if task is finished, and triggers pop-up messages or slot task updates based on event.

Parameters

[in]	task	Updates task properties, checks for finished tasks, triggers pop-up messages, and invokes onTaskStateChanged event
[in]	taskState	representing changes in task properties, excluding creation, completion, or assignee changes.

◆ OnUpdatePoint()

override void SCR_ScenarioFrameworkSystem.OnUpdatePoint ( WorldUpdatePointArgs args )

protected

◆ PlayCommunicationSoundOnEntity()

void SCR_ScenarioFrameworkSystem.PlayCommunicationSoundOnEntity	(	IEntity	entity,
		string	sSndName )

Plays communication sound on entity or game mode if entity is null.

Parameters

[in]	entity	Represents an in-game object or character.
[in]	sSndName	sSndName is the name of the sound file to play on the specified entity.

◆ PlayIntroVoiceline()

void SCR_ScenarioFrameworkSystem.PlayIntroVoiceline	(	int	playerID,
		string	eventName,
		EntityID	entityID )

Plays intro voiceline for player with specified event name and entity ID.

Parameters

[in]	playerID	Player ID represents the unique identifier for the player in the game.
[in]	eventName	Plays intro voiceline for event.
[in]	entityID	EntityID represents the ID of the entity playing the intro voiceline.

◆ PlaySoundOnEntity()

void SCR_ScenarioFrameworkSystem.PlaySoundOnEntity	(	IEntity	entity,
		string	sSndName )

Plays sound on entity or game mode if entity is null.

Parameters

[in]	entity	Represents an in-game object or character.
[in]	sSndName	sSndName is the name of the sound file to play on the specified entity.

◆ PlaySoundOnEntityPosition()

void SCR_ScenarioFrameworkSystem.PlaySoundOnEntityPosition	(	IEntity	object,
		string	soundFile,
		string	soundEventName )

Plays sound event on the position of provided entity.

Parameters

[in]	object	where taht sound will be played
[in]	soundFile	resource name of a sound file that contains desired event
[in]	soundEventName	name of a sound event that will be used to play a sound

◆ PopUpMessage()

void SCR_ScenarioFrameworkSystem.PopUpMessage	(	string	sTitle,
		string	sSubtitle,
		FactionKey	factionKey = "",
		int	playerID = -1,
		string	titleParam1 = "",
		string	titleParam2 = "",
		string	subtitleParam1 = "",
		string	subtitleParam2 = "" )

Displays a pop-up message with title, subtitle, optional faction key, and optional player ID.

Parameters

[in]	sTitle	for pop-up message displayed on screen.
[in]	sSubtitle	is the secondary message displayed in the pop-up message box.
[in]	factionKey	represents the identifier for the faction in the game, used to specify which faction's message is being
[in]	playerID	represents the unique identifier for the player receiving the pop-up message.

◆ PostInit()

void SCR_ScenarioFrameworkSystem.PostInit ( )

Generates tasks for debug shape layers on player connect, if any.

◆ PrepareAreaSpecificDynamicDespawn()

void SCR_ScenarioFrameworkSystem.PrepareAreaSpecificDynamicDespawn	(	SCR_ScenarioFrameworkArea	area,
		bool	staySpawned = false,
		int	despawnRange = 0 )

Prepares dynamic spawn/despawn for specific area (Intended for runtime usage)

Parameters

[in]	area
[in]	staySpawned

◆ PrepareDynamicDespawn()

void SCR_ScenarioFrameworkSystem.PrepareDynamicDespawn ( )

Prepares dynamic spawn/despawn.

◆ ProcessVoicelineEnumAndString()

void SCR_ScenarioFrameworkSystem.ProcessVoicelineEnumAndString	(	TypeName	targetEnum,
		string	targetString )

Processes voice line enum and string, assigns index if match found.

Parameters

[in]	targetEnum	TargetEnum is an enum type representing combat operations in the game, used for indexing voice lines based on the given string.
[in]	targetString	Represents a string value associated with an enum in the SCR_ECombatOps_Everon_Tasks enum

◆ RegisterArea()

void SCR_ScenarioFrameworkSystem.RegisterArea ( SCR_ScenarioFrameworkArea area )

Registers new area in scenario framework areas list.

Parameters

[in] area to be registered.

◆ RemoveAreaSpecificDynamicDespawn()

void SCR_ScenarioFrameworkSystem.RemoveAreaSpecificDynamicDespawn	(	SCR_ScenarioFrameworkArea	area,
		bool	staySpawned = false )

Removes dynamic spawn/despawn for specific area (Intended for runtime usage)

Parameters

[in]	area
[in]	staySpawned

◆ RpcDo_CreateVariableValue()

void SCR_ScenarioFrameworkSystem.RpcDo_CreateVariableValue	(	string	key,
		string	value,
		int	playerID )

Create a new global variable at the scenario.

◆ RpcDo_HideHint()

void SCR_ScenarioFrameworkSystem.RpcDo_HideHint	(	FactionKey	factionKey,
		int	playerID )

Hide current hint.

Parameters

[in]	factionKey	represents the identifier for the faction in the game, used to check if the local player is part of it
[in]	playerID	represents the unique identifier for a player in the game.

◆ RpcDo_ManageLayerDebugShape()

void SCR_ScenarioFrameworkSystem.RpcDo_ManageLayerDebugShape	(	int	playerID,
		EntityID	id,
		bool	draw,
		float	radius )

Manages layer debug shape visibility and radius for specified player.

Parameters

[in]	playerID	Player ID represents the unique identifier for the player controlling the action in the method.
[in]	id	Represents entity ID for scenario layer in the game world.
[in]	draw	parameter represents whether to enable or disable debug shapes for the specified layer during runtime.
[in]	radius	represents the size of debug shape drawn around the layer during runtime.

◆ RpcDo_PlayCommunicationSoundOnEntity()

void SCR_ScenarioFrameworkSystem.RpcDo_PlayCommunicationSoundOnEntity	(	EntityID	pEntID,
		string	sSndName )

Plays sound on entity by ID.

Parameters

[in]	pEntID	Entity ID representing an object in the game world.
[in]	sSndName	Sound name for playing sound on entity.

◆ RpcDo_PlayIntroVoiceline()

void SCR_ScenarioFrameworkSystem.RpcDo_PlayIntroVoiceline	(	int	playerID,
		string	eventName,
		EntityID	entityID )

Plays intro voiceline event for player, sets objectives based on indexes, and plays sound event.

Parameters

[in]	playerID	Player ID represents the unique identifier for the player in the game.
[in]	eventName	EventName is the name of the sound event to be played for the player when intro voiceline is triggered.
[in]	entityID	EntityID represents an optional parameter for specifying an entity in the game world to which the intro voice line should be played.

◆ RpcDo_PlaySoundOnEntity()

void SCR_ScenarioFrameworkSystem.RpcDo_PlaySoundOnEntity	(	EntityID	pEntID,
		string	sSndName )

Plays sound on entity by ID.

Parameters

[in]	pEntID	Entity ID representing an object in the game world.
[in]	sSndName	Sound name for playing sound on entity.

◆ RpcDo_PlaySoundOnEntityPosition()

void SCR_ScenarioFrameworkSystem.RpcDo_PlaySoundOnEntityPosition	(	RplId	objectID,
		string	soundFile,
		string	soundEventName )

Plays sound on entity position with given sound file and event name.

Parameters

[in]	objectID	Represents an entity in the game world.
[in]	soundFile	Sound file is the audio resource played at the entity's position.
[in]	soundEventName	SoundEventName is the name of the sound event to play on the specified entity's position.

◆ RpcDo_PopUpMessage()

void SCR_ScenarioFrameworkSystem.RpcDo_PopUpMessage	(	string	sTitle,
		string	sSubtitle,
		FactionKey	factionKey,
		int	playerID,
		string	titleParam1,
		string	titleParam2,
		string	subtitleParam1,
		string	subtitleParam2 )

Displays pop-up message with title, subtitle, and checks if player is in specified faction or not.

Parameters

[in]	sTitle	for pop-up message displayed on screen.
[in]	sSubtitle	is the message content displayed in the pop-up notification.
[in]	factionKey	represents the identifier for a faction in the game, used to check if the local player is part of it
[in]	playerID	represents the unique identifier for a player in the game.

◆ RpcDo_SetSignalOnEntity()

void SCR_ScenarioFrameworkSystem.RpcDo_SetSignalOnEntity	(	EntityID	pEntID,
		string	signalName,
		int	val )

Sets signal value on entity by ID.

Parameters

[in]	pEntID	Entity ID of an object in the game world.
[in]	signalName	Signal name is an identifier for a specific signal within an entity, used to set its value in the method.
[in]	val	val represents the value to set for the specified signal on the entity.

◆ RpcDo_SetVariableValue()

void SCR_ScenarioFrameworkSystem.RpcDo_SetVariableValue	(	string	key,
		string	value )

Set a value to global variable at the scenario.

◆ RpcDo_ShowHint()

void SCR_ScenarioFrameworkSystem.RpcDo_ShowHint	(	string	sTitle,
		string	sSubtitle,
		int	timeOut,
		FactionKey	factionKey,
		int	playerID )

Displays hint with title, subtitle, timeout, and fact/playerID checks.

Parameters

[in]	sTitle	is the title of the hint message displayed to players.
[in]	sSubtitle	is the secondary message displayed in hint UI, it provides additional information related to the main title.
[in]	timeOut	represents the duration in seconds for which hint is displayed on screen.
[in]	factionKey	represents the identifier for the faction in the game, used to check if the local player is part of it
[in]	playerID	represents the unique identifier for a player in the game.

◆ RpcDo_ShowLayout()

void SCR_ScenarioFrameworkSystem.RpcDo_ShowLayout	(	int	playerID,
		EntityID	actionOwnerEntId,
		int	layoutId,
		float	fadeIn,
		float	fadeOut,
		float	visibilityTime,
		float	opacity )

Displays a pop-up message with title, subtitle, optional faction key, and optional player ID.

Parameters

[in]	playerId	Player ID represents the unique identifier for the player.
[in]	actionOwnerEntId	entity ID identifying entity that holds the action.
[in]	int	layoutId layout ID identifying a specific UI layout
[in]	float	fadeIn fade in time.
[in]	float	fadeOut fade out time.
[in]	float	time for how long layout will be visible.
[in]	float	opacity of the layout.

◆ SelectNearestAreaByTaskType()

SCR_ScenarioFrameworkArea SCR_ScenarioFrameworkSystem.SelectNearestAreaByTaskType ( SCR_ESFTaskType eTaskType )

Selects nearest area with suitable task type for last finished task position.

Parameters

[in] eTaskType eTaskType represents the type of task required for selecting an area in the scenario framework.

Returns: Selects nearest area suitable for given task type based on last finished task position.

◆ SelectRandomAreaByTaskType()

SCR_ScenarioFrameworkArea SCR_ScenarioFrameworkSystem.SelectRandomAreaByTaskType ( SCR_ESFTaskType eTaskType )

Selects random area with suitable task type from list of areas.

Parameters

[in] eTaskType Task type parameter represents the type of task to be assigned in the selected area.

Returns: a randomly selected area from the list of areas suitable for the given task type, or null if no suitable area is found

◆ SetMissionEndScreen()

void SCR_ScenarioFrameworkSystem.SetMissionEndScreen ( EGameOverTypes GameOverType )

Parameters

[in] GameOverType Represents mission end type for displaying appropriate end screen in game.

◆ SetSignalValue()

void SCR_ScenarioFrameworkSystem.SetSignalValue	(	IEntity	entity,
		string	signalName,
		int	val )

Sets signal value on entity via RPC.

Parameters

[in]	entity	Represents an in-game object with properties and behavior.
[in]	signalName	SignalName is the name of the signal on the entity to set its value.
[in]	val	val: Integer representing signal value to set on entity.

◆ SetVariableValue()

void SCR_ScenarioFrameworkSystem.SetVariableValue	(	string	key,
		string	value )

Set a value to global variable at the scenario.

◆ ShouldBePaused()

override bool SCR_ScenarioFrameworkSystem.ShouldBePaused ( )

Is this system should be paused while the simulation is paused?

Implements GameSystem.

◆ ShowHint()

void SCR_ScenarioFrameworkSystem.ShowHint	(	string	sTitle,
		string	sSubtitle,
		int	timeOut,
		FactionKey	factionKey = "",
		int	playerID = -1 )

Displays hint with title, subtitle, timeout, faction key, and player ID, then calls RpcDo.

Parameters

[in]	sTitle	string for hint message displayed on screen.
[in]	sSubtitle	is the secondary message displayed in hint.
[in]	timeOut	represents the duration in milliseconds for which hint is displayed on screen.
[in]	factionKey	represents the identifier for the faction in the game world.
[in]	playerID	represents the unique identifier for the player receiving the hint.

◆ ShowLayout()

void SCR_ScenarioFrameworkSystem.ShowLayout	(	int	playerId = -1,
		EntityID	actionOwnerEntId = EntityID::INVALID,
		int	layoutId = -1,
		float	fadeIn = -1,
		float	fadeOut = -1,
		float	visibilityTime = -1,
		float	opacity = -1 )

Displays a pop-up message with title, subtitle, optional faction key, and optional player ID.

Parameters

[in]	playerId	Player ID represents the unique identifier for the player.
[in]	actionOwnerEntId	entity ID identifying entity that holds the action.
[in]	int	layoutId layout ID identifying a specific UI layout
[in]	float	fadeIn fade in time.
[in]	float	fadeOut fade out time.
[in]	float	time for how long layout will be visible.
[in]	float	opacity of the layout.

◆ SpawnRandomTask()

void SCR_ScenarioFrameworkSystem.SpawnRandomTask ( int countSafe = 0 )

Spawns random tasks in an area, removing duplicates and ensuring task type balance.

Parameters

[in] countSafe CountSafe represents the number of tasks already spawned in the scenario, used for limiting the maximum number of tasks that can be

◆ SyncDebugShapes()

void SCR_ScenarioFrameworkSystem.SyncDebugShapes ( int playerID )

Synchronizes debug shapes for player with ID, manages layer visibility and position.

Parameters

[in] playerID Player ID represents the unique identifier for the player controlling the action in the method.

Member Data Documentation

◆ m_aAfterTasksInitActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkSystem.m_aAfterTasksInitActions

◆ m_aAreas

ref array<SCR_ScenarioFrameworkArea> SCR_ScenarioFrameworkSystem.m_aAreas = {}

◆ m_aAreasTasksToSpawn

ref array<string> SCR_ScenarioFrameworkSystem.m_aAreasTasksToSpawn = {}

◆ m_aCoreAreas

ref array<string> SCR_ScenarioFrameworkSystem.m_aCoreAreas

◆ m_aDebugActions

ref array<ref SCR_ScenarioFrameworkDebugAction> SCR_ScenarioFrameworkSystem.m_aDebugActions

◆ m_aDebugAreas

ref array<ref SCR_ScenarioFrameworkDebugArea> SCR_ScenarioFrameworkSystem.m_aDebugAreas

◆ m_aDebugShapesLayers

ref array<ref Tuple3<EntityID, bool, float> > SCR_ScenarioFrameworkSystem.m_aDebugShapesLayers = {}

◆ m_aDespawnedAreas

ref array<ref Tuple3<SCR_ScenarioFrameworkArea, vector, int> > SCR_ScenarioFrameworkSystem.m_aDespawnedAreas = {}

◆ m_aESFTaskTypeForRandomization

ref array<SCR_ESFTaskType> SCR_ScenarioFrameworkSystem.m_aESFTaskTypeForRandomization = {}

◆ m_aESFTaskTypesAvailable

ref array<SCR_ESFTaskType> SCR_ScenarioFrameworkSystem.m_aESFTaskTypesAvailable = {}

◆ m_aIntroVoicelineIndexes

ref array<int> SCR_ScenarioFrameworkSystem.m_aIntroVoicelineIndexes = {}

◆ m_aLayersTaskToSpawn

ref array<string> SCR_ScenarioFrameworkSystem.m_aLayersTaskToSpawn = {}

◆ m_aLayerTasksForRandomization

ref array<SCR_ScenarioFrameworkLayerTask> SCR_ScenarioFrameworkSystem.m_aLayerTasksForRandomization = {}

◆ m_aLayerTasksToBeInitialized

ref array<SCR_ScenarioFrameworkLayerTask> SCR_ScenarioFrameworkSystem.m_aLayerTasksToBeInitialized = {}

◆ m_aObservers

ref array<vector> SCR_ScenarioFrameworkSystem.m_aObservers = {}

◆ m_aSelectedAreas

ref array<SCR_ScenarioFrameworkArea> SCR_ScenarioFrameworkSystem.m_aSelectedAreas = {}

◆ m_aSlotsTaskToSpawn

ref array<string> SCR_ScenarioFrameworkSystem.m_aSlotsTaskToSpawn = {}

◆ m_aSpawnedAreas

ref array<ref Tuple3<SCR_ScenarioFrameworkArea, vector, int> > SCR_ScenarioFrameworkSystem.m_aSpawnedAreas = {}

◆ m_aTaskTypesAvailable

ref array<ref SCR_ScenarioFrameworkTaskType> SCR_ScenarioFrameworkSystem.m_aTaskTypesAvailable

◆ m_bDebugInit

bool SCR_ScenarioFrameworkSystem.m_bDebugInit

◆ m_bDynamicDespawn

bool SCR_ScenarioFrameworkSystem.m_bDynamicDespawn

◆ m_bIsSaveGameLoad

bool SCR_ScenarioFrameworkSystem.m_bIsSaveGameLoad

◆ m_bIsWorldLoadInit

bool SCR_ScenarioFrameworkSystem.m_bIsWorldLoadInit

◆ m_bMatchOver

bool SCR_ScenarioFrameworkSystem.m_bMatchOver

◆ m_eGameOverType

EGameOverTypes SCR_ScenarioFrameworkSystem.m_eGameOverType = EGameOverTypes.COMBATPATROL_DRAW

◆ m_FactionManager

FactionManager SCR_ScenarioFrameworkSystem.m_FactionManager

protected

◆ m_fCheckInterval

float SCR_ScenarioFrameworkSystem.m_fCheckInterval

protected

◆ m_fTimer

float SCR_ScenarioFrameworkSystem.m_fTimer

protected

◆ m_iMaxNumberOfTasks

int SCR_ScenarioFrameworkSystem.m_iMaxNumberOfTasks

◆ m_iUpdateRate

int SCR_ScenarioFrameworkSystem.m_iUpdateRate

◆ m_LastFinishedTask

SCR_Task SCR_ScenarioFrameworkSystem.m_LastFinishedTask

◆ m_LastFinishedTaskLayer

SCR_ScenarioFrameworkLayerBase SCR_ScenarioFrameworkSystem.m_LastFinishedTaskLayer

◆ m_mVariableMap

ref map<string, string> SCR_ScenarioFrameworkSystem.m_mVariableMap = new map<string, string>

◆ m_OnAllAreasInitiated

ref ScriptInvoker SCR_ScenarioFrameworkSystem.m_OnAllAreasInitiated

◆ m_OnSlotAISpawned

ref ScriptInvokerBase<ScriptInvokerScenarioFrameworkSlotAIMethod> SCR_ScenarioFrameworkSystem.m_OnSlotAISpawned

static

◆ m_OnTaskStateChanged

ref ScriptInvoker SCR_ScenarioFrameworkSystem.m_OnTaskStateChanged

◆ m_sVoiceOverDataConfig

ResourceName SCR_ScenarioFrameworkSystem.m_sVoiceOverDataConfig

◆ m_TaskSystem

SCR_TaskSystem SCR_ScenarioFrameworkSystem.m_TaskSystem

protected

◆ s_CallQueuePausable

ref ScriptCallQueue SCR_ScenarioFrameworkSystem.s_CallQueuePausable = new ScriptCallQueue()

staticprotected

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

Game/ScenarioFramework/SCR_ScenarioFrameworkSystem.c

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ ~SCR_ScenarioFrameworkSystem()

Member Function Documentation

◆ AfterLayerTasksInit()

◆ CheckDistance()

◆ CheckSubActions()

◆ CreateVariableValue()

◆ DynamicDespawn()

◆ DynamicSpawn()

◆ FadeOut()

◆ Finish()

◆ GenerateSingleTask()

◆ GenerateTasks()

◆ GetAreas()

◆ GetCallQueuePausable()

◆ GetInstance()

◆ GetIsMatchOver()

◆ GetLastFinishedTask()

◆ GetLastFinishedTaskLayer()

◆ GetLayoutComponent()

◆ GetOnAllAreasInitiated()

◆ GetOnSlotAISpawned()

◆ GetParentArea()

◆ GetVariable()

◆ HideHint()

◆ Init()

◆ InitInfo()

◆ InvokeSlotAISpawned()

◆ IsMaster()

◆ IsSaveGameLoading()

◆ IsWorldLoadInit()

◆ LoadComponentSettings()

◆ LoadHeaderSettings()

◆ ManageLayerDebugShape()

◆ OnDiag()

◆ OnInit()

◆ OnPlayerConnected()

◆ OnTaskAdded()

◆ OnTaskAddedCalledLater()

◆ OnTaskUpdate()

◆ OnUpdatePoint()

◆ PlayCommunicationSoundOnEntity()

◆ PlayIntroVoiceline()

◆ PlaySoundOnEntity()

◆ PlaySoundOnEntityPosition()

◆ PopUpMessage()

◆ PostInit()

◆ PrepareAreaSpecificDynamicDespawn()

◆ PrepareDynamicDespawn()

◆ ProcessVoicelineEnumAndString()

◆ RegisterArea()

◆ RemoveAreaSpecificDynamicDespawn()

◆ RpcDo_CreateVariableValue()

◆ RpcDo_HideHint()

◆ RpcDo_ManageLayerDebugShape()

◆ RpcDo_PlayCommunicationSoundOnEntity()

◆ RpcDo_PlayIntroVoiceline()

◆ RpcDo_PlaySoundOnEntity()

◆ RpcDo_PlaySoundOnEntityPosition()

◆ RpcDo_PopUpMessage()

◆ RpcDo_SetSignalOnEntity()

◆ RpcDo_SetVariableValue()

◆ RpcDo_ShowHint()

◆ RpcDo_ShowLayout()

◆ SelectNearestAreaByTaskType()

◆ SelectRandomAreaByTaskType()

◆ SetMissionEndScreen()

◆ SetSignalValue()

◆ SetVariableValue()

◆ ShouldBePaused()

◆ ShowHint()

◆ ShowLayout()

◆ SpawnRandomTask()