SCR_EditorTask.c File Reference

Go to the source code of this file.

Classes
class	SCR_EditorTaskClass

Functions
SCR_EditorTaskClass SCR_ExtendedTaskClass	Attribute (SCR_Enum.GetDefault(ETaskTextType.NONE), UIWidgets.ComboBox, enums:ParamEnumArray.FromEnum(ETaskTextType))] protected ETaskTextType m_TextType
void	SetLocationName (LocalizedString locationName)
string	GetLocationName ()
ETaskTextType	GetTextType ()
int	GetTextIndex ()
void	SetTextIndex (int index)
EEditorTaskCompletionType	GetTaskCompletionType ()
void	SetTaskCompletionType (EEditorTaskCompletionType newTaskCompletionType)
override void	SetTaskState (SCR_ETaskState state)
void	Rpc_PopUpNotification (string prefix, bool alwaysInEditor)
void	ShowPopUpNotification (string subtitle)
void	ShowTaskNotification (ENotification taskNotification, bool SendOverNetwork=false)
void	DelayedPlacedNotification (vector position, int taskID, int factionIndex)
override void	EOnInit (IEntity owner)
void	~SCR_EditorTask ()

Variables
int	m_iTextIndex
EEditorTaskCompletionType	m_iTaskCompletionType
LocalizedString	m_sLocationName
const string	GENERATED_TASK_PREFIX = "$EDITOR_TASK_"

Function Documentation

Attribute()

SCR_EditorTaskClass SCR_ExtendedTaskClass Attribute	(	SCR_Enum.	GetDefaultETaskTextType.NONE,
		UIWidgets.	ComboBox,
		enums:ParamEnumArray.	FromEnumETaskTextType )

DelayedPlacedNotification()

void DelayedPlacedNotification ( vector position, int taskID, int factionIndex )

protected

Definition at line 205 of file SCR_EditorTask.c.

GetLocationName()

string GetLocationName ( )

protected

Get name of location to which this task relates to.

Returns

string locationName Name of the location

Definition at line 37 of file SCR_EditorTask.c.

GetTaskCompletionType()

EEditorTaskCompletionType GetTaskCompletionType ( )

protected

Get the task completion type

Returns

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

Definition at line 77 of file SCR_EditorTask.c.

GetTextIndex()

int GetTextIndex ( )

protected

Get index of custom text from SCR_TextsTaskManagerComponent.

Returns

Index from the array of texts

Definition at line 57 of file SCR_EditorTask.c.

GetTextType()

ETaskTextType GetTextType ( )

protected

Get type of custom texts this task should use.

Returns

Type of texts

Definition at line 47 of file SCR_EditorTask.c.

Rpc_PopUpNotification()

void Rpc_PopUpNotification ( string prefix, bool alwaysInEditor )

protected

Definition at line 136 of file SCR_EditorTask.c.

SetLocationName()

void SetLocationName ( LocalizedString locationName )

protected

Set name of location to which this task relates to.

Parameters

locationName

Name of the location

Definition at line 27 of file SCR_EditorTask.c.

SetTaskCompletionType()

void SetTaskCompletionType ( EEditorTaskCompletionType newTaskCompletionType )

protected

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

Definition at line 87 of file SCR_EditorTask.c.

SetTaskState()

override void SetTaskState ( SCR_ETaskState state )

protected

Definition at line 96 of file SCR_EditorTask.c.

SetTextIndex()

void SetTextIndex ( int index )

protected

Set index of custom text from SCR_TextsTaskManagerComponent.

Parameters

index

Index from the array of texts

Definition at line 67 of file SCR_EditorTask.c.

ShowPopUpNotification()

void ShowPopUpNotification ( string subtitle )

protected

Definition at line 160 of file SCR_EditorTask.c.

ShowTaskNotification()

void ShowTaskNotification ( ENotification taskNotification, bool SendOverNetwork = false )

protected

Show notification related to the task state. Delete notification is called by SCR_EditableTaskComponent

Parameters

taskNotification

notification to show

Definition at line 170 of file SCR_EditorTask.c.

~SCR_EditorTask()

void ~SCR_EditorTask ( )

protected

Definition at line 223 of file SCR_EditorTask.c.

Variable Documentation

GENERATED_TASK_PREFIX

const string GENERATED_TASK_PREFIX = "$EDITOR_TASK_"

protected

Definition at line 20 of file SCR_EditorTask.c.

m_iTaskCompletionType

EEditorTaskCompletionType m_iTaskCompletionType

protected

Definition at line 15 of file SCR_EditorTask.c.

m_iTextIndex

int m_iTextIndex

protected

Definition at line 12 of file SCR_EditorTask.c.

m_sLocationName

LocalizedString m_sLocationName

protected

Definition at line 17 of file SCR_EditorTask.c.