SCR_MapTaskListUI Interface Reference

Inheritance diagram for SCR_MapTaskListUI:

Public Member Functions
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.
void	SetMapContextAllowed (bool val)
void	ToggleTaskList (SCR_BaseTask taskToFocus=null)
void	RefreshTaskList ()
void	HandleTaskList (bool isVisible=true, SCR_BaseTask taskToFocus=null)
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_MapUIBaseComponent
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 ()

Static Public Attributes
const string	TASK_LIST_FRAME = "MapTaskList"
const string	ICON_NAME = "faction"

Protected Member Functions
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapTaskListClicked (SCR_ButtonBaseComponent comp)
void	OnInputDeviceIsGamepad (bool isGamepad)
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
Widget	m_wUI
Widget	m_wTaskListFrame
SCR_UITaskManagerComponent	m_UITaskManager
SCR_MapToolMenuUI	m_ToolMenu
SCR_MapToolEntry	m_ToolMenuEntry
SCR_BaseTask	m_LastSelectedTask
bool	m_bTaskListInvoked
bool	m_bOpened
bool	m_bOnMapClose
bool	m_bMapContextAllowed = true
string	m_sJournalFrameName
string	m_sMapTaskListRootName
string	m_sMapTaskListRootFrameName
string	m_sJournalToolMenuIconName
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Member Function Documentation

HandlerDeattached()

override void SCR_MapTaskListUI.HandlerDeattached

(

Widget

w

)

HandleTaskList()

void SCR_MapTaskListUI.HandleTaskList	(	bool	isVisible = true,
		SCR_BaseTask	taskToFocus = null
	)

Parameters

[in]

isVisible

Init()

override void SCR_MapTaskListUI.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.

OnInputDeviceIsGamepad()

void SCR_MapTaskListUI.OnInputDeviceIsGamepad ( bool  isGamepad )

protected

OnMapClose()

override void SCR_MapTaskListUI.OnMapClose ( MapConfiguration  config )

protected

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapTaskListUI.OnMapOpen ( MapConfiguration  config )

protected

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapTaskListClicked()

void SCR_MapTaskListUI.OnMapTaskListClicked ( SCR_ButtonBaseComponent  comp )

protected

RefreshTaskList()

void SCR_MapTaskListUI.RefreshTaskList

(

)

SetMapContextAllowed()

void SCR_MapTaskListUI.SetMapContextAllowed

(

bool

val

)

Parameters

[in]

val

ToggleTaskList()

void SCR_MapTaskListUI.ToggleTaskList

(

SCR_BaseTask

taskToFocus = null

)

Member Data Documentation

ICON_NAME

const string SCR_MapTaskListUI.ICON_NAME = "faction"

static

m_bMapContextAllowed

bool SCR_MapTaskListUI.m_bMapContextAllowed = true

protected

m_bOnMapClose

bool SCR_MapTaskListUI.m_bOnMapClose

protected

m_bOpened

bool SCR_MapTaskListUI.m_bOpened

protected

m_bTaskListInvoked

bool SCR_MapTaskListUI.m_bTaskListInvoked

protected

m_LastSelectedTask

SCR_BaseTask SCR_MapTaskListUI.m_LastSelectedTask

protected

m_sJournalFrameName

string SCR_MapTaskListUI.m_sJournalFrameName

protected

m_sJournalToolMenuIconName

string SCR_MapTaskListUI.m_sJournalToolMenuIconName

protected

m_sMapTaskListRootFrameName

string SCR_MapTaskListUI.m_sMapTaskListRootFrameName

protected

m_sMapTaskListRootName

string SCR_MapTaskListUI.m_sMapTaskListRootName

protected

m_ToolMenu

SCR_MapToolMenuUI SCR_MapTaskListUI.m_ToolMenu

protected

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapTaskListUI.m_ToolMenuEntry

protected

m_UITaskManager

SCR_UITaskManagerComponent SCR_MapTaskListUI.m_UITaskManager

protected

m_wTaskListFrame

Widget SCR_MapTaskListUI.m_wTaskListFrame

protected

m_wUI

Widget SCR_MapTaskListUI.m_wUI

protected

TASK_LIST_FRAME

const string SCR_MapTaskListUI.TASK_LIST_FRAME = "MapTaskList"

static

---

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

• Game/Map/ComponentsUI/SCR_MapTaskListUI.c