SCR_TaskListUIComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_AssignableTaskTabStates

Enumerations
enum	SCR_ETaskTabType

Functions
enum SCR_ETaskTabType	BaseContainerProps (configRoot:true)
enum SCR_ETaskTabType	SCR_BaseContainerCustomTitleEnum (SCR_ETaskTabType, "m_eTabType")
SCR_AssignableTaskTabStates SCR_TaskTabStates	Attribute ("{B71975032150BAFB}UI/layouts/Task/TaskListEntry.layout", params:"layout")
override bool	IsTaskVisible (notnull SCR_Task task)
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
void	FocusOnEntry (SCR_Task task=null)
void	OnTabClicked (notnull SCR_ScriptedWidgetComponent comp)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
void	RequestRefreshFactionChange (SCR_Task task, FactionKey factionKey)
void	RefreshTaskList ()
	Get a list of all available to display tasks. If entry for task is already created, toggles its visibility, otherwise creates a new entry.
SCR_ETaskState	GetStateToCheck ()
bool	IsTaskVisibleInListByTab (notnull SCR_Task task)
void	InitializeTaskTabs ()
void	CreateTaskEntry (notnull SCR_Task task, Widget parent=null, SCR_ETaskTabType tabType=SCR_ETaskTabType.AVAILABLE)
void	ReparentTask (SCR_Task task)
void	UnfoldParent (notnull SCR_Task task)
void	OnTaskSelected (notnull SCR_Task task)
void	OnTaskAdded (SCR_Task task)
void	OnTaskRemoved (notnull SCR_Task task)
void	OnHideButton ()
	Triggered on hide tasks button clicked, hides task list.
void	OnTaskVisualChanged (SCR_Task task)
void	OnChildTaskChanged (SCR_Task task)
void	ExpandTask (notnull SCR_Task task, notnull SCR_TaskListEntryUIComponent taskUIComp)
void	CollapseTask ()
void	ShowTaskOnMap ()
	Opens map and moves camera to task location.
void	SetTaskListHeight (float size)
void	SetTaskListVisibility (bool show=false)
bool	GetTaskListVisibility ()
void	SetTaskDescriptionVisiblity (bool visibility)
bool	GetTaskDescriptionVisiblity ()
SCR_TaskListEntryDescriptionUIComponent	GetTaskDescription ()
ScriptInvokerVoid	GetOnButtonTaskListHide ()
void	AddAllowedTaskTypenames (notnull array< string > allowedTaskTypenames)

Variables
	AVAILABLE
	FINISHED
	AVAILABLE_ASSIGNABLE
	ALL
UI layouts Task TaskListTabEntry	layout
UI layouts Task TaskListTabEntry	params
ref array< ref SCR_TaskTabStates >	m_aTaskTabStates
SCR_ETaskTabType	m_eSelectedTab = SCR_ETaskTabType.AVAILABLE
SCR_Task	m_CurrentlySelectedTask
SCR_TaskListEntryDescriptionUIComponent	m_TaskListDescriptionComponent
SCR_TaskManagerUIComponent	m_TaskManager
SCR_TaskSystem	m_TaskSystem
SCR_MapEntity	m_MapEntity
SCR_MapCursorModule	m_MapCursorModule
ref map< SCR_Task, SCR_TaskListEntryUIComponent >	m_mTasksMap
ref ScriptInvokerVoid	m_OnButtonTaskListHide
ref SCR_TaskListWidgets	m_Widgets = new SCR_TaskListWidgets()
ref array< string >	m_aAllowedTaskTypenames = {}

Enumeration Type Documentation

SCR_ETaskTabType

enum SCR_ETaskTabType

Definition at line 1 of file SCR_TaskListUIComponent.c.

Function Documentation

AddAllowedTaskTypenames()

void AddAllowedTaskTypenames ( notnull array< string > allowedTaskTypenames )

protected

Adds allowed task typenames and only those will be shown

Parameters

[in]

allowedTaskTypenames

Definition at line 697 of file SCR_TaskListUIComponent.c.

Attribute()

SCR_AssignableTaskTabStates SCR_TaskTabStates Attribute	(	"{B71975032150BAFB}UI/layouts/Task/TaskListEntry.layout"	,
		params:"layout"	)

Definition at line 10 of file SCR_TaskListUIComponent.c.

BaseContainerProps()

enum SCR_ETaskTabType BaseContainerProps

(

configRoot:true

)

CollapseTask()

void CollapseTask ( )

protected

Hides task description.

Parameters

[in]

taskUIComp

UI component of collapsed task.

Definition at line 603 of file SCR_TaskListUIComponent.c.

CreateTaskEntry()

void CreateTaskEntry ( notnull SCR_Task task, Widget parent = null, SCR_ETaskTabType tabType = SCR_ETaskTabType.AVAILABLE )

protected

Creates new entry for task

Parameters

[in]	task	Task which will be initialized.
[in]	parent	Widget, to which newly created entry will be parented.

Definition at line 382 of file SCR_TaskListUIComponent.c.

ExpandTask()

void ExpandTask ( notnull SCR_Task task, notnull SCR_TaskListEntryUIComponent taskUIComp )

protected

Shows task description and initializes it with task data.

Parameters

[in]	task	Expanded task.
[in]	taskUIComp	Expanded task UI component.

Definition at line 586 of file SCR_TaskListUIComponent.c.

FocusOnEntry()

void FocusOnEntry ( SCR_Task task = null )

protected

Definition at line 144 of file SCR_TaskListUIComponent.c.

GetOnButtonTaskListHide()

ScriptInvokerVoid GetOnButtonTaskListHide ( )

protected

Definition at line 686 of file SCR_TaskListUIComponent.c.

GetStateToCheck()

SCR_ETaskState GetStateToCheck ( )

protected

Definition at line 327 of file SCR_TaskListUIComponent.c.

GetTaskDescription()

SCR_TaskListEntryDescriptionUIComponent GetTaskDescription ( )

protected

Returns

task description ui component

Definition at line 677 of file SCR_TaskListUIComponent.c.

GetTaskDescriptionVisiblity()

bool GetTaskDescriptionVisiblity ( )

protected

Returns

visibility of task description.

Definition at line 667 of file SCR_TaskListUIComponent.c.

GetTaskListVisibility()

bool GetTaskListVisibility ( )

protected

Returns

Visibility of task list

Definition at line 640 of file SCR_TaskListUIComponent.c.

HandlerAttached()

override void HandlerAttached ( Widget w )

protected

Definition at line 86 of file SCR_TaskListUIComponent.c.

HandlerDeattached()

override void HandlerDeattached ( Widget w )

protected

Definition at line 120 of file SCR_TaskListUIComponent.c.

InitializeTaskTabs()

void InitializeTaskTabs ( )

protected

Definition at line 353 of file SCR_TaskListUIComponent.c.

IsTaskVisible()

override bool Attribute::IsTaskVisible

(

notnull SCR_Task

task

)

Definition at line 63 of file SCR_TaskListUIComponent.c.

IsTaskVisibleInListByTab()

bool IsTaskVisibleInListByTab ( notnull SCR_Task task )

protected

Definition at line 341 of file SCR_TaskListUIComponent.c.

OnChildTaskChanged()

void OnChildTaskChanged ( SCR_Task task )

protected

Triggered when task is added as a child

Parameters

[in]

task

Changed task.

Definition at line 577 of file SCR_TaskListUIComponent.c.

OnHideButton()

void OnHideButton ( )

protected

Triggered on hide tasks button clicked, hides task list.

Definition at line 555 of file SCR_TaskListUIComponent.c.

OnMouseEnter()

override bool OnMouseEnter ( Widget w, int x, int y )

protected

Definition at line 205 of file SCR_TaskListUIComponent.c.

OnMouseLeave()

override bool OnMouseLeave ( Widget w, Widget enterW, int x, int y )

protected

Definition at line 225 of file SCR_TaskListUIComponent.c.

OnTabClicked()

void OnTabClicked ( notnull SCR_ScriptedWidgetComponent comp )

protected

Definition at line 170 of file SCR_TaskListUIComponent.c.

OnTaskAdded()

void OnTaskAdded ( SCR_Task task )

protected

Invoked whenever new task is added to the system. Creates entry for it.

Parameters

[in]

task

Added task.

Definition at line 502 of file SCR_TaskListUIComponent.c.

OnTaskRemoved()

void OnTaskRemoved ( notnull SCR_Task task )

protected

Invoked whenever task is removed from the system. Removes entry from task list.

Parameters

[in]

task

Removed task.

Definition at line 528 of file SCR_TaskListUIComponent.c.

OnTaskSelected()

void OnTaskSelected ( notnull SCR_Task task )

protected

Invoked whenever task is selected in manager. Controls display of task description.

Parameters

[in]

task

Selected task.

Definition at line 477 of file SCR_TaskListUIComponent.c.

OnTaskVisualChanged()

void OnTaskVisualChanged ( SCR_Task task )

protected

Triggered task SCR_UIInfo is changed. Reinitializes task description with new data.

Parameters

[in]

task

Changed task.

Definition at line 569 of file SCR_TaskListUIComponent.c.

RefreshTaskList()

void RefreshTaskList ( )

protected

Get a list of all available to display tasks. If entry for task is already created, toggles its visibility, otherwise creates a new entry.

Definition at line 257 of file SCR_TaskListUIComponent.c.

ReparentTask()

void ReparentTask ( SCR_Task task )

protected

Reparents task to keep hierachy.

Parameters

[in]

task

to be evaulated

Definition at line 426 of file SCR_TaskListUIComponent.c.

RequestRefreshFactionChange()

void RequestRefreshFactionChange ( SCR_Task task, FactionKey factionKey )

protected

Request refresh of task list on task faction change

Parameters

[in]	task	which faction was changed
[in]	factionKey	of adjusted faction

Definition at line 250 of file SCR_TaskListUIComponent.c.

SCR_BaseContainerCustomTitleEnum()

enum SCR_ETaskTabType SCR_BaseContainerCustomTitleEnum	(	SCR_ETaskTabType	,
		"m_eTabType"	)

Definition at line 10 of file SCR_TaskListUIComponent.c.

SetTaskDescriptionVisiblity()

void SetTaskDescriptionVisiblity ( bool visibility )

protected

Parameters

[in]

visibility

of task description.

Definition at line 647 of file SCR_TaskListUIComponent.c.

SetTaskListHeight()

void SetTaskListHeight ( float size )

protected

Sets height of task list.

Parameters

[in]

size

New height of task list.

Definition at line 625 of file SCR_TaskListUIComponent.c.

SetTaskListVisibility()

void SetTaskListVisibility ( bool show = false )

protected

Sets visibility of task list.

Parameters

[in]

size

New visibility of task list.

Definition at line 633 of file SCR_TaskListUIComponent.c.

ShowTaskOnMap()

void ShowTaskOnMap ( )

protected

Opens map and moves camera to task location.

Definition at line 617 of file SCR_TaskListUIComponent.c.

UnfoldParent()

void UnfoldParent ( notnull SCR_Task task )

protected

Invoked whenever task entry on list is selected. Triggers selection in manager.

Parameters

[in]

task

Selected task.

Definition at line 462 of file SCR_TaskListUIComponent.c.

Variable Documentation

ALL

@ ALL

Definition at line 3 of file SCR_TaskListUIComponent.c.

AVAILABLE

AVAILABLE

Definition at line 0 of file SCR_TaskListUIComponent.c.

AVAILABLE_ASSIGNABLE

AVAILABLE_ASSIGNABLE

Definition at line 2 of file SCR_TaskListUIComponent.c.

FINISHED

@ FINISHED

Definition at line 1 of file SCR_TaskListUIComponent.c.

layout

UI layouts Task TaskListTabEntry layout

Definition at line 64 of file SCR_TaskListUIComponent.c.

m_aAllowedTaskTypenames

ref array<string> m_aAllowedTaskTypenames = {}

protected

Definition at line 83 of file SCR_TaskListUIComponent.c.

m_aTaskTabStates

ref array<ref SCR_TaskTabStates> m_aTaskTabStates

protected

Definition at line 68 of file SCR_TaskListUIComponent.c.

m_CurrentlySelectedTask

SCR_Task m_CurrentlySelectedTask

protected

Definition at line 72 of file SCR_TaskListUIComponent.c.

m_eSelectedTab

SCR_ETaskTabType m_eSelectedTab = SCR_ETaskTabType.AVAILABLE

protected

Definition at line 70 of file SCR_TaskListUIComponent.c.

m_MapCursorModule

SCR_MapCursorModule m_MapCursorModule

protected

Definition at line 78 of file SCR_TaskListUIComponent.c.

m_MapEntity

SCR_MapEntity m_MapEntity

protected

Definition at line 77 of file SCR_TaskListUIComponent.c.

m_mTasksMap

ref map<SCR_Task, SCR_TaskListEntryUIComponent> m_mTasksMap

protected

Definition at line 80 of file SCR_TaskListUIComponent.c.

m_OnButtonTaskListHide

ref ScriptInvokerVoid m_OnButtonTaskListHide

protected

Definition at line 81 of file SCR_TaskListUIComponent.c.

m_TaskListDescriptionComponent

SCR_TaskListEntryDescriptionUIComponent m_TaskListDescriptionComponent

protected

Definition at line 73 of file SCR_TaskListUIComponent.c.

m_TaskManager

SCR_TaskManagerUIComponent m_TaskManager

protected

Definition at line 74 of file SCR_TaskListUIComponent.c.

m_TaskSystem

SCR_TaskSystem m_TaskSystem

protected

Definition at line 76 of file SCR_TaskListUIComponent.c.

m_Widgets

ref SCR_TaskListWidgets m_Widgets = new SCR_TaskListWidgets()

protected

Definition at line 82 of file SCR_TaskListUIComponent.c.

params

UI layouts Task TaskListTabEntry params

Definition at line 64 of file SCR_TaskListUIComponent.c.