SCR_IngameClockUIComponent Interface Reference

Gets the Ingame time and displays it on a UI text element. More...

Inheritance diagram for SCR_IngameClockUIComponent:

Public Member Functions
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
override void	HandlerAttached (Widget w)

Protected Member Functions
void	UpdateIngameClock ()
Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance?

Protected Attributes
string	m_sTimeTextName
string	m_sTimeIconName
string	m_sTimeMultiplierName
string	m_sTimeStoppedIconName
string	m_sTimeMultiplierFormat
string	m_sNoTimeProgressionHint
string	m_sInGameTimeHint
float	m_fUpdateFreq
bool	m_bHideTimeMultiplierIfOne
ref array< EDayTimeEnums >	m_aShowMoonphaseAtDayTimes
TextWidget	m_TimeText
ImageWidget	m_TimeIcon
TextWidget	m_TimeMultiplier
ImageWidget	m_TimeStoppedIcon
TimeAndWeatherManagerEntity	m_TimeAndWeatherManagerEntity
SCR_CustomTooltipTargetEditorUIComponent	m_CustomTooltipUIComponent

Detailed Description

Gets the Ingame time and displays it on a UI text element.

Member Function Documentation

HandlerAttachedScripted()

override void SCR_IngameClockUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

HandlerDeattached()

override void SCR_IngameClockUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

UpdateIngameClock()

void SCR_IngameClockUIComponent.UpdateIngameClock ( )

protected

Member Data Documentation

m_aShowMoonphaseAtDayTimes

ref array<EDayTimeEnums> SCR_IngameClockUIComponent.m_aShowMoonphaseAtDayTimes

protected

m_bHideTimeMultiplierIfOne

bool SCR_IngameClockUIComponent.m_bHideTimeMultiplierIfOne

protected

m_CustomTooltipUIComponent

SCR_CustomTooltipTargetEditorUIComponent SCR_IngameClockUIComponent.m_CustomTooltipUIComponent

protected

m_fUpdateFreq

float SCR_IngameClockUIComponent.m_fUpdateFreq

protected

m_sInGameTimeHint

string SCR_IngameClockUIComponent.m_sInGameTimeHint

protected

m_sNoTimeProgressionHint

string SCR_IngameClockUIComponent.m_sNoTimeProgressionHint

protected

m_sTimeIconName

string SCR_IngameClockUIComponent.m_sTimeIconName

protected

m_sTimeMultiplierFormat

string SCR_IngameClockUIComponent.m_sTimeMultiplierFormat

protected

m_sTimeMultiplierName

string SCR_IngameClockUIComponent.m_sTimeMultiplierName

protected

m_sTimeStoppedIconName

string SCR_IngameClockUIComponent.m_sTimeStoppedIconName

protected

m_sTimeTextName

string SCR_IngameClockUIComponent.m_sTimeTextName

protected

m_TimeAndWeatherManagerEntity

TimeAndWeatherManagerEntity SCR_IngameClockUIComponent.m_TimeAndWeatherManagerEntity

protected

m_TimeIcon

ImageWidget SCR_IngameClockUIComponent.m_TimeIcon

protected

m_TimeMultiplier

TextWidget SCR_IngameClockUIComponent.m_TimeMultiplier

protected

m_TimeStoppedIcon

ImageWidget SCR_IngameClockUIComponent.m_TimeStoppedIcon

protected

m_TimeText

TextWidget SCR_IngameClockUIComponent.m_TimeText

protected

---

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

• Game/UI/Components/SCR_IngameClockUIComponent.c