Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_BaseGameOverScreenInfo Class Reference
Inheritance diagram for SCR_BaseGameOverScreenInfo:
SCR_DeathMatchGameOverScreenInfo SCR_FactionGameOverScreenInfo SCR_RandomMessageGameOverScreenInfo SCR_EditorFactionGameOverScreenInfo SCR_FactionVictoryGameOverScreenInfo

Protected Member Functions

ResourceName GetBaseGameOverScreenOverwrite ()
 Returns whether game over layout should overwrite whole gameover screen.
bool PauseGameOnGameOverScreen ()
 Returns whether game should be paused with Game over screen.
EGameOverTypes GetInfoId ()
ResourceName GetGameOverContentLayout ()
bool HasOptionalParams ()
SCR_BaseGameOverScreenInfoOptional GetOptionalParams ()
SCR_BaseGameOverScreenInfoEditor GetEditorOptionalParams ()
string GetTitle (Faction factionPlayer, array< Faction > factionsOther)
string GetTitle (int playerId, array< int > otherPlayerIds)
string GetSubtitle (Faction factionPlayer, array< Faction > factionsOther)
string GetSubtitle (int playerId, array< int > otherPlayerIds)
ResourceName GetImage (Faction factionPlayer, array< Faction > factionsOther)
ResourceName GetImage (int playerId, array< int > otherPlayerIds)
ResourceName GetIcon (Faction factionPlayer, array< Faction > factionsOther)
ResourceName GetIcon (int playerId, array< int > otherPlayerIds)
Color GetVignetteColor (Faction factionPlayer, array< Faction > factionsOther)
Color GetVignetteColor (int playerId, array< int > otherPlayerIds)
string GetDebriefing (Faction factionPlayer, array< Faction > factionsOther)
string GetDebriefing (int playerId, array< int > otherPlayerIds)
string GetOneShotAudio (Faction factionPlayer, array< Faction > factionsOther)
string GetOneShotAudio (int playerId, array< int > otherPlayerIds)
string GetTitleParam (Faction factionPlayer, array< Faction > factionsOther)
string GetTitleParam (int playerId, array< int > otherPlayerIds)
string GetSubtitleParam (Faction factionPlayer, array< Faction > factionsOther)
string GetSubtitleParam (int playerId, array< int > otherPlayerIds)
string GetDebriefingParam (Faction factionPlayer, array< Faction > factionsOther)
string GetDebriefingParam (int playerId, array< int > otherPlayerIds)
void GameOverUICustomization (SCR_GameOverScreenUIComponent gameOverUI, Faction factionPlayer, array< Faction > factionsOther)
void GameOverUICustomization (SCR_GameOverScreenUIComponent gameOverUI, int playerId, array< int > otherPlayerIds)

Protected Attributes

EGameOverTypes m_GameOverScreenId
ResourceName m_GameOverContentLayout
ResourceName m_sBaseGameOverScreenOverwrite
ref SCR_BaseGameOverScreenInfoOptional m_OptionalParams
ref SCR_BaseGameOverScreenInfoEditor m_OptionalEditorParams
bool m_bPauseGameOnGameOverScreen

Detailed Description

Definition at line 2 of file SCR_BaseGameOverScreenInfo.c.

Member Function Documentation

◆ GameOverUICustomization() [1/2]

void SCR_BaseGameOverScreenInfo::GameOverUICustomization ( SCR_GameOverScreenUIComponent gameOverUI,
Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

A functioned called when Game over UI is called when gameover screen is called for aditional logic to set and change

Parameters
gameOverUIGameOver screen UI reference
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)

Definition at line 362 of file SCR_BaseGameOverScreenInfo.c.

◆ GameOverUICustomization() [2/2]

void SCR_BaseGameOverScreenInfo::GameOverUICustomization ( SCR_GameOverScreenUIComponent gameOverUI,
int playerId,
array< int > otherPlayerIds )
inlineprotected

A functioned called when Game over UI is called when gameover screen is called for aditional logic to set and change

Parameters
gameOverUIGameOver screen UI reference
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)

Definition at line 373 of file SCR_BaseGameOverScreenInfo.c.

◆ GetBaseGameOverScreenOverwrite()

ResourceName SCR_BaseGameOverScreenInfo::GetBaseGameOverScreenOverwrite ( )
inlineprotected

Returns whether game over layout should overwrite whole gameover screen.

Definition at line 24 of file SCR_BaseGameOverScreenInfo.c.

◆ GetDebriefing() [1/2]

string SCR_BaseGameOverScreenInfo::GetDebriefing ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get Debrief from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
string m_OptionalParams.m_sDebriefing

Definition at line 222 of file SCR_BaseGameOverScreenInfo.c.

◆ GetDebriefing() [2/2]

string SCR_BaseGameOverScreenInfo::GetDebriefing ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get Debrief from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
string m_OptionalParams.m_sDebriefing

Definition at line 236 of file SCR_BaseGameOverScreenInfo.c.

◆ GetDebriefingParam() [1/2]

string SCR_BaseGameOverScreenInfo::GetDebriefingParam ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get debrief param from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
string m_OptionalParams.m_sDebriefingParam

Definition at line 334 of file SCR_BaseGameOverScreenInfo.c.

◆ GetDebriefingParam() [2/2]

string SCR_BaseGameOverScreenInfo::GetDebriefingParam ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get debrief param from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
string m_OptionalParams.m_sDebriefingParam

Definition at line 348 of file SCR_BaseGameOverScreenInfo.c.

◆ GetEditorOptionalParams()

SCR_BaseGameOverScreenInfoEditor SCR_BaseGameOverScreenInfo::GetEditorOptionalParams ( )
inlineprotected

Returns m_OptionalEditorParams with params specific for the editor

Returns
m_OptionalEditorParams

Definition at line 76 of file SCR_BaseGameOverScreenInfo.c.

◆ GetGameOverContentLayout()

ResourceName SCR_BaseGameOverScreenInfo::GetGameOverContentLayout ( )
inlineprotected

Get the game over layout that is shown within the gameover screen

Returns
ResourceName m_GameOverContentLayout layout

Definition at line 49 of file SCR_BaseGameOverScreenInfo.c.

◆ GetIcon() [1/2]

ResourceName SCR_BaseGameOverScreenInfo::GetIcon ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get icon from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
ResourceName icon path

Definition at line 170 of file SCR_BaseGameOverScreenInfo.c.

◆ GetIcon() [2/2]

ResourceName SCR_BaseGameOverScreenInfo::GetIcon ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get icon from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
ResourceName icon path

Definition at line 184 of file SCR_BaseGameOverScreenInfo.c.

◆ GetImage() [1/2]

ResourceName SCR_BaseGameOverScreenInfo::GetImage ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get image from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
ResourceName image path

Definition at line 142 of file SCR_BaseGameOverScreenInfo.c.

◆ GetImage() [2/2]

ResourceName SCR_BaseGameOverScreenInfo::GetImage ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get image from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
ResourceName image path

Definition at line 156 of file SCR_BaseGameOverScreenInfo.c.

◆ GetInfoId()

EGameOverTypes SCR_BaseGameOverScreenInfo::GetInfoId ( )
inlineprotected

Returns the state id

Returns
string m_sGameEndStateId

Definition at line 40 of file SCR_BaseGameOverScreenInfo.c.

◆ GetOneShotAudio() [1/2]

string SCR_BaseGameOverScreenInfo::GetOneShotAudio ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get One shot audio from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
string m_OptionalParams.m_sAudioOneShot

Definition at line 250 of file SCR_BaseGameOverScreenInfo.c.

◆ GetOneShotAudio() [2/2]

string SCR_BaseGameOverScreenInfo::GetOneShotAudio ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get One shot audio from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
string m_OptionalParams.m_sAudioOneShot

Definition at line 264 of file SCR_BaseGameOverScreenInfo.c.

◆ GetOptionalParams()

SCR_BaseGameOverScreenInfoOptional SCR_BaseGameOverScreenInfo::GetOptionalParams ( )
inlineprotected

Returns m_OptionalParams with params to be displayed in the game over screen

Returns
m_OptionalParams

Definition at line 67 of file SCR_BaseGameOverScreenInfo.c.

◆ GetSubtitle() [1/2]

string SCR_BaseGameOverScreenInfo::GetSubtitle ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get subtitle from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
string m_OptionalParams.m_sSubtitle

Definition at line 114 of file SCR_BaseGameOverScreenInfo.c.

◆ GetSubtitle() [2/2]

string SCR_BaseGameOverScreenInfo::GetSubtitle ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get subtitle from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
string m_OptionalParams.m_sSubtitle

Definition at line 128 of file SCR_BaseGameOverScreenInfo.c.

◆ GetSubtitleParam() [1/2]

string SCR_BaseGameOverScreenInfo::GetSubtitleParam ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get subtitle param from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
string m_OptionalParams.m_sSubtitleParam

Definition at line 306 of file SCR_BaseGameOverScreenInfo.c.

◆ GetSubtitleParam() [2/2]

string SCR_BaseGameOverScreenInfo::GetSubtitleParam ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get subtitle param from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
string m_OptionalParams.m_sSubtitleParam

Definition at line 320 of file SCR_BaseGameOverScreenInfo.c.

◆ GetTitle() [1/2]

string SCR_BaseGameOverScreenInfo::GetTitle ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get title

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
string m_sTitle

Definition at line 87 of file SCR_BaseGameOverScreenInfo.c.

◆ GetTitle() [2/2]

string SCR_BaseGameOverScreenInfo::GetTitle ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get title

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
string m_sTitle

Definition at line 100 of file SCR_BaseGameOverScreenInfo.c.

◆ GetTitleParam() [1/2]

string SCR_BaseGameOverScreenInfo::GetTitleParam ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get title param from m_OptionalParams

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
string m_OptionalParams.m_sTitleParam

Definition at line 278 of file SCR_BaseGameOverScreenInfo.c.

◆ GetTitleParam() [2/2]

string SCR_BaseGameOverScreenInfo::GetTitleParam ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get title param from m_OptionalParams

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
string m_OptionalParams.m_sTitleParam

Definition at line 292 of file SCR_BaseGameOverScreenInfo.c.

◆ GetVignetteColor() [1/2]

Color SCR_BaseGameOverScreenInfo::GetVignetteColor ( Faction factionPlayer,
array< Faction > factionsOther )
inlineprotected

Get Vignette color by default this is null The vingett color is to add color to the end screen

Parameters
factionPlayerfaction of the player
factionsOthersecondary factions (Generally this is the winning factions)
Returns
Color vignette color

Definition at line 199 of file SCR_BaseGameOverScreenInfo.c.

◆ GetVignetteColor() [2/2]

Color SCR_BaseGameOverScreenInfo::GetVignetteColor ( int playerId,
array< int > otherPlayerIds )
inlineprotected

Get Vignette color by default this is null The vingett color is to add color to the end screen

Parameters
playerIdid of the player
otherPlayerIdsarray of secondary player ids (Generally this is the winning players)
Returns
Color vignette color

Definition at line 211 of file SCR_BaseGameOverScreenInfo.c.

◆ HasOptionalParams()

bool SCR_BaseGameOverScreenInfo::HasOptionalParams ( )
inlineprotected

Returns if m_OptionalParams is null or not

Returns
bool m_OptionalParams is null or not

Definition at line 58 of file SCR_BaseGameOverScreenInfo.c.

◆ PauseGameOnGameOverScreen()

bool SCR_BaseGameOverScreenInfo::PauseGameOnGameOverScreen ( )
inlineprotected

Returns whether game should be paused with Game over screen.

Definition at line 31 of file SCR_BaseGameOverScreenInfo.c.

Member Data Documentation

◆ m_bPauseGameOnGameOverScreen

bool SCR_BaseGameOverScreenInfo::m_bPauseGameOnGameOverScreen
protected

Definition at line 20 of file SCR_BaseGameOverScreenInfo.c.

◆ m_GameOverContentLayout

ResourceName SCR_BaseGameOverScreenInfo::m_GameOverContentLayout
protected

Definition at line 8 of file SCR_BaseGameOverScreenInfo.c.

◆ m_GameOverScreenId

EGameOverTypes SCR_BaseGameOverScreenInfo::m_GameOverScreenId
protected

Definition at line 5 of file SCR_BaseGameOverScreenInfo.c.

◆ m_OptionalEditorParams

ref SCR_BaseGameOverScreenInfoEditor SCR_BaseGameOverScreenInfo::m_OptionalEditorParams
protected

Definition at line 17 of file SCR_BaseGameOverScreenInfo.c.

◆ m_OptionalParams

ref SCR_BaseGameOverScreenInfoOptional SCR_BaseGameOverScreenInfo::m_OptionalParams
protected

Definition at line 14 of file SCR_BaseGameOverScreenInfo.c.

◆ m_sBaseGameOverScreenOverwrite

ResourceName SCR_BaseGameOverScreenInfo::m_sBaseGameOverScreenOverwrite
protected

Definition at line 11 of file SCR_BaseGameOverScreenInfo.c.

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