Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_MapUIBaseComponent Interface Reference
Inheritance diagram for SCR_MapUIBaseComponent:
SCR_MapDebugUI SCR_MapDrawingUI SCR_MapJournalUI SCR_MapLightUI SCR_MapMarkersUI SCR_MapRTWBaseUI SCR_MapRadialUI SCR_MapRulerUI SCR_MapTaskListUI SCR_MapToolInteractionUI SCR_MapToolMenuUI SCR_MapUIElementContainer

Public Member Functions

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 OnMapOpen (MapConfiguration config)
 SCR_MapEntity event.
 
void OnMapClose (MapConfiguration config)
 SCR_MapEntity event.
 

Protected Attributes

bool m_bDisableComponent
 
bool m_bHookToRoot = false
 
Widget m_RootWidget
 
SCR_MapEntity m_MapEntity
 

Constructor & Destructor Documentation

◆ SCR_MapUIBaseComponent()

void SCR_MapUIBaseComponent.SCR_MapUIBaseComponent ( )

Member Function Documentation

◆ Init()

void SCR_MapUIBaseComponent.Init ( )

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

Implemented in SCR_MapCompassUI, SCR_MapDebugUI, SCR_MapDrawingUI, SCR_MapJournalUI, SCR_MapMarkersUI, SCR_MapRulerUI, SCR_MapTaskListUI, SCR_MapUIElementContainer, and SCR_MapWatchUI.

◆ IsConfigDisabled()

bool SCR_MapUIBaseComponent.IsConfigDisabled ( )
Returns
true if this component is disabled in config, false otherwise

◆ IsToolMenuFocused()

bool SCR_MapUIBaseComponent.IsToolMenuFocused ( )

◆ OnMapClose()

◆ OnMapOpen()

◆ SetActive()

void SCR_MapUIBaseComponent.SetActive ( bool active,
bool isCleanup = false )

Enable open/close events, called every time component is activated, usually on map open.

Parameters
[in]activeis target state
[in]isCleanupdetermines if this is just deactivation or a cleanup

◆ Update()

void SCR_MapUIBaseComponent.Update ( float timeSlice)

Member Data Documentation

◆ m_bDisableComponent

bool SCR_MapUIBaseComponent.m_bDisableComponent
protected

◆ m_bHookToRoot

bool SCR_MapUIBaseComponent.m_bHookToRoot = false
protected

◆ m_MapEntity

SCR_MapEntity SCR_MapUIBaseComponent.m_MapEntity
protected

◆ m_RootWidget

Widget SCR_MapUIBaseComponent.m_RootWidget
protected

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