Inheritance diagram for SCR_TaskListUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

void	FocusOnEntry (SCR_Task task=null)

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)
	Request refresh of task list on task faction change.

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.

void	CollapseTask ()
	Hides task description.

void	SetTaskListHeight (float size)
	Sets height of task list.

void	SetTaskListVisibility (bool show=false)
	Sets visibility of task list.

bool	GetTaskListVisibility ()

void	SetTaskDescriptionVisiblity (bool visibility)

bool	GetTaskDescriptionVisiblity ()

SCR_TaskListEntryDescriptionUIComponent	GetTaskDescription ()

ScriptInvokerVoid	GetOnButtonTaskListHide ()

void	AddAllowedTaskTypenames (notnull array< string > allowedTaskTypenames)
	Adds allowed task typenames and only those will be shown.

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override bool	OnClick (Widget w, int x, int y, int button)

Widget	GetRootWidget ()

bool	IsVisible ()

Protected Member Functions
void	OnTabClicked (notnull SCR_ScriptedWidgetComponent comp)

SCR_ETaskState	GetStateToCheck ()

void	InititializeTaskTabs ()

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

void	ReparentTask (SCR_Task task)
	Reparents task to keep hierachy.

void	UnfoldParent (notnull SCR_Task task)
	Invoked whenever task entry on list is selected.

void	OnTaskSelected (notnull SCR_Task task)
	Invoked whenever task is selected in manager.

void	OnTaskAdded (SCR_Task task)
	Invoked whenever new task is added to the system.

void	OnTaskRemoved (notnull SCR_Task task)
	Invoked whenever task is removed from the system.

void	OnHideButton ()
	Triggered on hide tasks button clicked, hides task list.

void	OnTaskVisualChanged (SCR_Task task)
	Triggered task SCR_UIInfo is changed.

void	OnChildTaskChanged (SCR_Task task)
	Triggered when task is added as a child.

void	ExpandTask (notnull SCR_Task task, notnull SCR_TaskListEntryUIComponent taskUIComp)
	Shows task description and initializes it with task data.

void	ShowTaskOnMap ()
	Opens map and moves camera to task location.

Protected Attributes
ResourceName	m_sTaskListEntryLayout

ResourceName	m_sTaskTabEntryLayout

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 = {}

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

◆ AddAllowedTaskTypenames()

void SCR_TaskListUIComponent.AddAllowedTaskTypenames ( notnull array< string > allowedTaskTypenames )

Adds allowed task typenames and only those will be shown.

Parameters

[in] allowedTaskTypenames

◆ CollapseTask()

void SCR_TaskListUIComponent.CollapseTask ( )

Hides task description.

Parameters

[in] taskUIComp UI component of collapsed task.

◆ CreateTaskEntry()

void SCR_TaskListUIComponent.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.

◆ ExpandTask()

void SCR_TaskListUIComponent.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.

◆ FocusOnEntry()

void SCR_TaskListUIComponent.FocusOnEntry ( SCR_Task task = null )

◆ GetOnButtonTaskListHide()

ScriptInvokerVoid SCR_TaskListUIComponent.GetOnButtonTaskListHide ( )

◆ GetStateToCheck()

SCR_ETaskState SCR_TaskListUIComponent.GetStateToCheck ( )

protected

◆ GetTaskDescription()

SCR_TaskListEntryDescriptionUIComponent SCR_TaskListUIComponent.GetTaskDescription ( )

Returns: task description ui component

◆ GetTaskDescriptionVisiblity()

bool SCR_TaskListUIComponent.GetTaskDescriptionVisiblity ( )

Returns: visibility of task description.

◆ GetTaskListVisibility()

bool SCR_TaskListUIComponent.GetTaskListVisibility ( )

Returns: Visibility of task list

◆ HandlerAttached()

override void SCR_TaskListUIComponent.HandlerAttached ( Widget w )

Implements SCR_ScriptedWidgetComponent.

◆ HandlerDeattached()

override void SCR_TaskListUIComponent.HandlerDeattached ( Widget w )

◆ InititializeTaskTabs()

void SCR_TaskListUIComponent.InititializeTaskTabs ( )

protected

◆ OnChildTaskChanged()

void SCR_TaskListUIComponent.OnChildTaskChanged ( SCR_Task task )

protected

Triggered when task is added as a child.

Parameters

[in] task Changed task.

◆ OnHideButton()

void SCR_TaskListUIComponent.OnHideButton ( )

protected

Triggered on hide tasks button clicked, hides task list.

◆ OnMouseEnter()

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

◆ OnMouseLeave()

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

◆ OnTabClicked()

void SCR_TaskListUIComponent.OnTabClicked ( notnull SCR_ScriptedWidgetComponent comp )

protected

◆ OnTaskAdded()

void SCR_TaskListUIComponent.OnTaskAdded ( SCR_Task task )

protected

Invoked whenever new task is added to the system.

Creates entry for it.

Parameters

[in] task Added task.

◆ OnTaskRemoved()

void SCR_TaskListUIComponent.OnTaskRemoved ( notnull SCR_Task task )

protected

Invoked whenever task is removed from the system.

Removes entry from task list.

Parameters

[in] task Removed task.

◆ OnTaskSelected()

void SCR_TaskListUIComponent.OnTaskSelected ( notnull SCR_Task task )

protected

Invoked whenever task is selected in manager.

Controls display of task description.

Parameters

[in] task Selected task.

◆ OnTaskVisualChanged()

void SCR_TaskListUIComponent.OnTaskVisualChanged ( SCR_Task task )

protected

Triggered task SCR_UIInfo is changed.

Reinitializes task description with new data.

Parameters

[in] task Changed task.

◆ RefreshTaskList()

void SCR_TaskListUIComponent.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.

◆ ReparentTask()

void SCR_TaskListUIComponent.ReparentTask ( SCR_Task task )

protected

Reparents task to keep hierachy.

Parameters

[in] task to be evaulated

◆ RequestRefreshFactionChange()

void SCR_TaskListUIComponent.RequestRefreshFactionChange	(	SCR_Task	task,
		FactionKey	factionKey )

Request refresh of task list on task faction change.

Parameters

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

◆ SetTaskDescriptionVisiblity()

void SCR_TaskListUIComponent.SetTaskDescriptionVisiblity ( bool visibility )

Parameters

[in] visibility of task description.

◆ SetTaskListHeight()

void SCR_TaskListUIComponent.SetTaskListHeight ( float size )

Sets height of task list.

Parameters

[in] size New height of task list.

◆ SetTaskListVisibility()

void SCR_TaskListUIComponent.SetTaskListVisibility ( bool show = false )

Sets visibility of task list.

Parameters

[in] size New visibility of task list.

◆ ShowTaskOnMap()

void SCR_TaskListUIComponent.ShowTaskOnMap ( )

protected

Opens map and moves camera to task location.

◆ UnfoldParent()

void SCR_TaskListUIComponent.UnfoldParent ( notnull SCR_Task task )

protected

Invoked whenever task entry on list is selected.

Triggers selection in manager.

Parameters

[in] task Selected task.

Member Data Documentation

◆ m_aAllowedTaskTypenames

ref array<string> SCR_TaskListUIComponent.m_aAllowedTaskTypenames = {}

protected

◆ m_aTaskTabStates

ref array<ref SCR_TaskTabStates> SCR_TaskListUIComponent.m_aTaskTabStates

protected

◆ m_CurrentlySelectedTask

SCR_Task SCR_TaskListUIComponent.m_CurrentlySelectedTask

protected

◆ m_eSelectedTab

SCR_ETaskTabType SCR_TaskListUIComponent.m_eSelectedTab = SCR_ETaskTabType.AVAILABLE

protected

◆ m_MapCursorModule

SCR_MapCursorModule SCR_TaskListUIComponent.m_MapCursorModule

protected

◆ m_MapEntity

SCR_MapEntity SCR_TaskListUIComponent.m_MapEntity

protected

◆ m_mTasksMap

ref map<SCR_Task, SCR_TaskListEntryUIComponent> SCR_TaskListUIComponent.m_mTasksMap

protected

◆ m_OnButtonTaskListHide

ref ScriptInvokerVoid SCR_TaskListUIComponent.m_OnButtonTaskListHide

protected

◆ m_sTaskListEntryLayout

ResourceName SCR_TaskListUIComponent.m_sTaskListEntryLayout

protected

◆ m_sTaskTabEntryLayout

ResourceName SCR_TaskListUIComponent.m_sTaskTabEntryLayout

protected

◆ m_TaskListDescriptionComponent

SCR_TaskListEntryDescriptionUIComponent SCR_TaskListUIComponent.m_TaskListDescriptionComponent

protected

◆ m_TaskManager

SCR_TaskManagerUIComponent SCR_TaskListUIComponent.m_TaskManager

protected

◆ m_TaskSystem

SCR_TaskSystem SCR_TaskListUIComponent.m_TaskSystem

protected

◆ m_Widgets

ref SCR_TaskListWidgets SCR_TaskListUIComponent.m_Widgets = new SCR_TaskListWidgets()

protected

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

Game/UI/Tasks/SCR_TaskListUIComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AddAllowedTaskTypenames()

◆ CollapseTask()

◆ CreateTaskEntry()

◆ ExpandTask()

◆ FocusOnEntry()

◆ GetOnButtonTaskListHide()

◆ GetStateToCheck()

◆ GetTaskDescription()

◆ GetTaskDescriptionVisiblity()

◆ GetTaskListVisibility()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ InititializeTaskTabs()

◆ OnChildTaskChanged()

◆ OnHideButton()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ OnTabClicked()

◆ OnTaskAdded()

◆ OnTaskRemoved()

◆ OnTaskSelected()

◆ OnTaskVisualChanged()

◆ RefreshTaskList()

◆ ReparentTask()

◆ RequestRefreshFactionChange()

◆ SetTaskDescriptionVisiblity()

◆ SetTaskListHeight()

◆ SetTaskListVisibility()

◆ ShowTaskOnMap()

◆ UnfoldParent()

Member Data Documentation

◆ m_aAllowedTaskTypenames

◆ m_aTaskTabStates

◆ m_CurrentlySelectedTask

◆ m_eSelectedTab

◆ m_MapCursorModule

◆ m_MapEntity

◆ m_mTasksMap

◆ m_OnButtonTaskListHide

◆ m_sTaskListEntryLayout

◆ m_sTaskTabEntryLayout

◆ m_TaskListDescriptionComponent

◆ m_TaskManager

◆ m_TaskSystem

◆ m_Widgets