SCR_MapUIBaseComponent Class Reference

Inheritance diagram for SCR_MapUIBaseComponent:

Protected Member Functions
void	OnMapOpen (MapConfiguration config)
void	OnMapClose (MapConfiguration config)
bool	IsConfigDisabled ()
bool	IsExclusive ()
void	SetActive (bool active, bool isCleanup=false)
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 Attributes
bool	m_bDisableComponent
bool	m_bIsExclusive
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

Definition at line 3 of file SCR_MapUIBaseComponent.c.

Constructor & Destructor Documentation

SCR_MapUIBaseComponent()

void SCR_MapUIBaseComponent::SCR_MapUIBaseComponent ( )

inlineprotected

Definition at line 94 of file SCR_MapUIBaseComponent.c.

Member Function Documentation

Init()

void SCR_MapUIBaseComponent::Init ( )

protected

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

IsConfigDisabled()

bool SCR_MapUIBaseComponent::IsConfigDisabled ( )

inlineprotected

Returns

true if this component is disabled in config, false otherwise

Definition at line 39 of file SCR_MapUIBaseComponent.c.

IsExclusive()

bool SCR_MapUIBaseComponent::IsExclusive ( )

inlineprotected

Returns

true if this component should disable other exclusive UI components on the map when toggled on

Definition at line 46 of file SCR_MapUIBaseComponent.c.

IsToolMenuFocused()

bool SCR_MapUIBaseComponent::IsToolMenuFocused ( )

inlineprotected

Definition at line 83 of file SCR_MapUIBaseComponent.c.

OnMapClose()

void SCR_MapUIBaseComponent::OnMapClose ( MapConfiguration config )

inlineprotected

SCR_MapEntity event

Parameters

[in]

config

Definition at line 31 of file SCR_MapUIBaseComponent.c.

OnMapOpen()

void SCR_MapUIBaseComponent::OnMapOpen ( MapConfiguration config )

inlineprotected

SCR_MapEntity event

Parameters

[in]

config

Definition at line 22 of file SCR_MapUIBaseComponent.c.

SetActive()

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

inlineprotected

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

Parameters

[in]	active	is target state
[in]	isCleanup	determines if this is just deactivation or a cleanup

Definition at line 55 of file SCR_MapUIBaseComponent.c.

Update()

void SCR_MapUIBaseComponent::Update ( float timeSlice )

protected

Update method for frame operations.

Member Data Documentation

m_bDisableComponent

bool SCR_MapUIBaseComponent::m_bDisableComponent

protected

Definition at line 6 of file SCR_MapUIBaseComponent.c.

m_bHookToRoot

bool SCR_MapUIBaseComponent::m_bHookToRoot = false

protected

Definition at line 11 of file SCR_MapUIBaseComponent.c.

m_bIsExclusive

bool SCR_MapUIBaseComponent::m_bIsExclusive

protected

Definition at line 9 of file SCR_MapUIBaseComponent.c.

m_MapEntity

SCR_MapEntity SCR_MapUIBaseComponent::m_MapEntity

protected

Definition at line 13 of file SCR_MapUIBaseComponent.c.

m_RootWidget

Widget SCR_MapUIBaseComponent::m_RootWidget

protected

Definition at line 12 of file SCR_MapUIBaseComponent.c.

---

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

• scripts/Game/Map/ComponentsUI/SCR_MapUIBaseComponent.c