SCR_BaseGameOverScreenInfo Interface Reference

Inheritance diagram for SCR_BaseGameOverScreenInfo:

Public 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 ()
	Returns the state id.
ResourceName	GetGameOverContentLayout ()
	Get the game over layout that is shown within the gameover screen.
bool	HasOptionalParams ()
	Returns if m_OptionalParams is null or not.
SCR_BaseGameOverScreenInfoOptional	GetOptionalParams ()
	Returns m_OptionalParams with params to be displayed in the game over screen.
SCR_BaseGameOverScreenInfoEditor	GetEditorOptionalParams ()
	Returns m_OptionalEditorParams with params specific for the editor.
string	GetTitle (Faction factionPlayer, array< Faction > factionsOther)
	Get title.
string	GetTitle (int playerId, array< int > otherPlayerIds)
	Get title.
string	GetSubtitle (Faction factionPlayer, array< Faction > factionsOther)
	Get subtitle from m_OptionalParams.
string	GetSubtitle (int playerId, array< int > otherPlayerIds)
	Get subtitle from m_OptionalParams.
ResourceName	GetImage (Faction factionPlayer, array< Faction > factionsOther)
	Get image from m_OptionalParams.
ResourceName	GetImage (int playerId, array< int > otherPlayerIds)
	Get image from m_OptionalParams.
ResourceName	GetIcon (Faction factionPlayer, array< Faction > factionsOther)
	Get icon from m_OptionalParams.
ResourceName	GetIcon (int playerId, array< int > otherPlayerIds)
	Get icon from m_OptionalParams.
Color	GetVignetteColor (Faction factionPlayer, array< Faction > factionsOther)
	Get Vignette color by default this is null The vingett color is to add color to the end screen.
Color	GetVignetteColor (int playerId, array< int > otherPlayerIds)
	Get Vignette color by default this is null The vingett color is to add color to the end screen.
string	GetDebriefing (Faction factionPlayer, array< Faction > factionsOther)
	Get Debrief from m_OptionalParams.
string	GetDebriefing (int playerId, array< int > otherPlayerIds)
	Get Debrief from m_OptionalParams.
string	GetOneShotAudio (Faction factionPlayer, array< Faction > factionsOther)
	Get One shot audio from m_OptionalParams.
string	GetOneShotAudio (int playerId, array< int > otherPlayerIds)
	Get One shot audio from m_OptionalParams.
string	GetTitleParam (Faction factionPlayer, array< Faction > factionsOther)
	Get title param from m_OptionalParams.
string	GetTitleParam (int playerId, array< int > otherPlayerIds)
	Get title param from m_OptionalParams.
string	GetSubtitleParam (Faction factionPlayer, array< Faction > factionsOther)
	Get subtitle param from m_OptionalParams.
string	GetSubtitleParam (int playerId, array< int > otherPlayerIds)
	Get subtitle param from m_OptionalParams.
string	GetDebriefingParam (Faction factionPlayer, array< Faction > factionsOther)
	Get debrief param from m_OptionalParams.
string	GetDebriefingParam (int playerId, array< int > otherPlayerIds)
	Get debrief param from m_OptionalParams.
void	GameOverUICustomization (SCR_GameOverScreenUIComponent gameOverUI, Faction factionPlayer, array< Faction > factionsOther)
	A functioned called when Game over UI is called when gameover screen is called for aditional logic to set and change.
void	GameOverUICustomization (SCR_GameOverScreenUIComponent gameOverUI, int playerId, array< int > otherPlayerIds)
	A functioned called when Game over UI is called when gameover screen is called for aditional logic to set and change.

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

Member Function Documentation

GameOverUICustomization() [1/2]

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

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

Parameters

gameOverUI	GameOver screen UI reference
factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

GameOverUICustomization() [2/2]

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

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

Parameters

gameOverUI	GameOver screen UI reference
playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

GetBaseGameOverScreenOverwrite()

ResourceName SCR_BaseGameOverScreenInfo.GetBaseGameOverScreenOverwrite

(

)

Returns whether game over layout should overwrite whole gameover screen.

GetDebriefing() [1/2]

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

Get Debrief from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

string m_OptionalParams.m_sDebriefing

GetDebriefing() [2/2]

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

Get Debrief from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

string m_OptionalParams.m_sDebriefing

GetDebriefingParam() [1/2]

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

Get debrief param from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

string m_OptionalParams.m_sDebriefingParam

GetDebriefingParam() [2/2]

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

Get debrief param from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

string m_OptionalParams.m_sDebriefingParam

GetEditorOptionalParams()

SCR_BaseGameOverScreenInfoEditor SCR_BaseGameOverScreenInfo.GetEditorOptionalParams

(

)

Returns m_OptionalEditorParams with params specific for the editor.

Returns

m_OptionalEditorParams

GetGameOverContentLayout()

ResourceName SCR_BaseGameOverScreenInfo.GetGameOverContentLayout

(

)

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

Returns

ResourceName m_GameOverContentLayout layout

GetIcon() [1/2]

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

Get icon from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

ResourceName icon path

Implemented in SCR_FactionGameOverScreenInfo.

GetIcon() [2/2]

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

Get icon from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

ResourceName icon path

GetImage() [1/2]

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

Get image from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

ResourceName image path

Implemented in SCR_FactionGameOverScreenInfo.

GetImage() [2/2]

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

Get image from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

ResourceName image path

GetInfoId()

EGameOverTypes SCR_BaseGameOverScreenInfo.GetInfoId

(

)

Returns the state id.

Returns

string m_sGameEndStateId

GetOneShotAudio() [1/2]

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

Get One shot audio from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

string m_OptionalParams.m_sAudioOneShot

GetOneShotAudio() [2/2]

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

Get One shot audio from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

string m_OptionalParams.m_sAudioOneShot

GetOptionalParams()

SCR_BaseGameOverScreenInfoOptional SCR_BaseGameOverScreenInfo.GetOptionalParams

(

)

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

Returns

m_OptionalParams

GetSubtitle() [1/2]

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

Get subtitle from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

string m_OptionalParams.m_sSubtitle

Implemented in SCR_EditorFactionGameOverScreenInfo, and SCR_RandomMessageGameOverScreenInfo.

GetSubtitle() [2/2]

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

Get subtitle from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

string m_OptionalParams.m_sSubtitle

Implemented in SCR_RandomMessageGameOverScreenInfo.

GetSubtitleParam() [1/2]

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

Get subtitle param from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

string m_OptionalParams.m_sSubtitleParam

Implemented in SCR_EditorFactionGameOverScreenInfo, and SCR_FactionGameOverScreenInfo.

GetSubtitleParam() [2/2]

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

Get subtitle param from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

string m_OptionalParams.m_sSubtitleParam

Implemented in SCR_DeathMatchGameOverScreenInfo.

GetTitle() [1/2]

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

Get title.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

string m_sTitle

GetTitle() [2/2]

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

Get title.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

string m_sTitle

GetTitleParam() [1/2]

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

Get title param from m_OptionalParams.

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

string m_OptionalParams.m_sTitleParam

GetTitleParam() [2/2]

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

Get title param from m_OptionalParams.

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

string m_OptionalParams.m_sTitleParam

GetVignetteColor() [1/2]

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

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

Parameters

factionPlayer	faction of the player
factionsOther	secondary factions (Generally this is the winning factions)

Returns

Color vignette color

Implemented in SCR_FactionVictoryGameOverScreenInfo.

GetVignetteColor() [2/2]

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

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

Parameters

playerId	id of the player
otherPlayerIds	array of secondary player ids (Generally this is the winning players)

Returns

Color vignette color

HasOptionalParams()

bool SCR_BaseGameOverScreenInfo.HasOptionalParams

(

)

Returns if m_OptionalParams is null or not.

Returns

bool m_OptionalParams is null or not

PauseGameOnGameOverScreen()

bool SCR_BaseGameOverScreenInfo.PauseGameOnGameOverScreen

(

)

Returns whether game should be paused with Game over screen.

Member Data Documentation

m_bPauseGameOnGameOverScreen

bool SCR_BaseGameOverScreenInfo.m_bPauseGameOnGameOverScreen

protected

m_GameOverContentLayout

ResourceName SCR_BaseGameOverScreenInfo.m_GameOverContentLayout

protected

m_GameOverScreenId

EGameOverTypes SCR_BaseGameOverScreenInfo.m_GameOverScreenId

protected

m_OptionalEditorParams

ref SCR_BaseGameOverScreenInfoEditor SCR_BaseGameOverScreenInfo.m_OptionalEditorParams

protected

m_OptionalParams

ref SCR_BaseGameOverScreenInfoOptional SCR_BaseGameOverScreenInfo.m_OptionalParams

protected

m_sBaseGameOverScreenOverwrite

ResourceName SCR_BaseGameOverScreenInfo.m_sBaseGameOverScreenOverwrite

protected

---

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

• Game/GameOverScreen/SCR_BaseGameOverScreenInfo.c