Inheritance diagram for SCR_RespawnBriefingComponent:

Public Member Functions
override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

void	RewriteEntry_SA (FactionKey factionKey, int entryID, string newText, array< string > param1)

void	RpcDo_RewriteEntry (FactionKey factionKey, int entryID, string newText, array< string > param1)

void	RewriteEntryMain (FactionKey factionKey, int entryID, string newText, array< string > param1)

void	RewriteEntry (FactionKey factionKey, int entryID, string newText, array< string > param1)

array< string >	GetBriefingStringParamByID (int targetID)

SCR_JournalSetupConfig	GetJournalSetup ()

void	ResetConfig ()

bool	LoadJournalConfig ()

SCR_UIInfo	GetInfo ()

ResourceName	GetSimpleBriefingBackground ()

ResourceName	GetJournalConfigPath ()

int	GetGameModeHints (out array< ref SCR_UIInfo > hints)

int	GetWinConditions (out array< ref SCR_BriefingVictoryCondition > conditions)

void	SetBriefingShown (bool shown=true)

bool	GetWasBriefingShown ()

Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()

void	OnGameEnd ()
	Called on all machines when the world ends.

void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.

void	OnGameModeStart ()
	Called on every machine when game mode starts.

void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.

void	OnPlayerConnected (int playerId)
	Called after a player is connected.

void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.

void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.

void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.

void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).

void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).

void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.

void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.

bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)

void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.

void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.

void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.

void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.

void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.

void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)

void	HandleOnLoadoutAssigned (int playerID, SCR_BasePlayerLoadout assignedLoadout)
	What happens when a player is assigned a loadout.

void	HandleOnFactionAssigned (int playerID, Faction assignedFaction)
	What happens when a player is assigned a faction.

void	HandleOnSpawnPointAssigned (int playerID, SCR_SpawnPoint spawnPoint)
	What happens when a player is assigned a spawn point.

void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.

void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.

void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.

void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_RespawnBriefingComponent	GetInstance ()

Protected Member Functions
void	OnLanguageChanged (SCR_GameplaySettingsSubMenu menu)

Protected Attributes
ResourceName	m_sJournalConfigPath

ref SCR_JournalSetupConfig	m_JournalConfig

ref SCR_UIInfo	m_Info

ResourceName	m_SimpleBriefingBackground

ref array< ref SCR_UIInfo >	m_aGameModeHints

ref array< ref SCR_BriefingVictoryCondition >	m_aWinConditions

bool	m_bWasShown = false

ref map< int, ref array< string > >	m_BriefingInfo = new map<int, ref array<string>>()

Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Member Function Documentation

◆ GetBriefingStringParamByID()

array< string > SCR_RespawnBriefingComponent.GetBriefingStringParamByID ( int targetID )

Parameters

[in] targetID

Returns

◆ GetGameModeHints()

int SCR_RespawnBriefingComponent.GetGameModeHints ( out array< ref SCR_UIInfo > hints )

Parameters

[out] hints

Returns

◆ GetInfo()

SCR_UIInfo SCR_RespawnBriefingComponent.GetInfo ( )

Returns: Briefing UI info

Implemented in SCR_EditorRespawnBriefingComponent.

◆ GetInstance()

static SCR_RespawnBriefingComponent SCR_RespawnBriefingComponent.GetInstance ( )

static

Returns: Local instance of the briefing component.

◆ GetJournalConfigPath()

ResourceName SCR_RespawnBriefingComponent.GetJournalConfigPath ( )

Returns

◆ GetJournalSetup()

SCR_JournalSetupConfig SCR_RespawnBriefingComponent.GetJournalSetup ( )

Returns

◆ GetSimpleBriefingBackground()

ResourceName SCR_RespawnBriefingComponent.GetSimpleBriefingBackground ( )

Returns: Simple briefing background image

◆ GetWasBriefingShown()

bool SCR_RespawnBriefingComponent.GetWasBriefingShown ( )

Returns

◆ GetWinConditions()

int SCR_RespawnBriefingComponent.GetWinConditions ( out array< ref SCR_BriefingVictoryCondition > conditions )

Parameters

[out] conditions

Returns

◆ LoadJournalConfig()

bool SCR_RespawnBriefingComponent.LoadJournalConfig ( )

Returns

◆ OnLanguageChanged()

void SCR_RespawnBriefingComponent.OnLanguageChanged ( SCR_GameplaySettingsSubMenu menu )

protected

◆ ResetConfig()

void SCR_RespawnBriefingComponent.ResetConfig ( )

◆ RewriteEntry()

void SCR_RespawnBriefingComponent.RewriteEntry	(	FactionKey	factionKey,
		int	entryID,
		string	newText,
		array< string >	param1 )

Parameters

[in]	factionKey
[in]	entryID
[in]	newText
[in]	param1

◆ RewriteEntry_SA()

void SCR_RespawnBriefingComponent.RewriteEntry_SA	(	FactionKey	factionKey,
		int	entryID,
		string	newText,
		array< string >	param1 )

Parameters

[in]	factionKey
[in]	entryID
[in]	newText
[in]	param1

◆ RewriteEntryMain()

void SCR_RespawnBriefingComponent.RewriteEntryMain	(	FactionKey	factionKey,
		int	entryID,
		string	newText,
		array< string >	param1 )

Parameters

[in]	factionKey
[in]	entryID
[in]	newText
[in]	param1

◆ RpcDo_RewriteEntry()

void SCR_RespawnBriefingComponent.RpcDo_RewriteEntry	(	FactionKey	factionKey,
		int	entryID,
		string	newText,
		array< string >	param1 )

Parameters

[in]	factionKey
[in]	entryID
[in]	newText
[in]	param1

◆ RplLoad()

override bool SCR_RespawnBriefingComponent.RplLoad ( ScriptBitReader reader )

◆ RplSave()

override bool SCR_RespawnBriefingComponent.RplSave ( ScriptBitWriter writer )

◆ SetBriefingShown()

void SCR_RespawnBriefingComponent.SetBriefingShown ( bool shown = true )

Parameters

[in] shown

Member Data Documentation

◆ m_aGameModeHints

ref array<ref SCR_UIInfo> SCR_RespawnBriefingComponent.m_aGameModeHints

protected

◆ m_aWinConditions

ref array<ref SCR_BriefingVictoryCondition> SCR_RespawnBriefingComponent.m_aWinConditions

protected

◆ m_BriefingInfo

ref map<int, ref array<string> > SCR_RespawnBriefingComponent.m_BriefingInfo = new map<int, ref array<string>>()

protected

◆ m_bWasShown

bool SCR_RespawnBriefingComponent.m_bWasShown = false

protected

◆ m_Info

ref SCR_UIInfo SCR_RespawnBriefingComponent.m_Info

protected

◆ m_JournalConfig

ref SCR_JournalSetupConfig SCR_RespawnBriefingComponent.m_JournalConfig

protected

◆ m_SimpleBriefingBackground

ResourceName SCR_RespawnBriefingComponent.m_SimpleBriefingBackground

protected

◆ m_sJournalConfigPath

ResourceName SCR_RespawnBriefingComponent.m_sJournalConfigPath

protected

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

Game/GameMode/Respawn/SCR_RespawnBriefingComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ GetBriefingStringParamByID()

◆ GetGameModeHints()

◆ GetInfo()

◆ GetInstance()

◆ GetJournalConfigPath()

◆ GetJournalSetup()

◆ GetSimpleBriefingBackground()

◆ GetWasBriefingShown()

◆ GetWinConditions()

◆ LoadJournalConfig()

◆ OnLanguageChanged()

◆ ResetConfig()

◆ RewriteEntry()

◆ RewriteEntry_SA()

◆ RewriteEntryMain()

◆ RpcDo_RewriteEntry()

◆ RplLoad()

◆ RplSave()

◆ SetBriefingShown()

Member Data Documentation

◆ m_aGameModeHints

◆ m_aWinConditions

◆ m_BriefingInfo

◆ m_bWasShown

◆ m_Info

◆ m_JournalConfig

◆ m_SimpleBriefingBackground

◆ m_sJournalConfigPath