Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_GameOverScreenManagerComponent.c File Reference

Go to the source code of this file.

Classes

class  SCR_GameOverScreenManagerComponentClass
 Handles the showing of end screen and has a config with gameover screens. More...
class  SCR_GameOverScreenUIContentData

Functions

SCR_GameOverScreenManagerComponentClass SCR_BaseGameModeComponentClass Attribute ()] protected ref SCR_GameOverScreenConfig m_GameOverScreenConfig
SCR_GameOverScreenConfig GetGameOverConfig ()
void SetGameOverScreenOverWrite (ResourceName overWriteLayout)
void StartEndGameFade ()
void OnEndScreenFadeDone (SCR_FadeUIComponent fadeComponent, bool isFadeIn)
SCR_GameOverScreenUIComponent ShowGameOverScreen (SCR_GameModeEndData endData=null)
void SetGameOverVariables (SCR_GameModeEndData endData=null)
EGameOverTypes GetGameOverType (int endReason, int playerId, array< int > winningPlayers, Faction factionPlayer, array< Faction > factionsVictor, bool isFactionVictory)
EGameOverTypes GetCurrentGameOverType ()
SCR_GameOverScreenUIComponent OpenGameOverScreen (ResourceName contentLayout, SCR_BaseGameOverScreenInfo gameOverInfo, SCR_GameModeEndData endData, LocalizedString title=string.Empty, LocalizedString subtitle=string.Empty, LocalizedString debriefing=string.Empty, ResourceName imageTexture=ResourceName.Empty, ResourceName icon=ResourceName.Empty, Color vignetteColor=null, string titleParam=string.Empty, string subtitleParam=string.Empty, string debriefingParam=string.Empty)
void OnEditorEndGameApplyDelayDone ()
void SetEditorGameOverType (EGameOverTypes gameOverType)
void SetEditorGameOverFactions (notnull array< int > factions)
override void OnGameModeEnd (SCR_GameModeEndData data)
void OnInitDelayedEndGame ()
override void OnPostInit (IEntity owner)
 Editable Mine.

Variables

float m_fShowEndscreenDelay
ResourceName m_sGameOverScreenBasePrefab
ResourceName m_sGameOverScreenOverwritePrefab
bool m_bListeningToEditorCalledEndGame = false
EGameOverTypes m_iEditorSetGameOverType
ref array< intm_aEditorSetFactions = {}
EGameOverTypes m_iEndGameType = EGameOverTypes.UNKNOWN
bool m_bIsFactionVictory = false
Faction m_FactionPlayer = null
int m_iPlayerId = -1
int m_iEndReason = 0
ref array< Factionm_aWinningFactions = {}
ref array< intm_aWinningPlayers = {}
bool m_bIsPlayingGameOverAudio = false
Widget m_EndScreenFade

Function Documentation

◆ GetCurrentGameOverType()

EGameOverTypes GetCurrentGameOverType ( )
protected

This will only return the valid gameover type once game over is called!

Returns
GameOver Type

Definition at line 420 of file SCR_GameOverScreenManagerComponent.c.

◆ GetGameOverConfig()

SCR_GameOverScreenConfig GetGameOverConfig ( )
protected
Returns
GameoverScreen Config

Definition at line 41 of file SCR_GameOverScreenManagerComponent.c.

◆ GetGameOverType()

EGameOverTypes GetGameOverType ( int endReason,
int playerId,
array< int > winningPlayers,
Faction factionPlayer,
array< Faction > factionsVictor,
bool isFactionVictory )
protected

This method checks if the player is part of the winning faction (if any), if it is the winning player (if any) and return the correct GameOverType (Eg: Won, lost ect)

Parameters
[in]endReason
[in]playerId
[in]winningPlayers
[in]factionPlayer
[in]factionsVictor
[in]isFactionVictory
Returns

Definition at line 320 of file SCR_GameOverScreenManagerComponent.c.

◆ OnEditorEndGameApplyDelayDone()

void OnEditorEndGameApplyDelayDone ( )
protected

Definition at line 470 of file SCR_GameOverScreenManagerComponent.c.

◆ OnEndScreenFadeDone()

void OnEndScreenFadeDone ( SCR_FadeUIComponent fadeComponent,
bool isFadeIn )
protected

End screen fade is done show gameover dialog when delay is done

Parameters
[in]fadeComponent
[in]isFadeIn

Definition at line 121 of file SCR_GameOverScreenManagerComponent.c.

◆ OnGameModeEnd()

override void OnGameModeEnd ( SCR_GameModeEndData data)
protected

Called when game mode ends.

Parameters
[in]dataEnd game data with game logic.

Definition at line 549 of file SCR_GameOverScreenManagerComponent.c.

◆ OnInitDelayedEndGame()

void OnInitDelayedEndGame ( )
protected

Definition at line 561 of file SCR_GameOverScreenManagerComponent.c.

◆ OpenGameOverScreen()

SCR_GameOverScreenUIComponent OpenGameOverScreen ( ResourceName contentLayout,
SCR_BaseGameOverScreenInfo gameOverInfo,
SCR_GameModeEndData endData,
LocalizedString title = string.Empty,
LocalizedString subtitle = string.Empty,
LocalizedString debriefing = string.Empty,
ResourceName imageTexture = ResourceName.Empty,
ResourceName icon = ResourceName.Empty,
Color vignetteColor = null,
string titleParam = string.Empty,
string subtitleParam = string.Empty,
string debriefingParam = string.Empty )
protected

Open end screen

Parameters
[in]contentLayout
[in]gameOverInfo
[in]endData
[in]titletitle of game over screen
[in]subtitlesubtitle of game over screen
[in]debriefingdebriefing text of game over screen
[in]imageTextureImage shown in game over screen
[in]icon
[in]vignetteColorwill set the color of the gameover screen background overlay
[in]titleParamtitle param %1
[in]subtitleParamsubtitle param %1
[in]debriefingParamdebriefing param %1
Returns
Widget endscreen widget

Definition at line 440 of file SCR_GameOverScreenManagerComponent.c.

◆ SetEditorGameOverFactions()

void SetEditorGameOverFactions ( notnull array< int > factions)
protected

Set the factions for editor gameover used in the gameover screen (Generally winning factions)

Parameters
[in]factionsarray of factions

Definition at line 536 of file SCR_GameOverScreenManagerComponent.c.

◆ SetEditorGameOverType()

void SetEditorGameOverType ( EGameOverTypes gameOverType)
protected

Set the gameover type for editor gameover used in the gameover screen

Parameters
[in]gameOverTypeEGameOverTypes gameover type

Definition at line 522 of file SCR_GameOverScreenManagerComponent.c.

◆ SetGameOverScreenOverWrite()

void SetGameOverScreenOverWrite ( ResourceName overWriteLayout)
protected

Sets which background will be used in the game over screen param[in] overWriteLayout Layout that will be used instead of basic game over screen

Definition at line 49 of file SCR_GameOverScreenManagerComponent.c.

◆ SetGameOverVariables()

void SetGameOverVariables ( SCR_GameModeEndData endData = null)
protected

Set all variables needed to set the correct game over screen

Parameters
[in]endData

Definition at line 205 of file SCR_GameOverScreenManagerComponent.c.

◆ ShowGameOverScreen()

SCR_GameOverScreenUIComponent ShowGameOverScreen ( SCR_GameModeEndData endData = null)
protected

Call end screen using SCR_GameModeEndData. This is generally called after fade but can also be called instantly if desired

Parameters
[in]endDataend game data. Will get endgame date from gamemode if non given
Returns
SCR_GameOverScreenUIComponent game over screen widget

Definition at line 132 of file SCR_GameOverScreenManagerComponent.c.

◆ StartEndGameFade()

void StartEndGameFade ( )
protected

Called when end game is called on GameMode Fade the endgame screen but retain control Once the fade in is done the end screen will be shown

Definition at line 58 of file SCR_GameOverScreenManagerComponent.c.

Variable Documentation

◆ m_aEditorSetFactions

ref array<int> m_aEditorSetFactions = {}
protected

Definition at line 23 of file SCR_GameOverScreenManagerComponent.c.

◆ m_aWinningFactions

ref array<Faction> m_aWinningFactions = {}
protected

Definition at line 31 of file SCR_GameOverScreenManagerComponent.c.

◆ m_aWinningPlayers

ref array<int> m_aWinningPlayers = {}
protected

Definition at line 32 of file SCR_GameOverScreenManagerComponent.c.

◆ m_bIsFactionVictory

bool m_bIsFactionVictory = false
protected

Definition at line 27 of file SCR_GameOverScreenManagerComponent.c.

◆ m_bIsPlayingGameOverAudio

bool m_bIsPlayingGameOverAudio = false
protected

Definition at line 33 of file SCR_GameOverScreenManagerComponent.c.

◆ m_bListeningToEditorCalledEndGame

bool m_bListeningToEditorCalledEndGame = false
protected

Definition at line 21 of file SCR_GameOverScreenManagerComponent.c.

◆ m_EndScreenFade

Widget m_EndScreenFade
protected

Definition at line 37 of file SCR_GameOverScreenManagerComponent.c.

◆ m_FactionPlayer

Faction m_FactionPlayer = null
protected

Definition at line 28 of file SCR_GameOverScreenManagerComponent.c.

◆ m_fShowEndscreenDelay

float m_fShowEndscreenDelay
protected

Definition at line 13 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iEditorSetGameOverType

EGameOverTypes m_iEditorSetGameOverType
protected

Definition at line 22 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iEndGameType

EGameOverTypes m_iEndGameType = EGameOverTypes.UNKNOWN
protected

Definition at line 26 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iEndReason

int m_iEndReason = 0
protected

Definition at line 30 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iPlayerId

int m_iPlayerId = -1
protected

Definition at line 29 of file SCR_GameOverScreenManagerComponent.c.

◆ m_sGameOverScreenBasePrefab

ResourceName m_sGameOverScreenBasePrefab
protected

Definition at line 16 of file SCR_GameOverScreenManagerComponent.c.

◆ m_sGameOverScreenOverwritePrefab

ResourceName m_sGameOverScreenOverwritePrefab
protected

Definition at line 18 of file SCR_GameOverScreenManagerComponent.c.