SCR_GameModeSFManager.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_GameModeSFManagerClass

Functions
SCR_GameModeSFManagerClass SCR_BaseGameModeComponentClass	Attribute ("Available Tasks for the Scenario", category:"Tasks")]
void	RpcDo_PlaySoundOnEntity (EntityID pEntID, string sSndName)
void	PlaySoundOnEntity (IEntity entity, string sSndName)
void	PlayIntroVoiceline (int playerID, string eventName, EntityID entityID)
void	RpcDo_PlayIntroVoiceline (int playerID, string eventName, EntityID entityID)
void	RpcDo_PlaySoundOnEntityPosition (RplId objectID, string soundFile, string soundEventName)
void	PlaySoundOnEntityPosition (IEntity object, string soundFile, string soundEventName)
SCR_BaseTask	GetLastFinishedTask ()
SCR_ScenarioFrameworkLayerBase	GetLastFinishedTaskLayer ()
array< SCR_ScenarioFrameworkArea >	GetAreas ()
void	OnTaskCreated (SCR_BaseTask task)
void	OnTaskUpdate (SCR_BaseTask task, SCR_ETaskEventMask mask)
void	SetMissionEndScreen (EGameOverTypes GameOverType)
void	Finish ()
bool	GetIsMatchOver ()
ScriptInvoker	GetOnAllAreasInitiated ()
ScriptInvoker	GetOnTaskStateChanged ()
SCR_ScenarioFrameworkArea	SelectNearestAreaByTaskType (SCR_ESFTaskType eTaskType)
bool	IsMaster ()
void	RegisterArea (SCR_ScenarioFrameworkArea area)
protected void	LoadHeaderSettings ()
protected bool	Init ()
	initialization More...
protected void	PostInit ()
void	SpawnRandomTask ()
void	GenerateTasks ()
protected void	PrepareLayerTasksAfterInit ()
	Prepares Layer Tasks that were selected by ON_TASK_INIT activation for invoking AfterTasksInitActions. More...
protected void	CheckLayerTasksAfterInit (SCR_ScenarioFrameworkLayerBase layer)
	Checks if all Layer Tasks that were selected by ON_TASK_INIT activation for invoking AfterTasksInitActions are finished with spawning. More...
void	ProcessVoicelineEnumAndString (typename targetEnum, string targetString)
protected void	AfterLayerTasksInit ()
	Executes AfterTasksInitActions after all Layer Tasks are finished spawning. More...
protected void	GenerateSingleTask (int index)
SCR_ScenarioFrameworkArea	SelectRandomAreaByTaskType (SCR_ESFTaskType eTaskType)
SCR_ScenarioFrameworkArea	GetParentArea (IEntity child)
void	PrepareAreaSpecificDynamicDespawn (SCR_ScenarioFrameworkArea area, bool staySpawned=false)
void	RemoveAreaSpecificDynamicDespawn (SCR_ScenarioFrameworkArea area, bool staySpawned=false)
protected void	PrepareDynamicDespawn ()
	Prepares dynamic spawn/despawn. More...
protected void	CheckDistance ()
	Refreshes array of player characters and checks which areas should spawn/despawn. More...
protected void	DynamicSpawn ()
	Goes over despawned areas and checks whether or not said area should spawn. More...
protected void	DynamicDespawn ()
	Goes over spawned areas and checks whether or not said area should despawn. More...
override void	OnPostInit (IEntity owner)
	Editable Mine. More...
override bool	RplLoad (ScriptBitReader reader)
void	ShowHint (string sTitle, string sSubtitle, int timeOut, FactionKey factionKey="", int playerID=-1)
void	RpcDo_ShowHint (string sTitle, string sSubtitle, int timeOut, FactionKey factionKey, int playerID)
void	PopUpMessage (string sTitle, string sSubtitle, FactionKey factionKey="", int playerID=-1)
void	RpcDo_PopUpMessage (string sTitle, string sSubtitle, FactionKey factionKey, int playerID)

Variables
SCR_GameModeSFManagerClass	SAME_AS_PARENT = 0
SCR_GameModeSFManagerClass	ON_TRIGGER_ACTIVATION = 0
SCR_GameModeSFManagerClass	ON_AREA_TRIGGER_ACTIVATION = 0
SCR_GameModeSFManagerClass	ON_INIT = 0
SCR_GameModeSFManagerClass	ON_TASKS_INIT = 0
SCR_GameModeSFManagerClass	CUSTOM1 = 0
SCR_GameModeSFManagerClass	CUSTOM2 = 0
SCR_GameModeSFManagerClass	CUSTOM3 = 0
SCR_GameModeSFManagerClass	CUSTOM4 = 0
SCR_GameModeSFManagerClass	NONE = 0
SCR_GameModeSFManagerClass	DELIVER = 0
SCR_GameModeSFManagerClass	DESTROY = 0
SCR_GameModeSFManagerClass	DEFEND = 0
SCR_GameModeSFManagerClass	KILL = 0
SCR_GameModeSFManagerClass	CLEAR_AREA = 0
SCR_GameModeSFManagerClass	LAST = 0
SCR_GameModeSFManagerClass	EXTRACTION = 0
protected ref array< ref SCR_ScenarioFrameworkTaskType >	m_aTaskTypesAvailable
protected int	m_iMaxNumberOfTasks
protected ref array< ref SCR_ScenarioFrameworkActionBase >	m_aAfterTasksInitActions
protected ref array< string >	m_aCoreAreas
protected ref array< ref SCR_ScenarioFrameworkDebugArea >	m_aDebugAreas
protected bool	m_bDynamicDespawn
protected int	m_iUpdateRate
protected bool	m_bMatchOver
protected int	m_iCurrentlySpawnedLayerTasks
protected ref ScriptInvoker	m_OnAllAreasInitiated
protected ref ScriptInvoker	m_OnTaskStateChanged
protected SCR_ScenarioFrameworkLayerBase	m_LastFinishedTaskLayer
protected SCR_BaseTask	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< SCR_ESFTaskType >	m_aESFTaskTypesAvailable = {}
ref array< SCR_ESFTaskType >	m_aESFTaskTypeForRandomization = {}
protected ref array< ref Tuple3< SCR_ScenarioFrameworkArea, vector, int > >	m_aSpawnedAreas = {}
protected ref array< ref Tuple3< SCR_ScenarioFrameworkArea, vector, int > >	m_aDespawnedAreas = {}
protected ref array< vector >	m_aObservers = {}

Function Documentation

AfterLayerTasksInit()

protected void AfterLayerTasksInit

(

)

Executes AfterTasksInitActions after all Layer Tasks are finished spawning.

Definition at line 723 of file SCR_GameModeSFManager.c.

Attribute()

SCR_GameModeSFManagerClass SCR_BaseGameModeComponentClass Attribute	(	"Available Tasks for the Scenario"	,
		category:"Tasks"
	)

CheckDistance()

protected void CheckDistance

(

)

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

Definition at line 904 of file SCR_GameModeSFManager.c.

CheckLayerTasksAfterInit()

protected void CheckLayerTasksAfterInit

(

SCR_ScenarioFrameworkLayerBase

layer

)

Checks if all Layer Tasks that were selected by ON_TASK_INIT activation for invoking AfterTasksInitActions are finished with spawning.

Definition at line 699 of file SCR_GameModeSFManager.c.

DynamicDespawn()

protected void DynamicDespawn

(

)

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

Definition at line 950 of file SCR_GameModeSFManager.c.

DynamicSpawn()

protected void DynamicSpawn

(

)

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

Definition at line 930 of file SCR_GameModeSFManager.c.

Finish()

void Finish

(

)

Definition at line 339 of file SCR_GameModeSFManager.c.

GenerateSingleTask()

protected void GenerateSingleTask

(

int

index

)

Definition at line 742 of file SCR_GameModeSFManager.c.

GenerateTasks()

void GenerateTasks

(

)

Definition at line 565 of file SCR_GameModeSFManager.c.

GetAreas()

array<SCR_ScenarioFrameworkArea> GetAreas

(

)

Returns

Definition at line 282 of file SCR_GameModeSFManager.c.

GetIsMatchOver()

bool GetIsMatchOver

(

)

Returns

Definition at line 350 of file SCR_GameModeSFManager.c.

GetLastFinishedTask()

SCR_BaseTask GetLastFinishedTask

(

)

Returns

Definition at line 268 of file SCR_GameModeSFManager.c.

GetLastFinishedTaskLayer()

SCR_ScenarioFrameworkLayerBase GetLastFinishedTaskLayer

(

)

Returns

Definition at line 275 of file SCR_GameModeSFManager.c.

GetOnAllAreasInitiated()

ScriptInvoker GetOnAllAreasInitiated

(

)

Returns

Definition at line 357 of file SCR_GameModeSFManager.c.

GetOnTaskStateChanged()

ScriptInvoker GetOnTaskStateChanged

(

)

Returns

Definition at line 367 of file SCR_GameModeSFManager.c.

GetParentArea()

SCR_ScenarioFrameworkArea GetParentArea

(

IEntity

child

)

Get parent area the object is nested into

Parameters

[in]

child

Returns

Definition at line 813 of file SCR_GameModeSFManager.c.

IsMaster()

bool IsMaster

(

)

Returns

Definition at line 410 of file SCR_GameModeSFManager.c.

LoadHeaderSettings()

protected void LoadHeaderSettings

(

)

Definition at line 8 of file SCR_GameModeCombatOpsManager.c.

OnTaskCreated()

void OnTaskCreated

(

SCR_BaseTask

task

)

Parameters

[in]

task

Definition at line 289 of file SCR_GameModeSFManager.c.

OnTaskUpdate()

void OnTaskUpdate	(	SCR_BaseTask	task,
		SCR_ETaskEventMask	mask
	)

Parameters

[in]	task
[in]	mask

Definition at line 301 of file SCR_GameModeSFManager.c.

PlayIntroVoiceline()

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

Parameters

[in]	playerID
[in]	eventName
[in]	entityID

Definition at line 123 of file SCR_GameModeSFManager.c.

PlaySoundOnEntity()

void PlaySoundOnEntity	(	IEntity	entity,
		string	sSndName
	)

Parameters

[in]	entity
[in]	sSndName

Definition at line 104 of file SCR_GameModeSFManager.c.

PlaySoundOnEntityPosition()

void 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

Definition at line 248 of file SCR_GameModeSFManager.c.

PopUpMessage()

void PopUpMessage	(	string	sTitle,
		string	sSubtitle,
		FactionKey	factionKey = "",
		int	playerID = -1
	)

Parameters

[in]	sTitle
[in]	sSubtitle
[in]	factionKey
[in]	playerID

Definition at line 1037 of file SCR_GameModeSFManager.c.

PostInit()

protected void PostInit

(

)

Definition at line 499 of file SCR_GameModeSFManager.c.

PrepareAreaSpecificDynamicDespawn()

void PrepareAreaSpecificDynamicDespawn	(	SCR_ScenarioFrameworkArea	area,
		bool	staySpawned = false
	)

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

Parameters

[in]	area
[in]	staySpawned

Definition at line 836 of file SCR_GameModeSFManager.c.

PrepareDynamicDespawn()

protected void PrepareDynamicDespawn

(

)

Prepares dynamic spawn/despawn.

Definition at line 881 of file SCR_GameModeSFManager.c.

PrepareLayerTasksAfterInit()

protected void PrepareLayerTasksAfterInit

(

)

Prepares Layer Tasks that were selected by ON_TASK_INIT activation for invoking AfterTasksInitActions.

Definition at line 686 of file SCR_GameModeSFManager.c.

ProcessVoicelineEnumAndString()

void ProcessVoicelineEnumAndString	(	typename targetEnum	,
		string	targetString
	)

Definition at line 710 of file SCR_GameModeSFManager.c.

RegisterArea()

void RegisterArea

(

SCR_ScenarioFrameworkArea

area

)

Parameters

[in]

area

Definition at line 422 of file SCR_GameModeSFManager.c.

RemoveAreaSpecificDynamicDespawn()

void RemoveAreaSpecificDynamicDespawn	(	SCR_ScenarioFrameworkArea	area,
		bool	staySpawned = false
	)

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

Parameters

[in]	area
[in]	staySpawned

Definition at line 856 of file SCR_GameModeSFManager.c.

RpcDo_PlayIntroVoiceline()

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

Parameters

[in]	playerID
[in]	eventName
[in]	entityID

Definition at line 135 of file SCR_GameModeSFManager.c.

RpcDo_PlaySoundOnEntity()

void RpcDo_PlaySoundOnEntity	(	EntityID	pEntID,
		string	sSndName
	)

Parameters

[in]	pEntID
[in]	sSndName

Definition at line 84 of file SCR_GameModeSFManager.c.

RpcDo_PlaySoundOnEntityPosition()

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

Parameters

[in]	objectID	replication id of entity from which this sound event 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

Definition at line 226 of file SCR_GameModeSFManager.c.

RpcDo_PopUpMessage()

void RpcDo_PopUpMessage	(	string	sTitle,
		string	sSubtitle,
		FactionKey	factionKey,
		int	playerID
	)

Parameters

[in]	sTitle
[in]	sSubtitle
[in]	factionKey
[in]	playerID

Definition at line 1050 of file SCR_GameModeSFManager.c.

RpcDo_ShowHint()

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

Parameters

[in]	sTitle
[in]	sSubtitle
[in]	timeOut
[in]	factionKey
[in]	playerID

Definition at line 1008 of file SCR_GameModeSFManager.c.

RplLoad()

override bool RplLoad

(

ScriptBitReader

reader

)

Definition at line 982 of file SCR_GameModeSFManager.c.

SelectNearestAreaByTaskType()

SCR_ScenarioFrameworkArea SelectNearestAreaByTaskType

(

SCR_ESFTaskType

eTaskType

)

Parameters

[in]

eTaskType

Returns

Definition at line 379 of file SCR_GameModeSFManager.c.

SelectRandomAreaByTaskType()

SCR_ScenarioFrameworkArea SelectRandomAreaByTaskType

(

SCR_ESFTaskType

eTaskType

)

Parameters

[in]

eTaskType

Returns

Definition at line 784 of file SCR_GameModeSFManager.c.

SetMissionEndScreen()

void SetMissionEndScreen

(

EGameOverTypes

GameOverType

)

Parameters

[in]

GameOverType

Definition at line 332 of file SCR_GameModeSFManager.c.

ShowHint()

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

Parameters

[in]	sTitle
[in]	sSubtitle
[in]	timeOut
[in]	factionKey
[in]	playerID

Definition at line 994 of file SCR_GameModeSFManager.c.

SpawnRandomTask()

void SpawnRandomTask

(

)

Definition at line 507 of file SCR_GameModeSFManager.c.

Variable Documentation

CLEAR_AREA

SCR_GameModeSFManagerClass CLEAR_AREA = 0

CUSTOM1

SCR_GameModeSFManagerClass CUSTOM1 = 0

CUSTOM2

SCR_GameModeSFManagerClass CUSTOM2 = 0

CUSTOM3

SCR_GameModeSFManagerClass CUSTOM3 = 0

CUSTOM4

SCR_GameModeSFManagerClass CUSTOM4 = 0

DEFEND

SCR_GameModeSFManagerClass DEFEND = 0

DELIVER

SCR_GameModeSFManagerClass DELIVER = 0

DESTROY

SCR_GameModeSFManagerClass DESTROY = 0

EXTRACTION

SCR_GameModeSFManagerClass EXTRACTION = 0

KILL

SCR_GameModeSFManagerClass KILL = 0

LAST

SCR_GameModeSFManagerClass LAST = 0

m_aAfterTasksInitActions

protected ref array<ref SCR_ScenarioFrameworkActionBase> m_aAfterTasksInitActions

Definition at line 40 of file SCR_GameModeSFManager.c.

m_aAreas

ref array<SCR_ScenarioFrameworkArea> m_aAreas = {}

Definition at line 65 of file SCR_GameModeSFManager.c.

m_aAreasTasksToSpawn

ref array<string> m_aAreasTasksToSpawn = {}

Definition at line 70 of file SCR_GameModeSFManager.c.

m_aCoreAreas

protected ref array<string> m_aCoreAreas

Definition at line 43 of file SCR_GameModeSFManager.c.

m_aDebugAreas

protected ref array<ref SCR_ScenarioFrameworkDebugArea> m_aDebugAreas

Definition at line 46 of file SCR_GameModeSFManager.c.

m_aDespawnedAreas

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

Definition at line 76 of file SCR_GameModeSFManager.c.

m_aESFTaskTypeForRandomization

ref array<SCR_ESFTaskType> m_aESFTaskTypeForRandomization = {}

Definition at line 73 of file SCR_GameModeSFManager.c.

m_aESFTaskTypesAvailable

ref array<SCR_ESFTaskType> m_aESFTaskTypesAvailable = {}

Definition at line 72 of file SCR_GameModeSFManager.c.

m_aIntroVoicelineIndexes

ref array<int> m_aIntroVoicelineIndexes = {}

Definition at line 69 of file SCR_GameModeSFManager.c.

m_aLayersTaskToSpawn

ref array<string> m_aLayersTaskToSpawn = {}

Definition at line 71 of file SCR_GameModeSFManager.c.

m_aLayerTasksForRandomization

ref array<SCR_ScenarioFrameworkLayerTask> m_aLayerTasksForRandomization = {}

Definition at line 68 of file SCR_GameModeSFManager.c.

m_aLayerTasksToBeInitialized

ref array<SCR_ScenarioFrameworkLayerTask> m_aLayerTasksToBeInitialized = {}

Definition at line 67 of file SCR_GameModeSFManager.c.

m_aObservers

protected ref array<vector> m_aObservers = {}

Definition at line 77 of file SCR_GameModeSFManager.c.

m_aSelectedAreas

ref array<SCR_ScenarioFrameworkArea> m_aSelectedAreas = {}

Definition at line 66 of file SCR_GameModeSFManager.c.

m_aSpawnedAreas

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

Definition at line 75 of file SCR_GameModeSFManager.c.

m_aTaskTypesAvailable

protected ref array<ref SCR_ScenarioFrameworkTaskType> m_aTaskTypesAvailable

Definition at line 35 of file SCR_GameModeSFManager.c.

m_bDynamicDespawn

protected bool m_bDynamicDespawn

Definition at line 49 of file SCR_GameModeSFManager.c.

m_bMatchOver

protected bool m_bMatchOver

Definition at line 55 of file SCR_GameModeSFManager.c.

m_eGameOverType

EGameOverTypes m_eGameOverType = EGameOverTypes.COMBATPATROL_DRAW

Definition at line 63 of file SCR_GameModeSFManager.c.

m_iCurrentlySpawnedLayerTasks

protected int m_iCurrentlySpawnedLayerTasks

Definition at line 56 of file SCR_GameModeSFManager.c.

m_iMaxNumberOfTasks

protected int m_iMaxNumberOfTasks

Definition at line 37 of file SCR_GameModeSFManager.c.

m_iUpdateRate

protected int m_iUpdateRate

Definition at line 53 of file SCR_GameModeSFManager.c.

m_LastFinishedTask

protected SCR_BaseTask m_LastFinishedTask

Definition at line 62 of file SCR_GameModeSFManager.c.

m_LastFinishedTaskLayer

protected SCR_ScenarioFrameworkLayerBase m_LastFinishedTaskLayer

Definition at line 61 of file SCR_GameModeSFManager.c.

m_OnAllAreasInitiated

protected ref ScriptInvoker m_OnAllAreasInitiated

Definition at line 58 of file SCR_GameModeSFManager.c.

m_OnTaskStateChanged

protected ref ScriptInvoker m_OnTaskStateChanged

Definition at line 59 of file SCR_GameModeSFManager.c.

NONE

SCR_GameModeSFManagerClass NONE = 0

ON_AREA_TRIGGER_ACTIVATION

SCR_GameModeSFManagerClass ON_AREA_TRIGGER_ACTIVATION = 0

ON_INIT

SCR_GameModeSFManagerClass ON_INIT = 0

ON_TASKS_INIT

SCR_GameModeSFManagerClass ON_TASKS_INIT = 0

ON_TRIGGER_ACTIVATION

SCR_GameModeSFManagerClass ON_TRIGGER_ACTIVATION = 0

SAME_AS_PARENT

SCR_GameModeSFManagerClass SAME_AS_PARENT = 0