SCR_MapTaskListUI Interface Reference

Inheritance diagram for SCR_MapTaskListUI:

Public Member Functions
override void	Init ()
	Register task list button to the tools menu.
override void	Update (float timeSlice)
	Update method for frame operations.
void	SetMapContextAllowed (bool val)
void	ToggleTaskList (bool visibility)
	Toggle task list visibility.
override void	HandlerDeattached (Widget w)
bool	IsTaskListVisible ()
bool	CanShowAssignGroupList ()
	return true if can show assign group list
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
bool	IsExclusive ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Protected Member Functions
override void	OnMapOpen (MapConfiguration config)
	Recreate task list on map open.
override void	OnMapClose (MapConfiguration config)
	Destroy task list on map close.
void	CreateTaskList (Widget parent=null)
	Create task list.
void	UpdateTaskListHeight ()
	Update task list height to match tools menu height.
void	ToggleTaskListListener ()
	Toggle task list visibility.
void	OnMapTaskListClicked (notnull SCR_ButtonBaseComponent comp)
	Triggered on task list button clicked on tools menu.
void	OnButtonTaskListHide ()
void	OnInputDeviceIsGamepad (bool isGamepad)
void	DisableMapUIComponent ()

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
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
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bIsExclusive
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Static Protected Attributes
const string	ICON_NAME = "faction"
const float	TASK_LIST_HUD_OFFSET = -0.25
const string	CONTEXT_ASSIGN_GROUP_LIST = "TaskAssignGroupListContext"
const string	ACTION_OPEN_TASK_LIST = "TasksOpen"

Member Function Documentation

CanShowAssignGroupList()

bool SCR_MapTaskListUI.CanShowAssignGroupList

(

)

return true if can show assign group list

CreateTaskList()

void SCR_MapTaskListUI.CreateTaskList ( Widget parent = null )

protected

Create task list.

Parameters

[in]

parent

of the task list.

DisableMapUIComponent()

void SCR_MapTaskListUI.DisableMapUIComponent ( )

protected

HandlerDeattached()

override void SCR_MapTaskListUI.HandlerDeattached

(

Widget

w

)

Init()

override void SCR_MapTaskListUI.Init

(

)

Register task list button to the tools menu.

Implements SCR_MapUIBaseComponent.

IsTaskListVisible()

bool SCR_MapTaskListUI.IsTaskListVisible

(

)

OnButtonTaskListHide()

void SCR_MapTaskListUI.OnButtonTaskListHide ( )

protected

OnInputDeviceIsGamepad()

void SCR_MapTaskListUI.OnInputDeviceIsGamepad ( bool isGamepad )

protected

OnMapClose()

override void SCR_MapTaskListUI.OnMapClose ( MapConfiguration config )

protected

Destroy task list on map close.

Parameters

[in]

config

of the map.

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapTaskListUI.OnMapOpen ( MapConfiguration config )

protected

Recreate task list on map open.

Parameters

[in]

config

of the map.

Implements SCR_MapUIBaseComponent.

OnMapTaskListClicked()

void SCR_MapTaskListUI.OnMapTaskListClicked ( notnull SCR_ButtonBaseComponent comp )

protected

Triggered on task list button clicked on tools menu.

Toggles off visuals of other buttons.

Parameters

[in]

comp

button component

SetMapContextAllowed()

void SCR_MapTaskListUI.SetMapContextAllowed

(

bool

val

)

Parameters

[in]

val

ToggleTaskList()

void SCR_MapTaskListUI.ToggleTaskList

(

bool

visibility

)

Toggle task list visibility.

Parameters

[in]

visibility

new visibility of task list

ToggleTaskListListener()

void SCR_MapTaskListUI.ToggleTaskListListener ( )

protected

Toggle task list visibility.

Update()

override void SCR_MapTaskListUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

UpdateTaskListHeight()

void SCR_MapTaskListUI.UpdateTaskListHeight ( )

protected

Update task list height to match tools menu height.

Member Data Documentation

ACTION_OPEN_TASK_LIST

const string SCR_MapTaskListUI.ACTION_OPEN_TASK_LIST = "TasksOpen"

staticprotected

CONTEXT_ASSIGN_GROUP_LIST

const string SCR_MapTaskListUI.CONTEXT_ASSIGN_GROUP_LIST = "TaskAssignGroupListContext"

staticprotected

ICON_NAME

const string SCR_MapTaskListUI.ICON_NAME = "faction"

staticprotected

m_aAllowedTaskTypenames

ref array<string> SCR_MapTaskListUI.m_aAllowedTaskTypenames

protected

m_bMapContextAllowed

bool SCR_MapTaskListUI.m_bMapContextAllowed

protected

m_bOpened

bool SCR_MapTaskListUI.m_bOpened

protected

m_bShowAllTaskTypenames

bool SCR_MapTaskListUI.m_bShowAllTaskTypenames

protected

m_bShowAssignGroupList

bool SCR_MapTaskListUI.m_bShowAssignGroupList

protected

m_iOffset

int SCR_MapTaskListUI.m_iOffset

protected

m_sMapTaskListFrame

string SCR_MapTaskListUI.m_sMapTaskListFrame

protected

m_sTaskList

string SCR_MapTaskListUI.m_sTaskList

protected

m_sTaskListLayout

ResourceName SCR_MapTaskListUI.m_sTaskListLayout

protected

m_sTaskListToolMenuIconName

string SCR_MapTaskListUI.m_sTaskListToolMenuIconName

protected

m_TaskComponent

SCR_TaskListUIComponent SCR_MapTaskListUI.m_TaskComponent

protected

m_TaskUIManager

SCR_TaskManagerUIComponent SCR_MapTaskListUI.m_TaskUIManager

protected

m_ToolMenu

SCR_MapToolMenuUI SCR_MapTaskListUI.m_ToolMenu

protected

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapTaskListUI.m_ToolMenuEntry

protected

m_wTaskList

Widget SCR_MapTaskListUI.m_wTaskList

protected

m_wTaskListFrame

Widget SCR_MapTaskListUI.m_wTaskListFrame

protected

TASK_LIST_HUD_OFFSET

const float SCR_MapTaskListUI.TASK_LIST_HUD_OFFSET = -0.25

staticprotected

---

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

• Game/Map/ComponentsUI/SCR_MapTaskListUI.c