SCR_MapModuleBase Class Reference

Map module base class. More...

Inheritance diagram for SCR_MapModuleBase:

Protected Member Functions
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
bool	IsConfigDisabled ()
	Whether this module is disabled in config.
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.
void	SCR_MapModuleBase ()
	Dont use arguments in the contructor for this class or its children.

Protected Attributes
bool	m_bDisableModule
Widget	m_wRootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

Map module base class.

Definition at line 4 of file SCR_MapModuleBase.c.

Constructor & Destructor Documentation

SCR_MapModuleBase()

void SCR_MapModuleBase::SCR_MapModuleBase ( )

inlineprotected

Dont use arguments in the contructor for this class or its children.

Definition at line 64 of file SCR_MapModuleBase.c.

Member Function Documentation

Init()

void SCR_MapModuleBase::Init ( )

inlineprotected

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

Definition at line 54 of file SCR_MapModuleBase.c.

IsConfigDisabled()

bool SCR_MapModuleBase::IsConfigDisabled ( )

inlineprotected

Whether this module is disabled in config.

Definition at line 24 of file SCR_MapModuleBase.c.

OnMapClose()

void SCR_MapModuleBase::OnMapClose ( MapConfiguration config )

inlineprotected

SCR_MapEntity event.

Definition at line 19 of file SCR_MapModuleBase.c.

OnMapOpen()

void SCR_MapModuleBase::OnMapOpen ( MapConfiguration config )

inlineprotected

SCR_MapEntity event.

Definition at line 14 of file SCR_MapModuleBase.c.

SetActive()

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

inlineprotected

Enable open/close events

Parameters

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

Definition at line 33 of file SCR_MapModuleBase.c.

Update()

void SCR_MapModuleBase::Update ( float timeSlice )

inlineprotected

Update method for frame operations.

Definition at line 59 of file SCR_MapModuleBase.c.

Member Data Documentation

m_bDisableModule

bool SCR_MapModuleBase::m_bDisableModule

protected

Definition at line 7 of file SCR_MapModuleBase.c.

m_MapEntity

SCR_MapEntity SCR_MapModuleBase::m_MapEntity

protected

Definition at line 10 of file SCR_MapModuleBase.c.

m_wRootWidget

Widget SCR_MapModuleBase::m_wRootWidget

protected

Definition at line 9 of file SCR_MapModuleBase.c.

---

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

• scripts/Game/Map/Modules/SCR_MapModuleBase.c