Inheritance diagram for SCR_TaskListEntryDescriptionUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

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

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

void	InitDescription (notnull SCR_Task task)
	Update buttons visibility based on task data.

bool	IsAssignGroupListOpened ()

void	UpdateTask ()
	Set task icon and title to the ones set in tasks' SCR_TaskUIInfo.

void	SetFactionColors ()
	Updates task visuals to color of players faction.

void	UpdateTaskIconColors (Color backgroundColor, Color iconColor, Color outlineColor)
	Sets task icon colors.

void	SetTaskIconColors (Color backgroundColor=null, Color iconColor=null, Color outlineColor=null)
	Sets task icon colors.

void	SetTaskBackground (ResourceName imageset, string name)
	Sets new background of task.

void	SetChildTaskText (string text)

void	SetVisibility (bool show)
	Sets visibility of entry.

SCR_Task	GetCurrentTask ()

ScriptInvokerVoid	GetOnButtonShowOnMap ()

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	InitAssignGroupList (Widget w)

void	DeinitAssignGroupList (Widget w)

void	OnButtonAssign ()

void	OnButtonShowOnMap ()

void	UpdateAssignees (notnull SCR_Task task, SCR_TaskExecutor newAssignee=null, int requesterID=0)
	Updates entities assigned to task.

void	AddPlayerAssignee (notnull SCR_TaskExecutorPlayer assignedPlayer, notnull SCR_TaskExecutor player)
	Adds a player type assignee to the task.

void	AddGroupAssignee (notnull SCR_TaskExecutorGroup assignedGroup, notnull SCR_TaskExecutor group, notnull SCR_AIGroup aiGroup)
	Adds a group type assignee to the task.

void	CreateAssignedPlayerEntry (string playerName, int playerID)
	Creates label for player assigned to task.

void	CreateAssignedGroupEntry (int groupID, Faction groupFaction, SCR_AIGroup aiGroup)
	Creates group label for group assigned to task.

void	CheckOverflow (Widget w)

void	CreateTaskEntry (SCR_Task task, Widget parent=null, bool isChild=false)
	Creates new entry for task.

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

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

void	OnTaskUIVisibilityChanged (SCR_Task task, SCR_ETaskUIVisibility visible)
	Invoked when task visual data is changed.

void	OnTaskVisibilityChanged (SCR_Task task, SCR_ETaskVisibility visible)
	Invoked when task visibility is changed.

void	OnTaskOwnershipChanged (SCR_Task task, SCR_ETaskOwnership ownership)
	Invoked when task ownership is changed.

void	OnButtonOpenAssignGroupListActivated (SCR_InputButtonComponent button, string action)
	Invoked when open assign group list button is activated by action.

void	OnAssignGroupListOpened ()
	Invoked when assign group list is opened.

void	OnAssignGroupListClosed ()
	Invoked when assign group list is closed.

void	OnTaskHUDVisible (bool visible)

void	HandleTaskStateVisuals (SCR_ETaskState state)
	Sets task visuals based on new state of task.

Protected Attributes
ResourceName	m_sTaskListEntry

ResourceName	m_sAssignedPlayerEntry

ResourceName	m_sAssignedGroupEntry

string	m_sUnassignTaskText

string	m_sAssignTaskText

string	m_sTaskCancelled

string	m_sTaskFailed

string	m_sTaskCompleted

ref Color	m_TaskStateNegative

ref Color	m_TaskStatePositive

int	m_iOffsetY = 4

bool	m_bIsOverflowing

ref ScriptInvokerVoid	m_OnButtonTaskAssign

ref ScriptInvokerVoid	m_OnButtonShowOnMap

ref Color	m_IconColor

ref Color	m_OutlineColor

ref Color	m_BackgroundColor

SCR_TaskListEntryUIComponent	m_TaskComponent

SCR_TaskManagerUIComponent	m_TaskManager

SCR_TaskSystem	m_TaskSystem

SCR_Task	m_Task

SCR_MapEntity	m_MapEntity

SCR_MapCursorModule	m_MapCursorModule

ref SCR_TaskListEntryDescriptionWidgets	m_Widgets = new SCR_TaskListEntryDescriptionWidgets()

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

◆ AddGroupAssignee()

void SCR_TaskListEntryDescriptionUIComponent.AddGroupAssignee	(	notnull SCR_TaskExecutorGroup	assignedGroup,
		notnull SCR_TaskExecutor	group,
		notnull SCR_AIGroup	aiGroup )

protected

Adds a group type assignee to the task.

Parameters

[in]	assignedGroup	to be added
[in]	group
[in]	aiGroup

◆ AddPlayerAssignee()

void SCR_TaskListEntryDescriptionUIComponent.AddPlayerAssignee	(	notnull SCR_TaskExecutorPlayer	assignedPlayer,
		notnull SCR_TaskExecutor	player )

protected

Adds a player type assignee to the task.

Parameters

[in]	assignedPlayer	to be added
[in]	player

◆ CheckOverflow()

void SCR_TaskListEntryDescriptionUIComponent.CheckOverflow ( Widget w )

protected

◆ CreateAssignedGroupEntry()

void SCR_TaskListEntryDescriptionUIComponent.CreateAssignedGroupEntry	(	int	groupID,
		Faction	groupFaction,
		SCR_AIGroup	aiGroup )

protected

Creates group label for group assigned to task.

Parameters

[in]	groupID
[in]	groupFaction
[in]	aiGroup

◆ CreateAssignedPlayerEntry()

void SCR_TaskListEntryDescriptionUIComponent.CreateAssignedPlayerEntry	(	string	playerName,
		int	playerID )

protected

Creates label for player assigned to task.

Parameters

[in]	playerName
[in]	playerID

◆ CreateTaskEntry()

void SCR_TaskListEntryDescriptionUIComponent.CreateTaskEntry	(	SCR_Task	task,
		Widget	parent = null,
		bool	isChild = false )

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.

◆ DeinitAssignGroupList()

void SCR_TaskListEntryDescriptionUIComponent.DeinitAssignGroupList ( Widget w )

protected

◆ GetCurrentTask()

SCR_Task SCR_TaskListEntryDescriptionUIComponent.GetCurrentTask ( )

◆ GetOnButtonShowOnMap()

ScriptInvokerVoid SCR_TaskListEntryDescriptionUIComponent.GetOnButtonShowOnMap ( )

◆ HandlerAttached()

override void SCR_TaskListEntryDescriptionUIComponent.HandlerAttached ( Widget w )

Implements SCR_ScriptedWidgetComponent.

◆ HandlerDeattached()

override void SCR_TaskListEntryDescriptionUIComponent.HandlerDeattached ( Widget w )

◆ HandleTaskStateVisuals()

void SCR_TaskListEntryDescriptionUIComponent.HandleTaskStateVisuals ( SCR_ETaskState state )

protected

Sets task visuals based on new state of task.

Parameters

[in] state New state of task.

◆ InitAssignGroupList()

void SCR_TaskListEntryDescriptionUIComponent.InitAssignGroupList ( Widget w )

protected

◆ InitDescription()

void SCR_TaskListEntryDescriptionUIComponent.InitDescription ( notnull SCR_Task task )

Update buttons visibility based on task data.

Set task visuals.

Parameters

[in] task

◆ IsAssignGroupListOpened()

bool SCR_TaskListEntryDescriptionUIComponent.IsAssignGroupListOpened ( )

Returns: true if assing group list is opened

◆ OnAssignGroupListClosed()

void SCR_TaskListEntryDescriptionUIComponent.OnAssignGroupListClosed ( )

protected

Invoked when assign group list is closed.

◆ OnAssignGroupListOpened()

void SCR_TaskListEntryDescriptionUIComponent.OnAssignGroupListOpened ( )

protected

Invoked when assign group list is opened.

◆ OnButtonAssign()

void SCR_TaskListEntryDescriptionUIComponent.OnButtonAssign ( )

protected

◆ OnButtonOpenAssignGroupListActivated()

void SCR_TaskListEntryDescriptionUIComponent.OnButtonOpenAssignGroupListActivated	(	SCR_InputButtonComponent	button,
		string	action )

protected

Invoked when open assign group list button is activated by action.

◆ OnButtonShowOnMap()

void SCR_TaskListEntryDescriptionUIComponent.OnButtonShowOnMap ( )

protected

◆ OnMouseEnter()

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

◆ OnMouseLeave()

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

◆ OnTaskEntrySelected()

void SCR_TaskListEntryDescriptionUIComponent.OnTaskEntrySelected ( SCR_Task task )

protected

Invoked whenever task entry on list is selected.

Triggers selection in manager.

Parameters

[in] task Selected task.

◆ OnTaskHUDVisible()

void SCR_TaskListEntryDescriptionUIComponent.OnTaskHUDVisible ( bool visible )

protected

◆ OnTaskOwnershipChanged()

void SCR_TaskListEntryDescriptionUIComponent.OnTaskOwnershipChanged	(	SCR_Task	task,
		SCR_ETaskOwnership	ownership )

protected

Invoked when task ownership is changed.

◆ OnTaskUIVisibilityChanged()

void SCR_TaskListEntryDescriptionUIComponent.OnTaskUIVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskUIVisibility	visible )

protected

Invoked when task visual data is changed.

◆ OnTaskVisibilityChanged()

void SCR_TaskListEntryDescriptionUIComponent.OnTaskVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskVisibility	visible )

protected

Invoked when task visibility is changed.

◆ OnTaskVisualChanged()

void SCR_TaskListEntryDescriptionUIComponent.OnTaskVisualChanged ( SCR_Task task )

protected

Triggered task SCR_UIInfo is changed.

Reinitializes task description with new data.

Parameters

[in] task Changed task.

◆ SetChildTaskText()

void SCR_TaskListEntryDescriptionUIComponent.SetChildTaskText ( string text )

◆ SetFactionColors()

void SCR_TaskListEntryDescriptionUIComponent.SetFactionColors ( )

Updates task visuals to color of players faction.

◆ SetTaskBackground()

void SCR_TaskListEntryDescriptionUIComponent.SetTaskBackground	(	ResourceName	imageset,
		string	name )

Sets new background of task.

Parameters

[in]	imageset	with the background.
[in]	name	in imageset.

◆ SetTaskIconColors()

void SCR_TaskListEntryDescriptionUIComponent.SetTaskIconColors	(	Color	backgroundColor = null,
		Color	iconColor = null,
		Color	outlineColor = null )

Sets task icon colors.

Parameters

[in]	Color	of background
[in]	Color	of icon
[in]	Color	of outline

◆ SetVisibility()

void SCR_TaskListEntryDescriptionUIComponent.SetVisibility ( bool show )

Sets visibility of entry.

Parameters

[in] show New visibility

◆ UpdateAssignees()

void SCR_TaskListEntryDescriptionUIComponent.UpdateAssignees	(	notnull SCR_Task	task,
		SCR_TaskExecutor	newAssignee = null,
		int	requesterID = 0 )

protected

Updates entities assigned to task.

If player is assigned, changes task background color.

Parameters

[in]	task
[in]	newAssignee
[in]	requesterID

◆ UpdateTask()

void SCR_TaskListEntryDescriptionUIComponent.UpdateTask ( )

Set task icon and title to the ones set in tasks' SCR_TaskUIInfo.

◆ UpdateTaskIconColors()

void SCR_TaskListEntryDescriptionUIComponent.UpdateTaskIconColors	(	Color	backgroundColor,
		Color	iconColor,
		Color	outlineColor )

Sets task icon colors.

Parameters

[in]	Color	of background
[in]	Color	of icon
[in]	Color	of outline

Member Data Documentation

◆ m_BackgroundColor

ref Color SCR_TaskListEntryDescriptionUIComponent.m_BackgroundColor

protected

◆ m_bIsOverflowing

bool SCR_TaskListEntryDescriptionUIComponent.m_bIsOverflowing

protected

◆ m_IconColor

ref Color SCR_TaskListEntryDescriptionUIComponent.m_IconColor

protected

◆ m_iOffsetY

int SCR_TaskListEntryDescriptionUIComponent.m_iOffsetY = 4

protected

◆ m_MapCursorModule

SCR_MapCursorModule SCR_TaskListEntryDescriptionUIComponent.m_MapCursorModule

protected

◆ m_MapEntity

SCR_MapEntity SCR_TaskListEntryDescriptionUIComponent.m_MapEntity

protected

◆ m_OnButtonShowOnMap

ref ScriptInvokerVoid SCR_TaskListEntryDescriptionUIComponent.m_OnButtonShowOnMap

protected

◆ m_OnButtonTaskAssign

ref ScriptInvokerVoid SCR_TaskListEntryDescriptionUIComponent.m_OnButtonTaskAssign

protected

◆ m_OutlineColor

ref Color SCR_TaskListEntryDescriptionUIComponent.m_OutlineColor

protected

◆ m_sAssignedGroupEntry

ResourceName SCR_TaskListEntryDescriptionUIComponent.m_sAssignedGroupEntry

protected

◆ m_sAssignedPlayerEntry

ResourceName SCR_TaskListEntryDescriptionUIComponent.m_sAssignedPlayerEntry

protected

◆ m_sAssignTaskText

string SCR_TaskListEntryDescriptionUIComponent.m_sAssignTaskText

protected

◆ m_sTaskCancelled

string SCR_TaskListEntryDescriptionUIComponent.m_sTaskCancelled

protected

◆ m_sTaskCompleted

string SCR_TaskListEntryDescriptionUIComponent.m_sTaskCompleted

protected

◆ m_sTaskFailed

string SCR_TaskListEntryDescriptionUIComponent.m_sTaskFailed

protected

◆ m_sTaskListEntry

ResourceName SCR_TaskListEntryDescriptionUIComponent.m_sTaskListEntry

protected

◆ m_sUnassignTaskText

string SCR_TaskListEntryDescriptionUIComponent.m_sUnassignTaskText

protected

◆ m_Task

SCR_Task SCR_TaskListEntryDescriptionUIComponent.m_Task

protected

◆ m_TaskComponent

SCR_TaskListEntryUIComponent SCR_TaskListEntryDescriptionUIComponent.m_TaskComponent

protected

◆ m_TaskManager

SCR_TaskManagerUIComponent SCR_TaskListEntryDescriptionUIComponent.m_TaskManager

protected

◆ m_TaskStateNegative

ref Color SCR_TaskListEntryDescriptionUIComponent.m_TaskStateNegative

protected

◆ m_TaskStatePositive

ref Color SCR_TaskListEntryDescriptionUIComponent.m_TaskStatePositive

protected

◆ m_TaskSystem

SCR_TaskSystem SCR_TaskListEntryDescriptionUIComponent.m_TaskSystem

protected

◆ m_Widgets

ref SCR_TaskListEntryDescriptionWidgets SCR_TaskListEntryDescriptionUIComponent.m_Widgets = new SCR_TaskListEntryDescriptionWidgets()

protected

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

Game/UI/Tasks/SCR_TaskListEntryDescriptionUIComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AddGroupAssignee()

◆ AddPlayerAssignee()

◆ CheckOverflow()

◆ CreateAssignedGroupEntry()

◆ CreateAssignedPlayerEntry()

◆ CreateTaskEntry()

◆ DeinitAssignGroupList()

◆ GetCurrentTask()

◆ GetOnButtonShowOnMap()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ HandleTaskStateVisuals()

◆ InitAssignGroupList()

◆ InitDescription()

◆ IsAssignGroupListOpened()

◆ OnAssignGroupListClosed()

◆ OnAssignGroupListOpened()

◆ OnButtonAssign()

◆ OnButtonOpenAssignGroupListActivated()

◆ OnButtonShowOnMap()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ OnTaskEntrySelected()

◆ OnTaskHUDVisible()

◆ OnTaskOwnershipChanged()

◆ OnTaskUIVisibilityChanged()

◆ OnTaskVisibilityChanged()

◆ OnTaskVisualChanged()

◆ SetChildTaskText()

◆ SetFactionColors()

◆ SetTaskBackground()

◆ SetTaskIconColors()

◆ SetVisibility()

◆ UpdateAssignees()

◆ UpdateTask()

◆ UpdateTaskIconColors()

Member Data Documentation

◆ m_BackgroundColor

◆ m_bIsOverflowing

◆ m_IconColor

◆ m_iOffsetY

◆ m_MapCursorModule

◆ m_MapEntity

◆ m_OnButtonShowOnMap

◆ m_OnButtonTaskAssign

◆ m_OutlineColor

◆ m_sAssignedGroupEntry

◆ m_sAssignedPlayerEntry

◆ m_sAssignTaskText

◆ m_sTaskCancelled

◆ m_sTaskCompleted

◆ m_sTaskFailed

◆ m_sTaskListEntry

◆ m_sUnassignTaskText

◆ m_Task

◆ m_TaskComponent

◆ m_TaskManager

◆ m_TaskStateNegative

◆ m_TaskStatePositive

◆ m_TaskSystem

◆ m_Widgets