SCR_TaskManagerUIComponent Interface Reference

Inheritance diagram for SCR_TaskManagerUIComponent:

Public Member Functions
void	SCR_TaskManagerUIComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_TaskManagerUIComponent ()
override void	EOnInit (IEntity owner)
override void	EOnFrame (IEntity owner, float timeSlice)
void	ToggleCurrentTask ()
	Displays a hint with currently selected task.
void	ShowTaskOnMap ()
	Requests panning map to task. If map is not opened - opens it.
void	AssignTask (SCR_Task task=null)
	Assigns provided task to the player.
void	TaskHUDVisibilityChanged (bool newVisibility)
	Invokes whenever task list on HUD is shown.
void	SetSelectedTask (SCR_Task task)
	Sets provided task as selected.
void	SetHoveredTask (SCR_Task task)
	Sets provided task as hovered.
override void	OnPlayerConnected (int playerId)
	Called after a player is connected.
void	UpdateTaskColors (Color backgroundColor, Color iconColor, Color outlineColor)
	Sets new colors on task icons.
void	UpdateTaskBackground (ResourceName imageset, string name)
	Sets new background of task.
SCR_Task	GetSelectedTask ()
SCR_Task	GetAssigedTask ()
bool	IsTaskListOpen ()
void	RegisterTaskList (SCR_TaskListUIComponent component)
	Register task list component.
bool	RefreshTaskList ()
	Register task list component.
bool	SetTaskDescriptionVisiblity (bool newVisibility)
void	SetJournalVisibility (bool newVisibility)
	Sets new visiblity of journal and hides task list.
void	SetTaskListVisibility (bool newVisibility)
	Sets new visiblity of task list and hides journal.
SCR_TaskListUIComponent	GetTaskListComponent ()
SCR_TaskListEntryDescriptionUIComponent	GetTaskDescriptionComponent ()
ResourceName	GetDefaultImageset ()
string	GetDefaultIcon ()
bool	GetDisplayAssigneesOnMap ()
array< SCR_ETaskTabType >	GetTaskTabs ()
ScriptInvokerBool	GetOnTaskHUDVisible ()
SCR_TaskColorsUpdatedInvoker	GetOnTaskColorsUpdated ()
SCR_TaskBackgroundUpdatedInvoker	GetOnTaskBackgroundUpdated ()
SCR_TaskSelectedInvoker	GetOnTaskSelected ()
SCR_TaskAssignedInvoker	GetOnTaskAssigned ()
SCR_TaskHoveredInvoker	GetOnTaskHovered ()
Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()
void	OnGameEnd ()
	Called on all machines when the world ends.
void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.
void	OnGameModeStart ()
	Called on every machine when game mode starts.
void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.
void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.
void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.
void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.
void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).
void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).
void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.
bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.
void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.
void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.
void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.
void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.
void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)
void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.
void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.
void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_TaskManagerUIComponent	GetInstance ()

Static Public Attributes
static SCR_TaskManagerUIComponent	s_Instance

Protected Member Functions
void	PanMapToTask (string taskID=string.Empty, SCR_Task task=null)
	Moves camera to task position in map view.
void	CloseTaskList ()
	Closes task list.
void	OnControlledEntityChanged (IEntity from, IEntity to)
	SCR_PlayerController Event Used to reinit Task manager Component when new entity is controlled.
void	LifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
void	OnClientPlayerRegistered (int playerId)
void	OnClientControlledEntityChanged (IEntity from, IEntity to)
void	OnGroupChanged (int groupID)

Protected Attributes
ResourceName	m_sTaskHintLayout
float	m_fCurrentTaskShowTime
ResourceName	m_sDefaultImageset
string	m_sDefaultIcon
bool	m_bDisplayOfAssigneesOnMap
bool	m_bShowCurrentTaskOnRespawn
string	m_sTaskTabConfig
ref SCR_TaskSelectedInvoker	m_OnTaskSelected
ref SCR_TaskAssignedInvoker	m_OnTaskAssigned
ref SCR_TaskHoveredInvoker	m_OnTaskHovered
ref SCR_TaskColorsUpdatedInvoker	m_OnTaskColorsUpdate
ref SCR_TaskBackgroundUpdatedInvoker	m_OnTaskBackgroundUpdate
ref ScriptInvokerBool	m_OnTaskHUDVisible
ref SCR_TasksTabConfig	m_TaskTabConfig
bool	m_bIsUnconscious
bool	m_bCurrentTaskVisible
Widget	m_wTaskHint
SCR_Task	m_SelectedTask
SCR_Task	m_AssignedTask
SCR_Task	m_HoveredTask
SCR_MapEntity	m_MapEntity
SCR_TaskSystem	m_TaskSystem
SCR_TaskListUIComponent	m_TaskListComponent
SCR_MapJournalUI	m_JournalComponent
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
const string	CONTENT_TASK_LIST_MAP = "TaskListMapContext"
const string	ACTION_CLOSE_TASK_LIST = "TasksClose"

Constructor & Destructor Documentation

SCR_TaskManagerUIComponent()

void SCR_TaskManagerUIComponent.SCR_TaskManagerUIComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

Parameters

[in]	src
[in]	ent
[in]	parent

~SCR_TaskManagerUIComponent()

void SCR_TaskManagerUIComponent.~SCR_TaskManagerUIComponent

(

)

Member Function Documentation

AssignTask()

void SCR_TaskManagerUIComponent.AssignTask

(

SCR_Task

task = null

)

Assigns provided task to the player.

Parameters

[in]

SCR_Task

CloseTaskList()

void SCR_TaskManagerUIComponent.CloseTaskList ( )

protected

Closes task list.

EOnFrame()

override void SCR_TaskManagerUIComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice )

EOnInit()

override void SCR_TaskManagerUIComponent.EOnInit

(

IEntity

owner

)

GetAssigedTask()

SCR_Task SCR_TaskManagerUIComponent.GetAssigedTask

(

)

Returns

Currently assigned task.

GetDefaultIcon()

string SCR_TaskManagerUIComponent.GetDefaultIcon

(

)

Returns

default icon name.

GetDefaultImageset()

ResourceName SCR_TaskManagerUIComponent.GetDefaultImageset

(

)

Returns

default imageset.

GetDisplayAssigneesOnMap()

bool SCR_TaskManagerUIComponent.GetDisplayAssigneesOnMap

(

)

Returns

default icon name.

GetInstance()

static SCR_TaskManagerUIComponent SCR_TaskManagerUIComponent.GetInstance ( )

static

Returns

Instance of task manager.

GetOnTaskAssigned()

SCR_TaskAssignedInvoker SCR_TaskManagerUIComponent.GetOnTaskAssigned

(

)

GetOnTaskBackgroundUpdated()

SCR_TaskBackgroundUpdatedInvoker SCR_TaskManagerUIComponent.GetOnTaskBackgroundUpdated

(

)

GetOnTaskColorsUpdated()

SCR_TaskColorsUpdatedInvoker SCR_TaskManagerUIComponent.GetOnTaskColorsUpdated

(

)

GetOnTaskHovered()

SCR_TaskHoveredInvoker SCR_TaskManagerUIComponent.GetOnTaskHovered

(

)

GetOnTaskHUDVisible()

ScriptInvokerBool SCR_TaskManagerUIComponent.GetOnTaskHUDVisible

(

)

GetOnTaskSelected()

SCR_TaskSelectedInvoker SCR_TaskManagerUIComponent.GetOnTaskSelected

(

)

GetSelectedTask()

SCR_Task SCR_TaskManagerUIComponent.GetSelectedTask

(

)

Returns

Currently selected task.

GetTaskDescriptionComponent()

SCR_TaskListEntryDescriptionUIComponent SCR_TaskManagerUIComponent.GetTaskDescriptionComponent

(

)

Returns

task description ui component

GetTaskListComponent()

SCR_TaskListUIComponent SCR_TaskManagerUIComponent.GetTaskListComponent

(

)

Returns

Currently assigned task.

GetTaskTabs()

array< SCR_ETaskTabType > SCR_TaskManagerUIComponent.GetTaskTabs

(

)

Returns

task tabs to be displayed

IsTaskListOpen()

bool SCR_TaskManagerUIComponent.IsTaskListOpen

(

)

Returns

Whether task list is opened in map view.

LifeStateChanged()

void SCR_TaskManagerUIComponent.LifeStateChanged ( ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState )

protected

OnClientControlledEntityChanged()

void SCR_TaskManagerUIComponent.OnClientControlledEntityChanged ( IEntity from, IEntity to )

protected

OnClientPlayerRegistered()

void SCR_TaskManagerUIComponent.OnClientPlayerRegistered ( int playerId )

protected

OnControlledEntityChanged()

void SCR_TaskManagerUIComponent.OnControlledEntityChanged ( IEntity from, IEntity to )

protected

SCR_PlayerController Event Used to reinit Task manager Component when new entity is controlled.

OnGroupChanged()

void SCR_TaskManagerUIComponent.OnGroupChanged ( int groupID )

protected

OnPlayerConnected()

override void SCR_TaskManagerUIComponent.OnPlayerConnected

(

int

playerId

)

Called after a player is connected.

Server-only.

Parameters

[in]

playerId

PlayerId of connected player.

Implements SCR_BaseGameModeComponent.

PanMapToTask()

void SCR_TaskManagerUIComponent.PanMapToTask ( string taskID = string::Empty, SCR_Task task = null )

protected

Moves camera to task position in map view.

Parameters

[in]	taskID
[in]	task

RefreshTaskList()

bool SCR_TaskManagerUIComponent.RefreshTaskList

(

)

Register task list component.

Returns

whether task list was refreshed or not

RegisterTaskList()

void SCR_TaskManagerUIComponent.RegisterTaskList

(

SCR_TaskListUIComponent

component

)

Register task list component.

Parameters

[in]

component

to be registered

SetHoveredTask()

void SCR_TaskManagerUIComponent.SetHoveredTask

(

SCR_Task

task

)

Sets provided task as hovered.

Parameters

[in]

task

SetJournalVisibility()

void SCR_TaskManagerUIComponent.SetJournalVisibility

(

bool

newVisibility

)

Sets new visiblity of journal and hides task list.

Parameters

[in]

visibility

of journal to be set.

SetSelectedTask()

void SCR_TaskManagerUIComponent.SetSelectedTask

(

SCR_Task

task

)

Sets provided task as selected.

Parameters

[in]

task

SetTaskDescriptionVisiblity()

bool SCR_TaskManagerUIComponent.SetTaskDescriptionVisiblity

(

bool

newVisibility

)

Parameters

[in]

visibility

of task description.

SetTaskListVisibility()

void SCR_TaskManagerUIComponent.SetTaskListVisibility

(

bool

newVisibility

)

Sets new visiblity of task list and hides journal.

Parameters

[in]

visibility

of task list to be set.

ShowTaskOnMap()

void SCR_TaskManagerUIComponent.ShowTaskOnMap

(

)

Requests panning map to task. If map is not opened - opens it.

TaskHUDVisibilityChanged()

void SCR_TaskManagerUIComponent.TaskHUDVisibilityChanged

(

bool

newVisibility

)

Invokes whenever task list on HUD is shown.

ToggleCurrentTask()

void SCR_TaskManagerUIComponent.ToggleCurrentTask

(

)

Displays a hint with currently selected task.

UpdateTaskBackground()

void SCR_TaskManagerUIComponent.UpdateTaskBackground	(	ResourceName	imageset,
		string	name )

Sets new background of task.

Parameters

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

UpdateTaskColors()

void SCR_TaskManagerUIComponent.UpdateTaskColors	(	Color	backgroundColor,
		Color	iconColor,
		Color	outlineColor )

Sets new colors on task icons.

If provided color is null, its being skipped.

Parameters

[in]	backgroundColor	- color of task shield background.
[in]	iconColor	- color of task symbol.
[in]	outlineColor	- color of task shield outline.

Member Data Documentation

ACTION_CLOSE_TASK_LIST

const string SCR_TaskManagerUIComponent.ACTION_CLOSE_TASK_LIST = "TasksClose"

staticprotected

CONTENT_TASK_LIST_MAP

const string SCR_TaskManagerUIComponent.CONTENT_TASK_LIST_MAP = "TaskListMapContext"

staticprotected

m_AssignedTask

SCR_Task SCR_TaskManagerUIComponent.m_AssignedTask

protected

m_bCurrentTaskVisible

bool SCR_TaskManagerUIComponent.m_bCurrentTaskVisible

protected

m_bDisplayOfAssigneesOnMap

bool SCR_TaskManagerUIComponent.m_bDisplayOfAssigneesOnMap

protected

m_bIsUnconscious

bool SCR_TaskManagerUIComponent.m_bIsUnconscious

protected

m_bShowCurrentTaskOnRespawn

bool SCR_TaskManagerUIComponent.m_bShowCurrentTaskOnRespawn

protected

m_fCurrentTaskShowTime

float SCR_TaskManagerUIComponent.m_fCurrentTaskShowTime

protected

m_HoveredTask

SCR_Task SCR_TaskManagerUIComponent.m_HoveredTask

protected

m_JournalComponent

SCR_MapJournalUI SCR_TaskManagerUIComponent.m_JournalComponent

protected

m_MapEntity

SCR_MapEntity SCR_TaskManagerUIComponent.m_MapEntity

protected

m_OnTaskAssigned

ref SCR_TaskAssignedInvoker SCR_TaskManagerUIComponent.m_OnTaskAssigned

protected

m_OnTaskBackgroundUpdate

ref SCR_TaskBackgroundUpdatedInvoker SCR_TaskManagerUIComponent.m_OnTaskBackgroundUpdate

protected

m_OnTaskColorsUpdate

ref SCR_TaskColorsUpdatedInvoker SCR_TaskManagerUIComponent.m_OnTaskColorsUpdate

protected

m_OnTaskHovered

ref SCR_TaskHoveredInvoker SCR_TaskManagerUIComponent.m_OnTaskHovered

protected

m_OnTaskHUDVisible

ref ScriptInvokerBool SCR_TaskManagerUIComponent.m_OnTaskHUDVisible

protected

m_OnTaskSelected

ref SCR_TaskSelectedInvoker SCR_TaskManagerUIComponent.m_OnTaskSelected

protected

m_sDefaultIcon

string SCR_TaskManagerUIComponent.m_sDefaultIcon

protected

m_sDefaultImageset

ResourceName SCR_TaskManagerUIComponent.m_sDefaultImageset

protected

m_SelectedTask

SCR_Task SCR_TaskManagerUIComponent.m_SelectedTask

protected

m_sTaskHintLayout

ResourceName SCR_TaskManagerUIComponent.m_sTaskHintLayout

protected

m_sTaskTabConfig

string SCR_TaskManagerUIComponent.m_sTaskTabConfig

protected

m_TaskListComponent

SCR_TaskListUIComponent SCR_TaskManagerUIComponent.m_TaskListComponent

protected

m_TaskSystem

SCR_TaskSystem SCR_TaskManagerUIComponent.m_TaskSystem

protected

m_TaskTabConfig

ref SCR_TasksTabConfig SCR_TaskManagerUIComponent.m_TaskTabConfig

protected

m_wTaskHint

Widget SCR_TaskManagerUIComponent.m_wTaskHint

protected

s_Instance

SCR_TaskManagerUIComponent SCR_TaskManagerUIComponent.s_Instance

static

---

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

• Game/Tasks/SCR_TaskManagerUIComponent.c