SCR_MapTaskListUI Class Reference

Inheritance diagram for SCR_MapTaskListUI:

Protected Member Functions
void	OnMapOpen (MapConfiguration config)
void	OnMapClose (MapConfiguration config)
override void	Init ()
	Register task list button to the tools menu.
void	CreateTaskList (Widget parent=null)
override void	Update (float timeSlice)
void	UpdateTaskListHeight ()
	Update task list height to match tools menu height.
void	ToggleTaskListListener ()
	Toggle task list visibility.
void	SetMapContextAllowed (bool val)
void	ToggleTaskList (bool visibility)
void	OnMapTaskListClicked (notnull SCR_ButtonBaseComponent comp)
void	OnButtonTaskListHide ()
void	OnInputDeviceIsGamepad (bool isGamepad)
override void	HandlerDeattached (Widget w)
bool	IsTaskListVisible ()
void	DisableMapUIComponent ()
bool	CanShowAssignGroupList ()
	return true if can show assign group list

Protected Attributes
string	m_sTaskListToolMenuIconName
ResourceName	m_sTaskListLayout
string	m_sMapTaskListFrame
string	m_sTaskList
int	m_iOffset
bool	m_bShowAssignGroupList
bool	m_bShowAllTaskTypenames
ref array< string >	m_aAllowedTaskTypenames
const string	ICON_NAME = "faction"
const float	TASK_LIST_HUD_OFFSET = -0.25
const string	CONTEXT_ASSIGN_GROUP_LIST = "TaskAssignGroupListContext"
Widget	m_wTaskList
Widget	m_wTaskListFrame
SCR_TaskManagerUIComponent	m_TaskUIManager
SCR_MapToolMenuUI	m_ToolMenu
SCR_MapToolEntry	m_ToolMenuEntry
SCR_TaskListUIComponent	m_TaskComponent
bool	m_bOpened
bool	m_bMapContextAllowed
const string	ACTION_OPEN_TASK_LIST = "TasksOpen"

Detailed Description

Definition at line 1 of file SCR_MapTaskListUI.c.

Member Function Documentation

CanShowAssignGroupList()

bool SCR_MapTaskListUI::CanShowAssignGroupList ( )

inlineprotected

return true if can show assign group list

Definition at line 283 of file SCR_MapTaskListUI.c.

CreateTaskList()

void SCR_MapTaskListUI::CreateTaskList ( Widget parent = null )

inlineprotected

Create task list

Parameters

[in]

parent

of the task list.

Definition at line 112 of file SCR_MapTaskListUI.c.

DisableMapUIComponent()

void SCR_MapTaskListUI::DisableMapUIComponent ( )

inlineprotected

Definition at line 276 of file SCR_MapTaskListUI.c.

HandlerDeattached()

override void SCR_MapTaskListUI::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 255 of file SCR_MapTaskListUI.c.

Init()

override void SCR_MapTaskListUI::Init ( )

inlineprotected

Register task list button to the tools menu.

Definition at line 85 of file SCR_MapTaskListUI.c.

IsTaskListVisible()

bool SCR_MapTaskListUI::IsTaskListVisible ( )

inlineprotected

Definition at line 267 of file SCR_MapTaskListUI.c.

OnButtonTaskListHide()

void SCR_MapTaskListUI::OnButtonTaskListHide ( )

inlineprotected

Definition at line 237 of file SCR_MapTaskListUI.c.

OnInputDeviceIsGamepad()

void SCR_MapTaskListUI::OnInputDeviceIsGamepad ( bool isGamepad )

inlineprotected

Definition at line 243 of file SCR_MapTaskListUI.c.

OnMapClose()

void SCR_MapTaskListUI::OnMapClose ( MapConfiguration config )

inlineprotected

Destroy task list on map close.

Parameters

[in]

config

of the map.

Definition at line 62 of file SCR_MapTaskListUI.c.

OnMapOpen()

void SCR_MapTaskListUI::OnMapOpen ( MapConfiguration config )

inlineprotected

Recreate task list on map open.

Parameters

[in]

config

of the map.

Definition at line 46 of file SCR_MapTaskListUI.c.

OnMapTaskListClicked()

void SCR_MapTaskListUI::OnMapTaskListClicked ( notnull SCR_ButtonBaseComponent comp )

inlineprotected

Triggered on task list button clicked on tools menu. Toggles off visuals of other buttons.

Parameters

[in]

comp

button component

Definition at line 212 of file SCR_MapTaskListUI.c.

SetMapContextAllowed()

void SCR_MapTaskListUI::SetMapContextAllowed ( bool val )

inlineprotected

Parameters

[in]

val

Definition at line 186 of file SCR_MapTaskListUI.c.

ToggleTaskList()

void SCR_MapTaskListUI::ToggleTaskList ( bool visibility )

inlineprotected

Toggle task list visibility.

Parameters

[in]

visibility

new visibility of task list

Definition at line 194 of file SCR_MapTaskListUI.c.

ToggleTaskListListener()

void SCR_MapTaskListUI::ToggleTaskListListener ( )

inlineprotected

Toggle task list visibility.

Definition at line 179 of file SCR_MapTaskListUI.c.

Update()

override void SCR_MapTaskListUI::Update ( float timeSlice )

inlineprotected

Definition at line 150 of file SCR_MapTaskListUI.c.

UpdateTaskListHeight()

void SCR_MapTaskListUI::UpdateTaskListHeight ( )

inlineprotected

Update task list height to match tools menu height.

Definition at line 161 of file SCR_MapTaskListUI.c.

Member Data Documentation

ACTION_OPEN_TASK_LIST

const string SCR_MapTaskListUI::ACTION_OPEN_TASK_LIST = "TasksOpen"

protected

Definition at line 41 of file SCR_MapTaskListUI.c.

CONTEXT_ASSIGN_GROUP_LIST

const string SCR_MapTaskListUI::CONTEXT_ASSIGN_GROUP_LIST = "TaskAssignGroupListContext"

protected

Definition at line 29 of file SCR_MapTaskListUI.c.

ICON_NAME

const string SCR_MapTaskListUI::ICON_NAME = "faction"

protected

Definition at line 27 of file SCR_MapTaskListUI.c.

m_aAllowedTaskTypenames

ref array<string> SCR_MapTaskListUI::m_aAllowedTaskTypenames

protected

Definition at line 25 of file SCR_MapTaskListUI.c.

m_bMapContextAllowed

bool SCR_MapTaskListUI::m_bMapContextAllowed

protected

Definition at line 39 of file SCR_MapTaskListUI.c.

m_bOpened

bool SCR_MapTaskListUI::m_bOpened

protected

Definition at line 38 of file SCR_MapTaskListUI.c.

m_bShowAllTaskTypenames

bool SCR_MapTaskListUI::m_bShowAllTaskTypenames

protected

Definition at line 22 of file SCR_MapTaskListUI.c.

m_bShowAssignGroupList

bool SCR_MapTaskListUI::m_bShowAssignGroupList

protected

Definition at line 19 of file SCR_MapTaskListUI.c.

m_iOffset

int SCR_MapTaskListUI::m_iOffset

protected

Definition at line 16 of file SCR_MapTaskListUI.c.

m_sMapTaskListFrame

string SCR_MapTaskListUI::m_sMapTaskListFrame

protected

Definition at line 10 of file SCR_MapTaskListUI.c.

m_sTaskList

string SCR_MapTaskListUI::m_sTaskList

protected

Definition at line 13 of file SCR_MapTaskListUI.c.

m_sTaskListLayout

ResourceName SCR_MapTaskListUI::m_sTaskListLayout

protected

Definition at line 7 of file SCR_MapTaskListUI.c.

m_sTaskListToolMenuIconName

string SCR_MapTaskListUI::m_sTaskListToolMenuIconName

protected

Definition at line 4 of file SCR_MapTaskListUI.c.

m_TaskComponent

SCR_TaskListUIComponent SCR_MapTaskListUI::m_TaskComponent

protected

Definition at line 36 of file SCR_MapTaskListUI.c.

m_TaskUIManager

SCR_TaskManagerUIComponent SCR_MapTaskListUI::m_TaskUIManager

protected

Definition at line 32 of file SCR_MapTaskListUI.c.

m_ToolMenu

SCR_MapToolMenuUI SCR_MapTaskListUI::m_ToolMenu

protected

Definition at line 33 of file SCR_MapTaskListUI.c.

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapTaskListUI::m_ToolMenuEntry

protected

Definition at line 34 of file SCR_MapTaskListUI.c.

m_wTaskList

Widget SCR_MapTaskListUI::m_wTaskList

protected

Definition at line 30 of file SCR_MapTaskListUI.c.

m_wTaskListFrame

Widget SCR_MapTaskListUI::m_wTaskListFrame

protected

Definition at line 31 of file SCR_MapTaskListUI.c.

TASK_LIST_HUD_OFFSET

const float SCR_MapTaskListUI::TASK_LIST_HUD_OFFSET = -0.25

protected

Definition at line 28 of file SCR_MapTaskListUI.c.

---

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

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