SCR_ServerRestartTimerUIComponent Interface Reference

Inheritance diagram for SCR_ServerRestartTimerUIComponent:

Public Member Functions
bool	IsValid ()
	return If the restart timer is set up correctly
void	StartTimer (bool checkIfValid=true)
	Start the timer param[in] checkIfValid If true checks if the timer is valid (aka all systems and UI are there and the game has ended) This is done on init as well.
void	StopTimer ()
	Stop the timer.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Member Functions
void	Init ()
void	UpdateTimer ()
void	OnTimeUpdate (float currentRestartTimer)

Protected Attributes
LocalizedString	m_sRestartTimerFormat
string	m_sRestartTimerName
bool	m_bEnableCountDownSfx
bool	m_bStartOnInit
float	m_fAutoReloadDelay = -1
WorldTimestamp	m_GameEndTimeStamp = null
int	m_iPreviousRestartTime
ChimeraWorld	m_World
TextWidget	m_wRestartTimer
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const int	UPDATE_TIME = 100
	Refresh time of timer (in milliseconds)

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

HandlerAttached()

override void SCR_ServerRestartTimerUIComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

HandlerDeattached()

override void SCR_ServerRestartTimerUIComponent.HandlerDeattached

(

Widget

w

)

Init()

void SCR_ServerRestartTimerUIComponent.Init ( )

protected

IsValid()

bool SCR_ServerRestartTimerUIComponent.IsValid

(

)

return If the restart timer is set up correctly

OnTimeUpdate()

void SCR_ServerRestartTimerUIComponent.OnTimeUpdate ( float  currentRestartTimer )

protected

StartTimer()

void SCR_ServerRestartTimerUIComponent.StartTimer

(

bool

checkIfValid = true

)

Start the timer param[in] checkIfValid If true checks if the timer is valid (aka all systems and UI are there and the game has ended) This is done on init as well.

StopTimer()

void SCR_ServerRestartTimerUIComponent.StopTimer

(

)

Stop the timer.

UpdateTimer()

void SCR_ServerRestartTimerUIComponent.UpdateTimer ( )

protected

Member Data Documentation

m_bEnableCountDownSfx

bool SCR_ServerRestartTimerUIComponent.m_bEnableCountDownSfx

protected

m_bStartOnInit

bool SCR_ServerRestartTimerUIComponent.m_bStartOnInit

protected

m_fAutoReloadDelay

float SCR_ServerRestartTimerUIComponent.m_fAutoReloadDelay = -1

protected

m_GameEndTimeStamp

WorldTimestamp SCR_ServerRestartTimerUIComponent.m_GameEndTimeStamp = null

protected

m_iPreviousRestartTime

int SCR_ServerRestartTimerUIComponent.m_iPreviousRestartTime

protected

m_sRestartTimerFormat

LocalizedString SCR_ServerRestartTimerUIComponent.m_sRestartTimerFormat

protected

m_sRestartTimerName

string SCR_ServerRestartTimerUIComponent.m_sRestartTimerName

protected

m_World

ChimeraWorld SCR_ServerRestartTimerUIComponent.m_World

protected

m_wRestartTimer

TextWidget SCR_ServerRestartTimerUIComponent.m_wRestartTimer

protected

UPDATE_TIME

const int SCR_ServerRestartTimerUIComponent.UPDATE_TIME = 100

staticprotected

Refresh time of timer (in milliseconds)

---

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

• Game/UI/GameOverScreen/SCR_ServerRestartTimerUIComponent.c