Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_MapWeatherUI Interface Reference
Inheritance diagram for SCR_MapWeatherUI:
SCR_MapUIBaseComponent

Public Member Functions

override void Update (float timeSlice)
 Update method for frame operations.
 
void UpdateWeatherData ()
 Updates the information about current and upcoming weather.
 
override void Init ()
 Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
 
- Public Member Functions inherited from SCR_MapUIBaseComponent
bool IsConfigDisabled ()
 
bool IsExclusive ()
 
void SetActive (bool active, bool isCleanup=false)
 Enable open/close events, called every time component is activated, usually on map open.
 
bool IsToolMenuFocused ()
 
void SCR_MapUIBaseComponent ()
 

Protected Member Functions

void ToggleVisibility (SCR_ButtonBaseComponent button=null)
 
void SetVsibilityState (bool state)
 
void UpdateLayoutPosition ()
 Changes the Y position of the layout to be next to the weather button.
 
void UpdateWindData ()
 Updates the information about current wind conditions.
 
void OnWeatherChanged (notnull TimeAndWeatherManagerEntity manager, int currentStateId, int nextStateId, bool transitioning)
 
void OnWindOverrideDataChanged (notnull TimeAndWeatherManagerEntity manager, bool currentState, float currentSpeed, float currentDirection)
 
override void OnMapOpen (MapConfiguration config)
 SCR_MapEntity event.
 
override void OnMapClose (MapConfiguration config)
 SCR_MapEntity event.
 
bool CreateLayout ()
 

Protected Attributes

float m_fWindSpeedPrecision
 
int m_iWindDirectionPrecision
 
int m_iDataUpdateCooldown
 
vector m_vPositionOffset
 
string m_sMapWeatherFrame
 
bool m_bVisible
 
bool m_bLastAutomaticWindState
 
float m_fLastWindSpeed
 
float m_fLastWindDirection
 
Widget m_wMapWeatherFrame
 
Widget m_wWeatherDataRoot
 
Widget m_wWindOverrideInfo
 
Widget m_wWeatherOverrideInfo
 
Widget m_wCurrentWeatherHolder
 
Widget m_wUpcomingWeatherHolder
 
TextWidget m_wCurrentWindSpeed
 
TextWidget m_wCurrentWindDirection
 
ChimeraWorld m_World
 
WorldTimestamp m_NextWindUpdateCooldown
 
SCR_MapToolEntry m_ToolMenuEntry
 
TimeAndWeatherManagerEntity m_WeatherManager
 
- Protected Attributes inherited from SCR_MapUIBaseComponent
bool m_bDisableComponent
 
bool m_bIsExclusive
 
bool m_bHookToRoot = false
 
Widget m_RootWidget
 
SCR_MapEntity m_MapEntity
 

Static Protected Attributes

const ResourceName ICON = "{857DD01860810AE9}UI/Textures/Editor/Attributes/Categories/Attribute_Category_Weather.edds"
 
const ResourceName LAYOUT = "{E360A5329459869F}UI/layouts/Menus/DeployMenu/MapWeatherData.layout"
 
const string LABEL_DIRECTION = "#AR-MapInfo_WeatherData_WindDirection"
 
const string LABEL_SPEED = "#AR-MapInfo_WeatherData_WindSpeed"
 
const string WIDGET_NAME_ICON = "StateIcon"
 
const string WIDGET_NAME_TITLE = "StateTitle"
 
const string WIDGET_NAME_TIME = "Time"
 
const string FORMAT_HOUR = "%1:00"
 

Member Function Documentation

◆ CreateLayout()

bool SCR_MapWeatherUI.CreateLayout ( )
protected

◆ Init()

override void SCR_MapWeatherUI.Init ( )

Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.

Implements SCR_MapUIBaseComponent.

◆ OnMapClose()

override void SCR_MapWeatherUI.OnMapClose ( MapConfiguration config)
protected

SCR_MapEntity event.

Parameters
[in]config

Implements SCR_MapUIBaseComponent.

◆ OnMapOpen()

override void SCR_MapWeatherUI.OnMapOpen ( MapConfiguration config)
protected

SCR_MapEntity event.

Parameters
[in]config

Implements SCR_MapUIBaseComponent.

◆ OnWeatherChanged()

void SCR_MapWeatherUI.OnWeatherChanged ( notnull TimeAndWeatherManagerEntity manager,
int currentStateId,
int nextStateId,
bool transitioning )
protected

◆ OnWindOverrideDataChanged()

void SCR_MapWeatherUI.OnWindOverrideDataChanged ( notnull TimeAndWeatherManagerEntity manager,
bool currentState,
float currentSpeed,
float currentDirection )
protected

◆ SetVsibilityState()

void SCR_MapWeatherUI.SetVsibilityState ( bool state)
protected

◆ ToggleVisibility()

void SCR_MapWeatherUI.ToggleVisibility ( SCR_ButtonBaseComponent button = null)
protected

◆ Update()

override void SCR_MapWeatherUI.Update ( float timeSlice)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

◆ UpdateLayoutPosition()

void SCR_MapWeatherUI.UpdateLayoutPosition ( )
protected

Changes the Y position of the layout to be next to the weather button.

◆ UpdateWeatherData()

void SCR_MapWeatherUI.UpdateWeatherData ( )

Updates the information about current and upcoming weather.

◆ UpdateWindData()

void SCR_MapWeatherUI.UpdateWindData ( )
protected

Updates the information about current wind conditions.

Member Data Documentation

◆ FORMAT_HOUR

const string SCR_MapWeatherUI.FORMAT_HOUR = "%1:00"
staticprotected

◆ ICON

const ResourceName SCR_MapWeatherUI.ICON = "{857DD01860810AE9}UI/Textures/Editor/Attributes/Categories/Attribute_Category_Weather.edds"
staticprotected

◆ LABEL_DIRECTION

const string SCR_MapWeatherUI.LABEL_DIRECTION = "#AR-MapInfo_WeatherData_WindDirection"
staticprotected

◆ LABEL_SPEED

const string SCR_MapWeatherUI.LABEL_SPEED = "#AR-MapInfo_WeatherData_WindSpeed"
staticprotected

◆ LAYOUT

const ResourceName SCR_MapWeatherUI.LAYOUT = "{E360A5329459869F}UI/layouts/Menus/DeployMenu/MapWeatherData.layout"
staticprotected

◆ m_bLastAutomaticWindState

bool SCR_MapWeatherUI.m_bLastAutomaticWindState
protected

◆ m_bVisible

bool SCR_MapWeatherUI.m_bVisible
protected

◆ m_fLastWindDirection

float SCR_MapWeatherUI.m_fLastWindDirection
protected

◆ m_fLastWindSpeed

float SCR_MapWeatherUI.m_fLastWindSpeed
protected

◆ m_fWindSpeedPrecision

float SCR_MapWeatherUI.m_fWindSpeedPrecision
protected

◆ m_iDataUpdateCooldown

int SCR_MapWeatherUI.m_iDataUpdateCooldown
protected

◆ m_iWindDirectionPrecision

int SCR_MapWeatherUI.m_iWindDirectionPrecision
protected

◆ m_NextWindUpdateCooldown

WorldTimestamp SCR_MapWeatherUI.m_NextWindUpdateCooldown
protected

◆ m_sMapWeatherFrame

string SCR_MapWeatherUI.m_sMapWeatherFrame
protected

◆ m_ToolMenuEntry

SCR_MapToolEntry SCR_MapWeatherUI.m_ToolMenuEntry
protected

◆ m_vPositionOffset

vector SCR_MapWeatherUI.m_vPositionOffset
protected

◆ m_wCurrentWeatherHolder

Widget SCR_MapWeatherUI.m_wCurrentWeatherHolder
protected

◆ m_wCurrentWindDirection

TextWidget SCR_MapWeatherUI.m_wCurrentWindDirection
protected

◆ m_wCurrentWindSpeed

TextWidget SCR_MapWeatherUI.m_wCurrentWindSpeed
protected

◆ m_WeatherManager

TimeAndWeatherManagerEntity SCR_MapWeatherUI.m_WeatherManager
protected

◆ m_wMapWeatherFrame

Widget SCR_MapWeatherUI.m_wMapWeatherFrame
protected

◆ m_World

ChimeraWorld SCR_MapWeatherUI.m_World
protected

◆ m_wUpcomingWeatherHolder

Widget SCR_MapWeatherUI.m_wUpcomingWeatherHolder
protected

◆ m_wWeatherDataRoot

Widget SCR_MapWeatherUI.m_wWeatherDataRoot
protected

◆ m_wWeatherOverrideInfo

Widget SCR_MapWeatherUI.m_wWeatherOverrideInfo
protected

◆ m_wWindOverrideInfo

Widget SCR_MapWeatherUI.m_wWindOverrideInfo
protected

◆ WIDGET_NAME_ICON

const string SCR_MapWeatherUI.WIDGET_NAME_ICON = "StateIcon"
staticprotected

◆ WIDGET_NAME_TIME

const string SCR_MapWeatherUI.WIDGET_NAME_TIME = "Time"
staticprotected

◆ WIDGET_NAME_TITLE

const string SCR_MapWeatherUI.WIDGET_NAME_TITLE = "StateTitle"
staticprotected
The documentation for this interface was generated from the following file: