SCR_EditorFactionGameOverScreenInfo Interface Reference

Inheritance diagram for SCR_EditorFactionGameOverScreenInfo:

Public Member Functions
override string	GetSubtitle (Faction factionPlayer, array< Faction > factionsOther)
	Get subtitle from m_OptionalParams.
override string	GetSubtitleParam (Faction factionPlayer, array< Faction > factionsOther)
	Get subtitle param from m_OptionalParams.
Public Member Functions inherited from SCR_FactionGameOverScreenInfo
override ResourceName	GetImage (Faction factionPlayer, array< Faction > factionsOther)
	Get image from m_OptionalParams.
override ResourceName	GetIcon (Faction factionPlayer, array< Faction > factionsOther)
	Get icon from m_OptionalParams.
Public Member Functions inherited from SCR_BaseGameOverScreenInfo
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 (int playerId, array< int > otherPlayerIds)
	Get subtitle from m_OptionalParams.
ResourceName	GetImage (int playerId, array< int > otherPlayerIds)
	Get image 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 (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
LocalizedString	m_sMultiFactionsSubtiteText
Protected Attributes inherited from SCR_FactionGameOverScreenInfo
bool	m_bGetWinningFactionImage
bool	m_bGetWinningSubtitleParam
Protected Attributes inherited from SCR_BaseGameOverScreenInfo
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

GetSubtitle()

override string SCR_EditorFactionGameOverScreenInfo.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

Implements SCR_BaseGameOverScreenInfo.

GetSubtitleParam()

override string SCR_EditorFactionGameOverScreenInfo.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

Implements SCR_FactionGameOverScreenInfo.

Member Data Documentation

m_sMultiFactionsSubtiteText

LocalizedString SCR_EditorFactionGameOverScreenInfo.m_sMultiFactionsSubtiteText

protected

---

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

• Game/GameOverScreen/SCR_EditorFactionGameOverScreenInfo.c