Arma Reforger Explorer  1.1.0.42
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
SCR_GameOverScreenManagerComponent.c File Reference

Go to the source code of this file.

Data Structures

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
 Post-process effect of scripted camera. More...
 
SCR_GameOverScreenConfig GetGameOverConfig ()
 
protected void StartEndGameFade ()
 
protected void OnEndScreenFadeDone (SCR_FadeUIComponent fadeComponent, bool isFadeIn)
 
SCR_GameOverScreenUIComponent ShowGameOverScreen (SCR_GameModeEndData endData=null)
 
protected void SetGameOverVarriables (SCR_GameModeEndData endData=null)
 
protected EGameOverTypes GetGameOverType (int endReason, int playerId, array< int > winningPlayers, Faction factionPlayer, array< Faction > factionsVictor, bool isFactionVictory)
 
EGameOverTypes GetCurrentGameOverType ()
 
SCR_GameOverScreenUIComponent OpenGameOverScreen (ResourceName contentLayout, 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 void OnEditorEndGameApplyDelayDone ()
 
void SetEditorGameOverType (EGameOverTypes gameOverType)
 
void SetEditorGameOverFactions (notnull array< int > factions)
 
override void OnGameModeEnd (SCR_GameModeEndData data)
 
protected void OnInitDelayedEndGame ()
 
override void OnPostInit (IEntity owner)
 Editable Mine. More...
 

Variables

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

Function Documentation

◆ GetCurrentGameOverType()

EGameOverTypes GetCurrentGameOverType ( )

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

Returns
GameOver Type

Definition at line 351 of file SCR_GameOverScreenManagerComponent.c.

◆ GetGameOverConfig()

SCR_GameOverScreenConfig GetGameOverConfig ( )
Returns
GameoverScreen Config

Definition at line 39 of file SCR_GameOverScreenManagerComponent.c.

◆ GetGameOverType()

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

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 252 of file SCR_GameOverScreenManagerComponent.c.

◆ OnEditorEndGameApplyDelayDone()

protected void OnEditorEndGameApplyDelayDone ( )

Definition at line 395 of file SCR_GameOverScreenManagerComponent.c.

◆ OnEndScreenFadeDone()

protected void OnEndScreenFadeDone ( SCR_FadeUIComponent  fadeComponent,
bool  isFadeIn 
)

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

Parameters
[in]fadeComponent
[in]isFadeIn

Definition at line 96 of file SCR_GameOverScreenManagerComponent.c.

◆ OnGameModeEnd()

override void OnGameModeEnd ( SCR_GameModeEndData  data)

Called when game mode ends.

Parameters
[in]dataEnd game data with game logic.

Definition at line 474 of file SCR_GameOverScreenManagerComponent.c.

◆ OnInitDelayedEndGame()

protected void OnInitDelayedEndGame ( )

Definition at line 486 of file SCR_GameOverScreenManagerComponent.c.

◆ OpenGameOverScreen()

SCR_GameOverScreenUIComponent OpenGameOverScreen ( ResourceName  contentLayout,
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 
)

Open end screen

Parameters
[in]contentLayout
[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 370 of file SCR_GameOverScreenManagerComponent.c.

◆ SetEditorGameOverFactions()

void SetEditorGameOverFactions ( notnull array< int factions)

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

Parameters
[in]factionsarray of factions

Definition at line 461 of file SCR_GameOverScreenManagerComponent.c.

◆ SetEditorGameOverType()

void SetEditorGameOverType ( EGameOverTypes  gameOverType)

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

Parameters
[in]gameOverTypeEGameOverTypes gameover type

Definition at line 447 of file SCR_GameOverScreenManagerComponent.c.

◆ SetGameOverVarriables()

protected void SetGameOverVarriables ( SCR_GameModeEndData  endData = null)

Set all variables needed to set the correct game over screen

Parameters
[in]endData

Definition at line 180 of file SCR_GameOverScreenManagerComponent.c.

◆ ShowGameOverScreen()

SCR_GameOverScreenUIComponent ShowGameOverScreen ( SCR_GameModeEndData  endData = null)

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 107 of file SCR_GameOverScreenManagerComponent.c.

◆ StartEndGameFade()

protected void StartEndGameFade ( )

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 48 of file SCR_GameOverScreenManagerComponent.c.

Variable Documentation

◆ m_aEditorSetFactions

protected ref array<int> m_aEditorSetFactions = {}

Definition at line 21 of file SCR_GameOverScreenManagerComponent.c.

◆ m_aWinningFactions

protected ref array<Faction> m_aWinningFactions = {}

Definition at line 29 of file SCR_GameOverScreenManagerComponent.c.

◆ m_aWinningPlayers

protected ref array<int> m_aWinningPlayers = {}

Definition at line 30 of file SCR_GameOverScreenManagerComponent.c.

◆ m_bIsFactionVictory

protected bool m_bIsFactionVictory = false

Definition at line 25 of file SCR_GameOverScreenManagerComponent.c.

◆ m_bIsPlayingGameOverAudio

protected bool m_bIsPlayingGameOverAudio = false

Definition at line 31 of file SCR_GameOverScreenManagerComponent.c.

◆ m_bListeningToEditorCalledEndGame

protected bool m_bListeningToEditorCalledEndGame = false

Definition at line 19 of file SCR_GameOverScreenManagerComponent.c.

◆ m_EndScreenFade

protected Widget m_EndScreenFade

Definition at line 35 of file SCR_GameOverScreenManagerComponent.c.

◆ m_FactionPlayer

protected Faction m_FactionPlayer = null

Definition at line 26 of file SCR_GameOverScreenManagerComponent.c.

◆ m_fShowEndscreenDelay

protected float m_fShowEndscreenDelay

Definition at line 13 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iEditorSetGameOverType

protected EGameOverTypes m_iEditorSetGameOverType

Definition at line 20 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iEndGameType

protected EGameOverTypes m_iEndGameType = EGameOverTypes.UNKNOWN

Definition at line 24 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iEndReason

protected int m_iEndReason = 0

Definition at line 28 of file SCR_GameOverScreenManagerComponent.c.

◆ m_iPlayerId

protected int m_iPlayerId = -1

Definition at line 27 of file SCR_GameOverScreenManagerComponent.c.

◆ m_sGameOverScreenBasePrefab

protected ResourceName m_sGameOverScreenBasePrefab

Definition at line 16 of file SCR_GameOverScreenManagerComponent.c.