SCR_MapLightUI Interface Reference

Map light effects. More...

Inheritance diagram for SCR_MapLightUI:

Public Member Functions
void	ToggleActive ()
	Toggle map light.
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
override void	Update (float timeSlice)
	Update method for frame operations.
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
void	Update (float timeSlice)
	Update method for frame operations.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Protected Member Functions
void	ActivateLight ()
	Activate map light.
void	DeactivateLight ()
	Deactivate map light.
void	UpdateLightMode ()
	Use config to configure light when switching modes.
void	UpdateTime ()
	Update light modes based on time of day.
void	UpdatePosition ()
	Update light position.
void	Init (Widget widget)
	Initialisation.
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
bool	m_bActive = false
bool	m_bIsDark = false
float	m_fSunriseTime
float	m_fSunsetTime
EMapLightMode	m_eLightMode = EMapLightMode.NONE
Widget	m_wLightOverlay
Widget	m_wLightCone
Widget	m_wFillTop
Widget	m_wFillLeft
Widget	m_wConeImg
TimeAndWeatherManagerEntity	m_TimeMgr
SCR_MapCursorModule	m_CursorModule
ref SCR_MapLightConfig	m_LightCfg
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

Map light effects.

Member Function Documentation

ActivateLight()

void SCR_MapLightUI.ActivateLight ( )

protected

Activate map light.

DeactivateLight()

void SCR_MapLightUI.DeactivateLight ( )

protected

Deactivate map light.

Init()

void SCR_MapLightUI.Init ( Widget  widget )

protected

Initialisation.

Parameters

[in]

widget

is the root widget

OnMapClose()

override void SCR_MapLightUI.OnMapClose

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapLightUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

ToggleActive()

void SCR_MapLightUI.ToggleActive

(

)

Toggle map light.

Update()

override void SCR_MapLightUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

UpdateLightMode()

void SCR_MapLightUI.UpdateLightMode ( )

protected

Use config to configure light when switching modes.

UpdatePosition()

void SCR_MapLightUI.UpdatePosition ( )

protected

Update light position.

UpdateTime()

void SCR_MapLightUI.UpdateTime ( )

protected

Update light modes based on time of day.

Member Data Documentation

m_bActive

bool SCR_MapLightUI.m_bActive = false

protected

m_bIsDark

bool SCR_MapLightUI.m_bIsDark = false

protected

m_CursorModule

SCR_MapCursorModule SCR_MapLightUI.m_CursorModule

protected

m_eLightMode

EMapLightMode SCR_MapLightUI.m_eLightMode = EMapLightMode.NONE

protected

m_fSunriseTime

float SCR_MapLightUI.m_fSunriseTime

protected

m_fSunsetTime

float SCR_MapLightUI.m_fSunsetTime

protected

m_LightCfg

ref SCR_MapLightConfig SCR_MapLightUI.m_LightCfg

protected

m_TimeMgr

TimeAndWeatherManagerEntity SCR_MapLightUI.m_TimeMgr

protected

m_wConeImg

Widget SCR_MapLightUI.m_wConeImg

protected

m_wFillLeft

Widget SCR_MapLightUI.m_wFillLeft

protected

m_wFillTop

Widget SCR_MapLightUI.m_wFillTop

protected

m_wLightCone

Widget SCR_MapLightUI.m_wLightCone

protected

m_wLightOverlay

Widget SCR_MapLightUI.m_wLightOverlay

protected

---

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

• Game/Map/ComponentsUI/SCR_MapLightUI.c