Inheritance diagram for SCR_TaskMapUIComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
override vector	GetPos ()
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
void	OnHoveredIconStart (SCR_ModularButtonComponent comp, bool mouseInput)
void	OnHoveredTitleStart (SCR_ModularButtonComponent comp, bool mouseInput)
void	OnHoveredTitleEnd (SCR_ModularButtonComponent comp, bool mouseInput)
void	OnHoveredEnd (SCR_ModularButtonComponent comp, bool mouseInput)
bool	CheckTitleOverflow ()
void	OnTaskIconClicked ()
void	OnTaskTitleClicked ()
void	OnTaskSelected (SCR_Task task)
void	OnTaskAssigneeAdded (SCR_Task task, SCR_TaskExecutor assignee, int requesterID)
void	OnDisplayDataChanged ()
	Handles update of task visuals.
void	InitTask (notnull SCR_Task task)
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	SetTask (notnull SCR_Task task)
void	UpdateTaskInformation ()
	Updates task title and icon to the one provided in task SCR_TaskUIInfo.
void	OnPlayerNameCacheUpdate (bool success)
void	UpdatePlayerNameCache ()
	Requests update of player name cache if requested by m_bRequestPlayerNameCacheUpdate.
void	UpdateTaskIconColors (Color backgroundColor=null, Color iconColor=null, Color outlineColor=null)
void	SetTaskBackground (ResourceName imageset, string name)
void	SetTaskIconColors (Color backgroundColor=null, Color iconColor=null, Color outlineColor=null)
void	UpdateTaskState (SCR_Task task, SCR_ETaskState state)
void	SetMapMarkerAssigneeCount ()
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	HandleTaskVisibilityChange (SCR_Task task)
	Invoked when task visibility is changed.
void	CheckTaskVisibility ()
void	SetVisibility (bool show)
SCR_Task	GetTask ()
ScriptInvokerVoid	GetOnTaskIconClick ()

Protected Attributes
ref Color	m_IconColor
ref Color	m_OutlineColor
ref Color	m_BackgroundColor
ref Color	m_FactionColor
SCR_Task	m_Task
SCR_TaskSystem	m_TaskSystem
bool	m_bEnableContext
bool	m_bSelected
bool	m_bDisplayAssigned = 1
bool	m_bShowAuthor
bool	m_bRequestPlayerNameCacheUpdate
ref array< string >	m_aPlayerIdentitiesToUpdate = {}
ref array< ref TextWidget >	m_aWidgetsToUpdate = {}
SCR_TaskManagerUIComponent	m_TaskManager
ref ScriptInvokerVoid	m_OnTaskIconClick
ref SCR_TaskMapWidgets	m_Widgets = new SCR_TaskMapWidgets()

Detailed Description

Definition at line 1 of file SCR_TaskMapUIComponent.c.

Member Function Documentation

◆ CheckTaskVisibility()

void SCR_TaskMapUIComponent::CheckTaskVisibility ( )

inlineprotected

Definition at line 666 of file SCR_TaskMapUIComponent.c.

◆ CheckTitleOverflow()

bool SCR_TaskMapUIComponent::CheckTitleOverflow ( )

inlineprotected

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

Definition at line 182 of file SCR_TaskMapUIComponent.c.

◆ GetOnTaskIconClick()

ScriptInvokerVoid SCR_TaskMapUIComponent::GetOnTaskIconClick ( )

inlineprotected

Definition at line 697 of file SCR_TaskMapUIComponent.c.

◆ GetPos()

override vector SCR_TaskMapUIComponent::GetPos ( )

inlineprotected

Returns origin of task entity

Returns: vector

Definition at line 103 of file SCR_TaskMapUIComponent.c.

◆ GetTask()

SCR_Task SCR_TaskMapUIComponent::GetTask ( )

inlineprotected

Definition at line 691 of file SCR_TaskMapUIComponent.c.

◆ HandlerAttached()

override void SCR_TaskMapUIComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 25 of file SCR_TaskMapUIComponent.c.

◆ HandlerDeattached()

override void SCR_TaskMapUIComponent::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 60 of file SCR_TaskMapUIComponent.c.

◆ HandleTaskVisibilityChange()

void SCR_TaskMapUIComponent::HandleTaskVisibilityChange ( SCR_Task task )

inlineprotected

Invoked when task visibility is changed.

Definition at line 656 of file SCR_TaskMapUIComponent.c.

◆ InitTask()

void SCR_TaskMapUIComponent::InitTask ( notnull SCR_Task task )

inlineprotected

Initializes task, sets its visuals

Parameters

[in] task

Definition at line 323 of file SCR_TaskMapUIComponent.c.

◆ OnDisplayDataChanged()

void SCR_TaskMapUIComponent::OnDisplayDataChanged ( )

inlineprotected

Handles update of task visuals.

Definition at line 311 of file SCR_TaskMapUIComponent.c.

◆ OnHoveredEnd()

void SCR_TaskMapUIComponent::OnHoveredEnd	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

inlineprotected

Definition at line 172 of file SCR_TaskMapUIComponent.c.

◆ OnHoveredIconStart()

void SCR_TaskMapUIComponent::OnHoveredIconStart	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

inlineprotected

Definition at line 147 of file SCR_TaskMapUIComponent.c.

◆ OnHoveredTitleEnd()

void SCR_TaskMapUIComponent::OnHoveredTitleEnd	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

inlineprotected

Definition at line 165 of file SCR_TaskMapUIComponent.c.

◆ OnHoveredTitleStart()

void SCR_TaskMapUIComponent::OnHoveredTitleStart	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

inlineprotected

Definition at line 156 of file SCR_TaskMapUIComponent.c.

◆ OnMouseEnter()

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

inlineprotected

Definition at line 112 of file SCR_TaskMapUIComponent.c.

◆ OnMouseLeave()

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

inlineprotected

Definition at line 132 of file SCR_TaskMapUIComponent.c.

◆ OnPlayerNameCacheUpdate()

void SCR_TaskMapUIComponent::OnPlayerNameCacheUpdate ( bool success )

inlineprotected

Definition at line 478 of file SCR_TaskMapUIComponent.c.

◆ OnTaskAssigneeAdded()

void SCR_TaskMapUIComponent::OnTaskAssigneeAdded	(	SCR_Task	task,
		SCR_TaskExecutor	assignee,
		int	requesterID )

inlineprotected

Handles update of assigned entities. If player is assigned, changes color of map marker.

Parameters

[in]	task
[in]	assignee	Assigned SCR_TaskExecutor
[in]	requesterID

Definition at line 276 of file SCR_TaskMapUIComponent.c.

◆ OnTaskFactionChanged()

void SCR_TaskMapUIComponent::OnTaskFactionChanged	(	SCR_Task	task,
		FactionKey	key )

inlineprotected

Invoked when task faction is changed.

Definition at line 642 of file SCR_TaskMapUIComponent.c.

◆ OnTaskGroupChanged()

void SCR_TaskMapUIComponent::OnTaskGroupChanged	(	SCR_Task	task,
		int	id )

inlineprotected

Invoked when task group is changed.

Definition at line 649 of file SCR_TaskMapUIComponent.c.

◆ OnTaskIconClicked()

void SCR_TaskMapUIComponent::OnTaskIconClicked ( )

inlineprotected

Definition at line 206 of file SCR_TaskMapUIComponent.c.

◆ OnTaskOwnershipChanged()

void SCR_TaskMapUIComponent::OnTaskOwnershipChanged	(	SCR_Task	task,
		SCR_ETaskOwnership	ownership )

inlineprotected

Invoked when task ownership is changed.

Definition at line 635 of file SCR_TaskMapUIComponent.c.

◆ OnTaskSelected()

void SCR_TaskMapUIComponent::OnTaskSelected ( SCR_Task task )

inlineprotected

Parameters

[in] task Selected task

Definition at line 245 of file SCR_TaskMapUIComponent.c.

◆ OnTaskTitleClicked()

void SCR_TaskMapUIComponent::OnTaskTitleClicked ( )

inlineprotected

Definition at line 236 of file SCR_TaskMapUIComponent.c.

◆ OnTaskUIVisibilityChanged()

void SCR_TaskMapUIComponent::OnTaskUIVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskUIVisibility	visible )

inlineprotected

Invoked when task visual data is changed.

Definition at line 615 of file SCR_TaskMapUIComponent.c.

◆ OnTaskVisibilityChanged()

void SCR_TaskMapUIComponent::OnTaskVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskVisibility	visible )

inlineprotected

Invoked when task visibility is changed.

Definition at line 628 of file SCR_TaskMapUIComponent.c.

◆ SetIconFactionColor()

void SCR_TaskMapUIComponent::SetIconFactionColor ( )

inlineprotected

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.

Definition at line 349 of file SCR_TaskMapUIComponent.c.

◆ SetMapMarkerAssigneeCount()

void SCR_TaskMapUIComponent::SetMapMarkerAssigneeCount ( )

inlineprotected

Definition at line 608 of file SCR_TaskMapUIComponent.c.

◆ SetTask()

void SCR_TaskMapUIComponent::SetTask ( notnull SCR_Task task )

inlineprotected

Definition at line 381 of file SCR_TaskMapUIComponent.c.

◆ SetTaskBackground()

void SCR_TaskMapUIComponent::SetTaskBackground	(	ResourceName	imageset,
		string	name )

inlineprotected

Sets new background of task.

Parameters

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

Definition at line 534 of file SCR_TaskMapUIComponent.c.

◆ SetTaskIconColors()

void SCR_TaskMapUIComponent::SetTaskIconColors	(	Color	backgroundColor = null,
		Color	iconColor = null,
		Color	outlineColor = null )

inlineprotected

Sets task icon colors

Parameters

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

Definition at line 547 of file SCR_TaskMapUIComponent.c.

◆ SetVisibility()

void SCR_TaskMapUIComponent::SetVisibility ( bool show )

inlineprotected

Sets visibility of entry

Parameters

[in] show New visibility

Definition at line 685 of file SCR_TaskMapUIComponent.c.

◆ UpdatePlayerNameCache()

void SCR_TaskMapUIComponent::UpdatePlayerNameCache ( )

inlineprotected

Requests update of player name cache if requested by m_bRequestPlayerNameCacheUpdate.

Definition at line 499 of file SCR_TaskMapUIComponent.c.

◆ UpdateTaskIconColors()

void SCR_TaskMapUIComponent::UpdateTaskIconColors	(	Color	backgroundColor = null,
		Color	iconColor = null,
		Color	outlineColor = null )

inlineprotected

Sets task icon colors

Parameters

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

Definition at line 514 of file SCR_TaskMapUIComponent.c.

◆ UpdateTaskInformation()

void SCR_TaskMapUIComponent::UpdateTaskInformation ( )

inlineprotected

Updates task title and icon to the one provided in task SCR_TaskUIInfo.

Definition at line 410 of file SCR_TaskMapUIComponent.c.

◆ UpdateTaskState()

void SCR_TaskMapUIComponent::UpdateTaskState	(	SCR_Task	task,
		SCR_ETaskState	state )

inlineprotected

Handles task visuals based on new task state.

Parameters

[in] state New state of task

Definition at line 562 of file SCR_TaskMapUIComponent.c.

Member Data Documentation

◆ m_aPlayerIdentitiesToUpdate

ref array<string> SCR_TaskMapUIComponent::m_aPlayerIdentitiesToUpdate = {}

protected

Definition at line 17 of file SCR_TaskMapUIComponent.c.

◆ m_aWidgetsToUpdate

ref array<ref TextWidget> SCR_TaskMapUIComponent::m_aWidgetsToUpdate = {}

protected

Definition at line 18 of file SCR_TaskMapUIComponent.c.

◆ m_BackgroundColor

ref Color SCR_TaskMapUIComponent::m_BackgroundColor

protected

Definition at line 5 of file SCR_TaskMapUIComponent.c.

◆ m_bDisplayAssigned

bool SCR_TaskMapUIComponent::m_bDisplayAssigned = 1

protected

Definition at line 13 of file SCR_TaskMapUIComponent.c.

◆ m_bEnableContext

bool SCR_TaskMapUIComponent::m_bEnableContext

protected

Definition at line 11 of file SCR_TaskMapUIComponent.c.

◆ m_bRequestPlayerNameCacheUpdate

bool SCR_TaskMapUIComponent::m_bRequestPlayerNameCacheUpdate

protected

Definition at line 16 of file SCR_TaskMapUIComponent.c.

◆ m_bSelected

bool SCR_TaskMapUIComponent::m_bSelected

protected

Definition at line 12 of file SCR_TaskMapUIComponent.c.

◆ m_bShowAuthor

bool SCR_TaskMapUIComponent::m_bShowAuthor

protected

Definition at line 14 of file SCR_TaskMapUIComponent.c.

◆ m_FactionColor

ref Color SCR_TaskMapUIComponent::m_FactionColor

protected

Definition at line 6 of file SCR_TaskMapUIComponent.c.

◆ m_IconColor

ref Color SCR_TaskMapUIComponent::m_IconColor

protected

Definition at line 3 of file SCR_TaskMapUIComponent.c.

◆ m_OnTaskIconClick

ref ScriptInvokerVoid SCR_TaskMapUIComponent::m_OnTaskIconClick

protected

Definition at line 21 of file SCR_TaskMapUIComponent.c.

◆ m_OutlineColor

ref Color SCR_TaskMapUIComponent::m_OutlineColor

protected

Definition at line 4 of file SCR_TaskMapUIComponent.c.

◆ m_Task

SCR_Task SCR_TaskMapUIComponent::m_Task

protected

Definition at line 8 of file SCR_TaskMapUIComponent.c.

◆ m_TaskManager

SCR_TaskManagerUIComponent SCR_TaskMapUIComponent::m_TaskManager

protected

Definition at line 20 of file SCR_TaskMapUIComponent.c.

◆ m_TaskSystem

SCR_TaskSystem SCR_TaskMapUIComponent::m_TaskSystem

protected

Definition at line 9 of file SCR_TaskMapUIComponent.c.

◆ m_Widgets

ref SCR_TaskMapWidgets SCR_TaskMapUIComponent::m_Widgets = new SCR_TaskMapWidgets()

protected

Definition at line 22 of file SCR_TaskMapUIComponent.c.

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

scripts/Game/UI/Tasks/SCR_TaskMapUIComponent.c

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ CheckTaskVisibility()

◆ CheckTitleOverflow()

◆ GetOnTaskIconClick()

◆ GetPos()

◆ GetTask()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ HandleTaskVisibilityChange()

◆ InitTask()

◆ OnDisplayDataChanged()

◆ OnHoveredEnd()

◆ OnHoveredIconStart()

◆ OnHoveredTitleEnd()

◆ OnHoveredTitleStart()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ OnPlayerNameCacheUpdate()

◆ OnTaskAssigneeAdded()

◆ OnTaskFactionChanged()

◆ OnTaskGroupChanged()

◆ OnTaskIconClicked()

◆ OnTaskOwnershipChanged()

◆ OnTaskSelected()

◆ OnTaskTitleClicked()

◆ OnTaskUIVisibilityChanged()

◆ OnTaskVisibilityChanged()

◆ SetIconFactionColor()

◆ SetMapMarkerAssigneeCount()

◆ SetTask()

◆ SetTaskBackground()

◆ SetTaskIconColors()

◆ SetVisibility()

◆ UpdatePlayerNameCache()

◆ UpdateTaskIconColors()

◆ UpdateTaskInformation()

◆ UpdateTaskState()

Member Data Documentation

◆ m_aPlayerIdentitiesToUpdate

◆ m_aWidgetsToUpdate

◆ m_BackgroundColor

◆ m_bDisplayAssigned

◆ m_bEnableContext

◆ m_bRequestPlayerNameCacheUpdate

◆ m_bSelected

◆ m_bShowAuthor

◆ m_FactionColor

◆ m_IconColor

◆ m_OnTaskIconClick

◆ m_OutlineColor

◆ m_Task

◆ m_TaskManager

◆ m_TaskSystem

◆ m_Widgets