SCR_TutorialTaskMapUIComponent Interface Reference

Inheritance diagram for SCR_TutorialTaskMapUIComponent:

Public Member Functions
override void	InitTask (notnull SCR_Task task)
	Initializes task, sets its visuals.
void	SetSelected (bool select)
override void	HandlerAttached (Widget w)
Public Member Functions inherited from SCR_TaskMapUIComponent
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	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	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
override void	OnTaskIconClicked ()
Protected Member Functions inherited from SCR_TaskMapUIComponent
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	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	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
SCR_TutorialFastTravelMapMenuUI	m_TutorialMapMenu
ref Color	m_CourseFinishedColor
Protected Attributes inherited from SCR_TaskMapUIComponent
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
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

Static Protected Attributes
const string	m_sWidgetNameTaskIconFinished = "TaskIconFinished"
const string	m_sWidgetNameTaskIconFinishedBG = "TaskIconFinishedBG"
const string	m_sWidgetNameTaskIconFocus = "TaskIconFocus"
Static Protected Attributes inherited from SCR_MapUIElement
static SCR_MapUIElement	s_SelectedElement
const float	ANIM_SPEED = 20

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

Member Function Documentation

HandlerAttached()

override void SCR_TutorialTaskMapUIComponent.HandlerAttached

(

Widget

w

)

Implements SCR_TaskMapUIComponent.

InitTask()

override void SCR_TutorialTaskMapUIComponent.InitTask

(

notnull SCR_Task

task

)

Initializes task, sets its visuals.

Parameters

[in]

task

Implements SCR_TaskMapUIComponent.

OnTaskIconClicked()

override void SCR_TutorialTaskMapUIComponent.OnTaskIconClicked ( )

protected

Implements SCR_TaskMapUIComponent.

SetSelected()

void SCR_TutorialTaskMapUIComponent.SetSelected

(

bool

select

)

Member Data Documentation

m_CourseFinishedColor

ref Color SCR_TutorialTaskMapUIComponent.m_CourseFinishedColor

protected

m_sWidgetNameTaskIconFinished

const string SCR_TutorialTaskMapUIComponent.m_sWidgetNameTaskIconFinished = "TaskIconFinished"

staticprotected

m_sWidgetNameTaskIconFinishedBG

const string SCR_TutorialTaskMapUIComponent.m_sWidgetNameTaskIconFinishedBG = "TaskIconFinishedBG"

staticprotected

m_sWidgetNameTaskIconFocus

const string SCR_TutorialTaskMapUIComponent.m_sWidgetNameTaskIconFocus = "TaskIconFocus"

staticprotected

m_TutorialMapMenu

SCR_TutorialFastTravelMapMenuUI SCR_TutorialTaskMapUIComponent.m_TutorialMapMenu

protected

---

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

• Game/UI/Tasks/SCR_TutorialTaskMapUIComponent.c