SCR_MoveTask Interface Reference

Inheritance diagram for SCR_MoveTask:

Public Member Functions
void	PeriodicalCheck ()
override void	SetTaskCompletionType (EEditorTaskCompletionType newTaskCompletionType)
	Set the task completion type.
void	SCR_MoveTask (IEntitySource src, IEntity parent)
void	~SCR_MoveTask ()
Public Member Functions inherited from SCR_AttachableTask
void	SetTarget (SCR_EditableEntityComponent target)
	Sets target of current task.
SCR_EditableEntityComponent	GetTarget ()
	Returns current target.
Public Member Functions inherited from SCR_EditorTask
void	SetLocationName (LocalizedString locationName)
	Set name of location to which this task relates to.
string	GetLocationName ()
	Get name of location to which this task relates to.
ETaskTextType	GetTextType ()
	Get type of custom texts this task should use.
int	GetTextIndex ()
	Get index of custom text from SCR_TextsTaskManagerComponent.
void	SetTextIndex (int index)
	Set index of custom text from SCR_TextsTaskManagerComponent.
EEditorTaskCompletionType	GetTaskCompletionType ()
	Get the task completion type.
SCR_UIDescription	GetInfo ()
	Get UI info of custom text for this task.
override string	GetTitle ()
	Return the title of this task.
override void	SetTitleWidgetText (notnull TextWidget textWidget, string taskText)
override void	SetDescriptionWidgetText (notnull TextWidget textWidget, string taskText)
void	ShowTaskNotification (ENotification taskNotification, bool SendOverNetwork=false)
	Show notification related to the task state.
override void	Create (bool showMsg=true)
	When the task is created.
override void	Finish (bool showMsg=true)
	Marks the task as finished.
override void	Fail (bool showMsg=true)
	Fails the task.
override void	Cancel (bool showMsg=true)
Public Member Functions inherited from SCR_BaseTask
void	OnDelete ()
bool	NotifyAssignment ()
bool	NotifyUnassign ()
void	DoNotifyAssignment (int assigneeID)
void	DoNotifyUnassign (int assigneeID)
SCR_ERadioMsg	GetAssignMessage ()
SCR_ERadioMsg	GetUnassignMessage ()
ResourceName	GetMapUIElementResourceName ()
string	GetMapDescriptorText ()
void	OnMapOpen (MapConfiguration config)
void	OnHoverItem (MapItem item)
string	GetFullTaskIconName ()
string	GetTaskMapIconName ()
string	GetTaskListIconNamePrefix ()
string	GetTaskListIconName ()
string	GetTaskListTaskTitle ()
string	GetMajorModifier ()
string	GetTaskListTaskText ()
Widget	GetParentWidget (notnull Widget rootWidget)
ResourceName	GetIconImageset ()
void	SetHUDIcon ()
void	SetWidgetIcon (ImageWidget image)
void	ClearWidgetIcon ()
	Remove icon assigned to this task.
void	UpdateMapTaskIcon ()
void	UpdatePriorityMapTaskIcon ()
bool	AssignTaskToAI (AIAgent agent)
string	GetIconName ()
ResourceName	GetImageSetName ()
string	GetIconSuffix ()
string	GetTitleIconString ()
string	GetTitleText ()
Widget	GenerateTaskDescriptionUI (notnull Widget rootWidget, array< Widget > widgets)
void	UpdateTaskListAssignee ()
void	OnAssigneeKilled ()
void	CreateMapUIIcon ()
Faction	GetTargetFaction ()
	Returns the faction that should complete this task.
void	SetTargetFaction (Faction targetFaction)
	Sets the faction that should complete this task.
string	GetFinishText ()
	Returns a text informing about the task being finished.
bool	IsAssigned ()
	Returns whether the task is assigned to someone or not.
string	GetAllAssigneeNamesString ()
	Returns a string with all the assignees on this task in following format: "PlayerA, PlayerB, ..., PlayerN".
void	CheckAssigneeTimeout ()
	Checks all the assignees for timeout, if their time is up, they get unassigned.
void	SetLastAssigneeAddedTimestamp (float timestamp)
void	SetIndividual (bool individual)
	Set this task as task for an individual.
bool	IsIndividual ()
	Returns whether this task is for an individual or not.
void	SetIsPriority (bool isPrio)
bool	IsPriority ()
bool	IsAssignable ()
bool	CanBeAssigned (out SCR_ECannotAssignReasons reason, int playerID=-1)
	Returns whether this task can be assigned to the player with the given player ID If playerID == -1, the local player is used as the target.
float	GetLastAssigneeAddedTimestamp ()
	Returns the timestamp of last add assignee event.
float	GetAssigneeTimeLeft ()
	Returns time left the assignee of this task has to finish it, after that they get automatically unassigned.
void	SetTaskID (int taskID)
	Sets an ID of this task.
int	GetTaskID ()
	Returns an ID of this task.
SCR_TaskState	GetTaskState ()
	Returns the state of this task.
void	SetTitle (string title)
void	SetDescription (string description)
string	GetDescription ()
	Return the description of this task.
SCR_BaseTaskExecutor	GetAssignee ()
	Returns the first assignee of this task.
int	GetAssignees (out array< SCR_BaseTaskExecutor > assignees)
	Returns assignees of this task.
int	GetAssigneeCount ()
void	Remove ()
	Marks the task as removed.
void	RemoveAllAssignees ()
	Removes every assignee from this task.
void	RemoveAssignee (SCR_BaseTaskExecutor assignee, SCR_EUnassignReason reason)
	Removes an assignee, specified as a parameter, from this task.
void	AddAssignee (SCR_BaseTaskExecutor assignee, float timestamp)
	Adds a new assignee, specified as a parameter, to this task.
void	InitOnSpawn (int pid, IEntity ent)
void	ToggleHUDIcon (bool show, bool fade=true)
void	UpdateHUDIcon ()
Widget	GetTaskIconkWidget ()
void	SetTaskIconWidget (Widget w)
void	SetState (SCR_TaskState state)
	Changes the state of this task to the parameter.
void	RegisterTaskUpdate (SCR_ETaskEventMask TaskEventMask)
	Registers task event mask for OnTaskUpdate.
void	Serialize (ScriptBitWriter writer)
void	Deserialize (ScriptBitReader reader)
override void	EOnInit (IEntity owner)
void	SCR_BaseTask (IEntitySource src, IEntity parent)
void	~SCR_BaseTask ()

Protected Attributes
float	m_fMaxDistance
Protected Attributes inherited from SCR_AttachableTask
SCR_EditableEntityComponent	m_Target
Protected Attributes inherited from SCR_EditorTask
ETaskTextType	m_TextType
int	m_iTextIndex
EEditorTaskCompletionType	m_iTaskCompletionType
LocalizedString	m_sLocationName
Protected Attributes inherited from SCR_BaseTask
string	m_sName
string	m_sDescription
bool	m_bAssignable
bool	m_bIndividualTask
string	m_sMapIconName
string	m_sTaskListIconNamePrefix
string	m_sTaskListIconName
string	m_sMajorModifier
ResourceName	m_sMapUIElementResourceName
ResourceName	m_sIconImageset
SCR_ERadioMsg	m_eAssignMessage
bool	m_bNotifyAssignment
SCR_ERadioMsg	m_eUnassignMessage
bool	m_bNotifyUnassign
ResourceName	m_sHUDIcon
Faction	m_TargetFaction = null
int	m_iTaskID = INVALID_TASK_ID
float	m_fAssigneeTimeLimit = DEFAULT_ASSIGNEE_TIME_LIMIT
float	m_fLastAssigneeAddedTimestamp = INVALID_TIMESTAMP
ref array< SCR_BaseTaskExecutor >	m_aAssignees = new array<SCR_BaseTaskExecutor>()
SCR_TaskState	m_eState
SCR_BaseTaskExecutor	m_TimedOutAssignee = null
float	m_fAssigneeTimeoutTimestamp = INVALID_TIMESTAMP
SCR_MapDescriptorComponent	m_MapDescriptor
ImageWidget	m_wHUDIcon
Widget	m_wMapTaskIcon
Widget	m_wTaskListDescription
bool	m_bIsPriority
SCR_PlayerFactionAffiliationComponent	m_sPlyFactionAffilComp
float	m_fMajorSize = 80

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseTask
static const string	TASK_AMOUNT_COMPLETED_TEXT = "#AR-Tasks_AmountCompleted"
static const string	TASK_PROGRESS_TEXT = "#AR-Tasks_StatusProgress-UC"
static const string	TASK_FINISHED_TEXT = "#AR-Tasks_StatusFinished-UC"
static const string	TASK_AVAILABLE_TEXT = "#AR-Tasks_StatusNew-UC"
static const string	TASK_HINT_TEXT = "#AR-Tasks_Hint"
static const string	TASK_CANCELLED_TEXT = "#AR-Tasks_StatusCancelled-UC"
static const string	TASK_COMPLETED_TEXT = "#AR-Tasks_StatusCompleted-UC"
static const string	TASK_FAILED_TEXT = "#AR-Tasks_StatusFailed-UC"
static const float	DEFAULT_ASSIGNEE_TIME_LIMIT = 1800
static const float	DEFAULT_ASSIGNEE_TIMEOUT_TIME = 60
static const int	INVALID_TIMESTAMP = -1
static const int	INVALID_TASK_ID = -1
static int	s_iCurrentTaskID = 0
const string	TASK_BG_M = "Icon_M_Task_BG"
const string	TASK_O_M = "Icon_M_Task_Outline"
const string	TASK_BG = "Icon_Task_BG"
const string	TASK_O = "Icon_Task_Outline"
const string	TASK_H = "Icon_M_Task_Hover"
const string	Task_S = "TaskIconSymbol"
Protected Member Functions inherited from SCR_EditorTask
void	PopUpNotification (string prefix, bool alwaysInEditor)
override void	ShowPopUpNotification (string subtitle)
override void	OnStateChanged (SCR_TaskState previousState, SCR_TaskState newState)
	An event called when the state of this task has been changed.
void	DelayedPlacedNotification (vector position, int taskID, int factionIndex)
override bool	RplLoad (ScriptBitReader reader)
override bool	RplSave (ScriptBitWriter writer)
Protected Member Functions inherited from SCR_BaseTask
void	UpdateMapInfo ()
bool	DoneByAssignee ()
void	ShowTaskProgress (bool showMsg=true)
void	ShowAvailableTask (bool afterAssigneeRemoved=false)
	Shows a message informing about this task being available.
bool	IsAssignedToLocalPlayer ()
	Returns whether this task is assigned to the local player.
void	OnAssigneeRemoved (SCR_BaseTaskExecutor oldAssignee)
	An event called when an assignee has been removed from this task.
void	OnAssigneeAdded (SCR_BaseTaskExecutor newAssignee)
	An event called when a new assignee has been added to this task.
Static Protected Attributes inherited from SCR_BaseTask
static const float	PLATFORM_ICON_SIZE = 2

Constructor & Destructor Documentation

SCR_MoveTask()

void SCR_MoveTask.SCR_MoveTask	(	IEntitySource	src,
		IEntity	parent )

~SCR_MoveTask()

void SCR_MoveTask.~SCR_MoveTask

(

)

Member Function Documentation

PeriodicalCheck()

void SCR_MoveTask.PeriodicalCheck

(

)

SetTaskCompletionType()

override void SCR_MoveTask.SetTaskCompletionType

(

EEditorTaskCompletionType

newTaskCompletionType

)

Set the task completion type.

Parameters

newTaskCompletionType

MANUAL and ALWAYS_MENUAL means only the GM can complete the task. AUTOMATIC means that the task can auto complete and/or fail depending on the task

Implements SCR_EditorTask.

Member Data Documentation

m_fMaxDistance

float SCR_MoveTask.m_fMaxDistance

protected

---

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

• Game/Tasks/SCR_MoveTask.c