Inheritance diagram for SCR_TaskListEntryUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

void	InitTask (notnull SCR_Task task, bool hasChild=false)
	Initializes task and sets its visuals.

void	SetIconFactionColor ()
	Sets the icon color to the faction color if local player has the task assigned or local player is faction commander and task has any assignees.

void	OnWrapperFolded ()
	Toggles child tasks fold.

void	SetChildWrapperFolded (SCR_ModularButtonComponent comp=null, bool toggled=-1)
	Toggles child tasks fold.

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

void	SetTaskTextColor (notnull Color color)
	Sets color of task title.

void	UpdateTaskIconColors (Color backgroundColor=null, Color iconColor=null, Color outlineColor=null)
	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	SetEntrySelected (bool selected)
	Sets entry as selected.

void	SetIcon (ResourceName imageset, string iconName)
	Sets icon to icon from provided imageset.

void	SetIcon (ResourceName texture)
	Sets icon to icon from provided texture.

void	ShowProgressBar (bool show)
	Sets visibility of task progression bar.

void	SetProgressValue (float progress=-1)
	Sets progression of task progression bar.

void	ShowAssigneeCount (bool show)
	Sets progression of task progression bar.

void	SetAssigneeCount (int assigneesCount)
	Sets number of assignees assigned to the task.

void	SetChildCount (int count)

void	SetVisibility (bool show)
	Sets visibility of entry.

Widget	GetChildWrapper ()

Widget	GetEntryButton ()

SCR_TaskVisualsChangedInvoker	GetOnTaskVisualChanged ()

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	OnHoveredStart (SCR_ModularButtonComponent comp, bool mouseInput)

void	OnHoveredEnd (SCR_ModularButtonComponent comp, bool mouseInput)

bool	CheckTitleOverflow ()

int	GetAssignees ()

void	OnTaskEntryClicked ()
	Invoked when task button is clicked.

void	OnTaskAssigneeAdded (notnull SCR_Task task, SCR_TaskExecutor assignee, int requesterID)
	Invoked when IEntity is assigned to task.

void	OnTaskStateChanged (SCR_Task task, SCR_ETaskState state)
	Invoked on task state change.

void	HandleTaskState (SCR_ETaskState state, bool forceRefresh=true)
	Sets task visuals based on new state of task.

void	OnProgressChanged (float change, float newProgress)
	Sets task progression visuals based on new progress.

void	OnDisplayDataChanged ()
	Invoked when task visual data 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	OnTaskFactionChanged (SCR_Task task, FactionKey key)
	Invoked when task faction is changed.

void	OnTaskGroupChanged (SCR_Task task, int id)
	Invoked when task group is changed.

void	CheckTaskVisibility ()

Protected Attributes
ref Color	m_UnassignedTaskColor

ref Color	m_IconColor

ref Color	m_OutlineColor

ref Color	m_BackgroundColor

ref Color	m_FactionColor

SCR_Task	m_Task

SCR_TaskManagerUIComponent	m_TaskManager

ref SCR_TaskWidgetSelectedInvoker	m_OnTaskSelected

ref SCR_TaskVisualsChangedInvoker	m_OnTaskVisualUpdated

ref SCR_TaskListEntryWidgets	m_Widgets = new SCR_TaskListEntryWidgets()

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const int	MAX_CHILD_COUNT = 9

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

◆ CheckTaskVisibility()

void SCR_TaskListEntryUIComponent.CheckTaskVisibility ( )

protected

◆ CheckTitleOverflow()

bool SCR_TaskListEntryUIComponent.CheckTitleOverflow ( )

protected

Returns: True when content doesn't fit parent widget.

◆ GetAssignees()

int SCR_TaskListEntryUIComponent.GetAssignees ( )

protected

Returns: Number of IEntities assigned to task.

◆ GetChildWrapper()

Widget SCR_TaskListEntryUIComponent.GetChildWrapper ( )

Returns: Wrapper for child tasks

◆ GetEntryButton()

Widget SCR_TaskListEntryUIComponent.GetEntryButton ( )

Returns: entry main button

◆ GetOnTaskVisualChanged()

SCR_TaskVisualsChangedInvoker SCR_TaskListEntryUIComponent.GetOnTaskVisualChanged ( )

◆ HandlerAttached()

override void SCR_TaskListEntryUIComponent.HandlerAttached ( Widget w )

Implements SCR_ScriptedWidgetComponent.

◆ HandlerDeattached()

override void SCR_TaskListEntryUIComponent.HandlerDeattached ( Widget w )

◆ HandleTaskState()

void SCR_TaskListEntryUIComponent.HandleTaskState	(	SCR_ETaskState	state,
		bool	forceRefresh = true )

protected

Sets task visuals based on new state of task.

Parameters

[in]	state	New state of task.
[in]	forceRefresh	of task list.

◆ InitTask()

void SCR_TaskListEntryUIComponent.InitTask	(	notnull SCR_Task	task,
		bool	hasChild = false )

Initializes task and sets its visuals.

Parameters

[in] task Initialized task

◆ OnDisplayDataChanged()

void SCR_TaskListEntryUIComponent.OnDisplayDataChanged ( )

protected

Invoked when task visual data is changed.

◆ OnHoveredEnd()

void SCR_TaskListEntryUIComponent.OnHoveredEnd	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

protected

◆ OnHoveredStart()

void SCR_TaskListEntryUIComponent.OnHoveredStart	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

protected

◆ OnProgressChanged()

void SCR_TaskListEntryUIComponent.OnProgressChanged	(	float	change,
		float	newProgress )

protected

Sets task progression visuals based on new progress.

Parameters

[in]	change	Difference between old and new progress.
[in]	newProgress	New value of task progress.

◆ OnTaskAssigneeAdded()

void SCR_TaskListEntryUIComponent.OnTaskAssigneeAdded	(	notnull SCR_Task	task,
		SCR_TaskExecutor	assignee,
		int	requesterID )

protected

Invoked when IEntity is assigned to task.

If player is assignee, sets color of task background to currently controlled character faction color.

Parameters

[in]	task
[in]	assignee	IEntity being assigned to task.
[in]	requesterID

◆ OnTaskEntryClicked()

void SCR_TaskListEntryUIComponent.OnTaskEntryClicked ( )

protected

Invoked when task button is clicked.

◆ OnTaskFactionChanged()

void SCR_TaskListEntryUIComponent.OnTaskFactionChanged	(	SCR_Task	task,
		FactionKey	key )

protected

Invoked when task faction is changed.

◆ OnTaskGroupChanged()

void SCR_TaskListEntryUIComponent.OnTaskGroupChanged	(	SCR_Task	task,
		int	id )

protected

Invoked when task group is changed.

◆ OnTaskOwnershipChanged()

void SCR_TaskListEntryUIComponent.OnTaskOwnershipChanged	(	SCR_Task	task,
		SCR_ETaskOwnership	ownership )

protected

Invoked when task ownership is changed.

◆ OnTaskStateChanged()

void SCR_TaskListEntryUIComponent.OnTaskStateChanged	(	SCR_Task	task,
		SCR_ETaskState	state )

protected

Invoked on task state change.

Parameters

[in] state New state of task.

◆ OnTaskUIVisibilityChanged()

void SCR_TaskListEntryUIComponent.OnTaskUIVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskUIVisibility	visible )

protected

Invoked when task visual data is changed.

◆ OnTaskVisibilityChanged()

void SCR_TaskListEntryUIComponent.OnTaskVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskVisibility	visible )

protected

Invoked when task visibility is changed.

◆ OnWrapperFolded()

void SCR_TaskListEntryUIComponent.OnWrapperFolded ( )

Toggles child tasks fold.

◆ SetAssigneeCount()

void SCR_TaskListEntryUIComponent.SetAssigneeCount ( int assigneesCount )

Sets number of assignees assigned to the task.

Parameters

[in] assigneCount Number of assignees

◆ SetChildCount()

void SCR_TaskListEntryUIComponent.SetChildCount ( int count )

Parameters

[in] count

◆ SetChildWrapperFolded()

void SCR_TaskListEntryUIComponent.SetChildWrapperFolded	(	SCR_ModularButtonComponent	comp = null,
		bool	toggled = -1 )

Toggles child tasks fold.

◆ SetEntrySelected()

void SCR_TaskListEntryUIComponent.SetEntrySelected ( bool selected )

Sets entry as selected.

Parameters

[in] selected New selection state.

◆ SetIcon() [1/2]

void SCR_TaskListEntryUIComponent.SetIcon	(	ResourceName	imageset,
		string	iconName )

Sets icon to icon from provided imageset.

Parameters

[in]	imageset
[in]	iconName	Name of icon in imageset

◆ SetIcon() [2/2]

void SCR_TaskListEntryUIComponent.SetIcon ( ResourceName texture )

Sets icon to icon from provided texture.

Parameters

[in] texture New icon texture

◆ SetIconFactionColor()

void SCR_TaskListEntryUIComponent.SetIconFactionColor ( )

Sets the icon color to the faction color if local player has the task assigned or local player is faction commander and task has any assignees.

◆ SetProgressValue()

void SCR_TaskListEntryUIComponent.SetProgressValue ( float progress = -1 )

Sets progression of task progression bar.

If progress is -1, gets progress from task itself.

Parameters

[in] progress Value of progression to set on progress bar component.

◆ SetTaskBackground()

void SCR_TaskListEntryUIComponent.SetTaskBackground	(	ResourceName	imageset,
		string	name )

Sets new background of task.

Parameters

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

◆ SetTaskIconColors()

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

◆ SetTaskTextColor()

void SCR_TaskListEntryUIComponent.SetTaskTextColor ( notnull Color color )

Sets color of task title.

Parameters

[in] color new color of text.

◆ SetVisibility()

void SCR_TaskListEntryUIComponent.SetVisibility ( bool show )

Sets visibility of entry.

Parameters

[in] show New visibility

◆ ShowAssigneeCount()

void SCR_TaskListEntryUIComponent.ShowAssigneeCount ( bool show )

Sets progression of task progression bar.

If progress is -1, gets progress from task itself.

Parameters

[in] show Visibility of assignee count icon

◆ ShowProgressBar()

void SCR_TaskListEntryUIComponent.ShowProgressBar ( bool show )

Sets visibility of task progression bar.

Parameters

[in] show Visibility of progress bar.

◆ UpdateTask()

void SCR_TaskListEntryUIComponent.UpdateTask ( )

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

◆ UpdateTaskIconColors()

void SCR_TaskListEntryUIComponent.UpdateTaskIconColors	(	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

Member Data Documentation

◆ m_BackgroundColor

ref Color SCR_TaskListEntryUIComponent.m_BackgroundColor

protected

◆ m_FactionColor

ref Color SCR_TaskListEntryUIComponent.m_FactionColor

protected

◆ m_IconColor

ref Color SCR_TaskListEntryUIComponent.m_IconColor

protected

◆ m_OnTaskSelected

ref SCR_TaskWidgetSelectedInvoker SCR_TaskListEntryUIComponent.m_OnTaskSelected

protected

◆ m_OnTaskVisualUpdated

ref SCR_TaskVisualsChangedInvoker SCR_TaskListEntryUIComponent.m_OnTaskVisualUpdated

protected

◆ m_OutlineColor

ref Color SCR_TaskListEntryUIComponent.m_OutlineColor

protected

◆ m_Task

SCR_Task SCR_TaskListEntryUIComponent.m_Task

protected

◆ m_TaskManager

SCR_TaskManagerUIComponent SCR_TaskListEntryUIComponent.m_TaskManager

protected

◆ m_UnassignedTaskColor

ref Color SCR_TaskListEntryUIComponent.m_UnassignedTaskColor

protected

◆ m_Widgets

ref SCR_TaskListEntryWidgets SCR_TaskListEntryUIComponent.m_Widgets = new SCR_TaskListEntryWidgets()

protected

◆ MAX_CHILD_COUNT

const int SCR_TaskListEntryUIComponent.MAX_CHILD_COUNT = 9

staticprotected

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

Game/UI/Tasks/SCR_TaskListEntryUIComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CheckTaskVisibility()

◆ CheckTitleOverflow()

◆ GetAssignees()

◆ GetChildWrapper()

◆ GetEntryButton()

◆ GetOnTaskVisualChanged()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ HandleTaskState()

◆ InitTask()

◆ OnDisplayDataChanged()

◆ OnHoveredEnd()

◆ OnHoveredStart()

◆ OnProgressChanged()

◆ OnTaskAssigneeAdded()

◆ OnTaskEntryClicked()

◆ OnTaskFactionChanged()

◆ OnTaskGroupChanged()

◆ OnTaskOwnershipChanged()

◆ OnTaskStateChanged()

◆ OnTaskUIVisibilityChanged()

◆ OnTaskVisibilityChanged()

◆ OnWrapperFolded()

◆ SetAssigneeCount()

◆ SetChildCount()

◆ SetChildWrapperFolded()

◆ SetEntrySelected()

◆ SetIcon() [1/2]

◆ SetIcon() [2/2]

◆ SetIconFactionColor()

◆ SetProgressValue()

◆ SetTaskBackground()

◆ SetTaskIconColors()

◆ SetTaskTextColor()

◆ SetVisibility()

◆ ShowAssigneeCount()

◆ ShowProgressBar()

◆ UpdateTask()

◆ UpdateTaskIconColors()

Member Data Documentation

◆ m_BackgroundColor

◆ m_FactionColor

◆ m_IconColor

◆ m_OnTaskSelected

◆ m_OnTaskVisualUpdated

◆ m_OutlineColor

◆ m_Task

◆ m_TaskManager

◆ m_UnassignedTaskColor

◆ m_Widgets

◆ MAX_CHILD_COUNT