Inheritance diagram for SCR_TaskMapUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

override vector	GetPos ()
	Returns origin of task entity.

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

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

void	InitTask (notnull SCR_Task task)
	Initializes task, 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	SetTask (notnull SCR_Task task)

void	UpdateTaskIconColors (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	SetTaskIconColors (Color backgroundColor=null, Color iconColor=null, Color outlineColor=null)
	Sets task icon colors.

SCR_Task	GetTask ()

ScriptInvokerVoid	GetOnTaskIconClick ()

Public Member Functions inherited from SCR_MapUIElement
void	SetParent (SCR_MapUIElementContainer parent)

string	GetName ()

bool	GetIconVisible ()

void	ShowName (bool visible)

void	SetVisible (bool visible)

Widget	GetRoot ()

override bool	OnClick (Widget w, int x, int y, int button)

void	SelectIcon (bool invoke=true)

void	Select (bool select=true)

Color	GetColorForFaction (string factionKey)

RplId	GetSpawnPointId ()

void	SetName (string name)

Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget	GetRootWidget ()

bool	IsVisible ()

Protected Member Functions
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)
	Handles update of assigned entities.

void	OnDisplayDataChanged ()
	Handles update of task visuals.

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	UpdateTaskState (SCR_Task task, SCR_ETaskState state)
	Handles task visuals based on new task 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)
	Sets visibility of entry.

Protected Member Functions inherited from SCR_MapUIElement
void	AnimExpand ()

void	AnimCollapse ()

void	PlayHoverSound (string sound)

void	SetImage (string image)

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()

Protected Attributes inherited from SCR_MapUIElement
SCR_MapUIElementContainer	m_Parent

MapItem	m_MapItem

ImageWidget	m_wImage

ImageWidget	m_wGradient

ImageWidget	m_wSelectImg

ImageWidget	m_wHighlightImg

bool	m_bIsSelected

SCR_EIconType	m_eIconType

bool	m_bVisible = false

ResourceName	m_sImageSetARO

ResourceName	m_sImageSetSpecial

bool	m_bUseBackgroundGradient

string	m_sSoundBase

string	m_sSoundEnemyBase

string	m_sSoundRelay

string	m_sSoundTask

string	m_sSoundService

string	m_sSoundHover

string	m_sName

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_MapUIElement
ref Color	m_UnknownFactionColor

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Static Protected Attributes inherited from SCR_MapUIElement
static SCR_MapUIElement	s_SelectedElement

const float	ANIM_SPEED = 20

Member Function Documentation

◆ CheckTaskVisibility()

void SCR_TaskMapUIComponent.CheckTaskVisibility ( )

protected

◆ CheckTitleOverflow()

bool SCR_TaskMapUIComponent.CheckTitleOverflow ( )

protected

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

◆ GetOnTaskIconClick()

ScriptInvokerVoid SCR_TaskMapUIComponent.GetOnTaskIconClick ( )

◆ GetPos()

override vector SCR_TaskMapUIComponent.GetPos ( )

Returns origin of task entity.

Returns: vector

Implements SCR_MapUIElement.

◆ GetTask()

SCR_Task SCR_TaskMapUIComponent.GetTask ( )

◆ HandlerAttached()

override void SCR_TaskMapUIComponent.HandlerAttached ( Widget w )

Implements SCR_MapUIElement.

Implemented in SCR_TutorialTaskMapUIComponent.

◆ HandlerDeattached()

override void SCR_TaskMapUIComponent.HandlerDeattached ( Widget w )

◆ HandleTaskVisibilityChange()

void SCR_TaskMapUIComponent.HandleTaskVisibilityChange ( SCR_Task task )

protected

Invoked when task visibility is changed.

◆ InitTask()

void SCR_TaskMapUIComponent.InitTask ( notnull SCR_Task task )

Initializes task, sets its visuals.

Parameters

[in] task

Implemented in SCR_TutorialTaskMapUIComponent.

◆ OnDisplayDataChanged()

void SCR_TaskMapUIComponent.OnDisplayDataChanged ( )

protected

Handles update of task visuals.

Implemented in SCR_ConflictTaskMapUIComponent.

◆ OnHoveredEnd()

void SCR_TaskMapUIComponent.OnHoveredEnd	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

protected

◆ OnHoveredIconStart()

void SCR_TaskMapUIComponent.OnHoveredIconStart	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

protected

◆ OnHoveredTitleEnd()

void SCR_TaskMapUIComponent.OnHoveredTitleEnd	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

protected

◆ OnHoveredTitleStart()

void SCR_TaskMapUIComponent.OnHoveredTitleStart	(	SCR_ModularButtonComponent	comp,
		bool	mouseInput )

protected

◆ OnMouseEnter()

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

◆ OnMouseLeave()

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

◆ OnPlayerNameCacheUpdate()

void SCR_TaskMapUIComponent.OnPlayerNameCacheUpdate ( bool success )

protected

◆ OnTaskAssigneeAdded()

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

protected

Handles update of assigned entities.

If player is assigned, changes color of map marker.

Parameters

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

Implemented in SCR_ConflictTaskMapUIComponent.

◆ OnTaskFactionChanged()

void SCR_TaskMapUIComponent.OnTaskFactionChanged	(	SCR_Task	task,
		FactionKey	key )

protected

Invoked when task faction is changed.

◆ OnTaskGroupChanged()

void SCR_TaskMapUIComponent.OnTaskGroupChanged	(	SCR_Task	task,
		int	id )

protected

Invoked when task group is changed.

Implemented in SCR_ConflictTaskMapUIComponent.

◆ OnTaskIconClicked()

void SCR_TaskMapUIComponent.OnTaskIconClicked ( )

protected

Implemented in SCR_TutorialTaskMapUIComponent.

◆ OnTaskOwnershipChanged()

void SCR_TaskMapUIComponent.OnTaskOwnershipChanged	(	SCR_Task	task,
		SCR_ETaskOwnership	ownership )

protected

Invoked when task ownership is changed.

◆ OnTaskSelected()

void SCR_TaskMapUIComponent.OnTaskSelected ( SCR_Task task )

protected

Parameters

[in] task Selected task

Implemented in SCR_ConflictTaskMapUIComponent, and SCR_TutorialTaskMapUIComponent.

◆ OnTaskTitleClicked()

void SCR_TaskMapUIComponent.OnTaskTitleClicked ( )

protected

Implemented in SCR_TutorialTaskMapUIComponent.

◆ OnTaskUIVisibilityChanged()

void SCR_TaskMapUIComponent.OnTaskUIVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskUIVisibility	visible )

protected

Invoked when task visual data is changed.

◆ OnTaskVisibilityChanged()

void SCR_TaskMapUIComponent.OnTaskVisibilityChanged	(	SCR_Task	task,
		SCR_ETaskVisibility	visible )

protected

Invoked when task visibility is changed.

◆ SetIconFactionColor()

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

◆ SetMapMarkerAssigneeCount()

void SCR_TaskMapUIComponent.SetMapMarkerAssigneeCount ( )

protected

◆ SetTask()

void SCR_TaskMapUIComponent.SetTask ( notnull SCR_Task task )

◆ SetTaskBackground()

void SCR_TaskMapUIComponent.SetTaskBackground	(	ResourceName	imageset,
		string	name )

Sets new background of task.

Parameters

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

◆ SetTaskIconColors()

void SCR_TaskMapUIComponent.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_TaskMapUIComponent.SetVisibility ( bool show )

protected

Sets visibility of entry.

Parameters

[in] show New visibility

◆ UpdatePlayerNameCache()

void SCR_TaskMapUIComponent.UpdatePlayerNameCache ( )

protected

Requests update of player name cache if requested by m_bRequestPlayerNameCacheUpdate.

◆ UpdateTaskIconColors()

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

◆ UpdateTaskInformation()

void SCR_TaskMapUIComponent.UpdateTaskInformation ( )

protected

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

◆ UpdateTaskState()

void SCR_TaskMapUIComponent.UpdateTaskState	(	SCR_Task	task,
		SCR_ETaskState	state )

protected

Handles task visuals based on new task state.

Parameters

[in] state New state of task

Implemented in SCR_ConflictTaskMapUIComponent.

Member Data Documentation

◆ m_aPlayerIdentitiesToUpdate

ref array<string> SCR_TaskMapUIComponent.m_aPlayerIdentitiesToUpdate = {}

protected

◆ m_aWidgetsToUpdate

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

protected

◆ m_BackgroundColor

ref Color SCR_TaskMapUIComponent.m_BackgroundColor

protected

◆ m_bDisplayAssigned

bool SCR_TaskMapUIComponent.m_bDisplayAssigned = 1

protected

◆ m_bEnableContext

bool SCR_TaskMapUIComponent.m_bEnableContext

protected

◆ m_bRequestPlayerNameCacheUpdate

bool SCR_TaskMapUIComponent.m_bRequestPlayerNameCacheUpdate

protected

◆ m_bSelected

bool SCR_TaskMapUIComponent.m_bSelected

protected

◆ m_bShowAuthor

bool SCR_TaskMapUIComponent.m_bShowAuthor

protected

◆ m_FactionColor

ref Color SCR_TaskMapUIComponent.m_FactionColor

protected

◆ m_IconColor

ref Color SCR_TaskMapUIComponent.m_IconColor

protected

◆ m_OnTaskIconClick

ref ScriptInvokerVoid SCR_TaskMapUIComponent.m_OnTaskIconClick

protected

◆ m_OutlineColor

ref Color SCR_TaskMapUIComponent.m_OutlineColor

protected

◆ m_Task

SCR_Task SCR_TaskMapUIComponent.m_Task

protected

◆ m_TaskManager

SCR_TaskManagerUIComponent SCR_TaskMapUIComponent.m_TaskManager

protected

◆ m_TaskSystem

SCR_TaskSystem SCR_TaskMapUIComponent.m_TaskSystem

protected

◆ m_Widgets

ref SCR_TaskMapWidgets SCR_TaskMapUIComponent.m_Widgets = new SCR_TaskMapWidgets()

protected

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

Game/UI/Tasks/SCR_TaskMapUIComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

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