SCR_MapModuleBase Interface Reference

Map module base class. More...

Inheritance diagram for SCR_MapModuleBase:

Public Member Functions
bool	IsConfigDisabled ()
	Whether this module is disabled in config.
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events.
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 Member Functions
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
bool	m_bDisableModule
Widget	m_wRootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

Map module base class.

Constructor & Destructor Documentation

SCR_MapModuleBase()

void SCR_MapModuleBase.SCR_MapModuleBase

(

)

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

Member Function Documentation

Init()

void SCR_MapModuleBase.Init

(

)

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_MapModuleBase.IsConfigDisabled

(

)

Whether this module is disabled in config.

OnMapClose()

void SCR_MapModuleBase.OnMapClose ( MapConfiguration config )

protected

SCR_MapEntity event.

Implemented in SCR_MapCursorModule.

OnMapOpen()

void SCR_MapModuleBase.OnMapOpen ( MapConfiguration config )

protected

SCR_MapEntity event.

Implemented in SCR_MapCursorModule, and SCR_MapSelectionModule.

SetActive()

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

Enable open/close events.

Parameters

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

Update()

void SCR_MapModuleBase.Update

(

float

timeSlice

)

Update method for frame operations.

Implemented in SCR_MapCursorModule, and SCR_MapSelectionModule.

Member Data Documentation

m_bDisableModule

bool SCR_MapModuleBase.m_bDisableModule

protected

m_MapEntity

SCR_MapEntity SCR_MapModuleBase.m_MapEntity

protected

m_wRootWidget

Widget SCR_MapModuleBase.m_wRootWidget

protected

---

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

• Game/Map/Modules/SCR_MapModuleBase.c