SCR_EditableTaskComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_EditableTaskComponentClass

Functions
void	ActivateTask ()
	Reveal the task to all players. More...
bool	IsTaskActivated ()
ETaskTextType	GetTextType ()
int	GetTextIndex ()
void	SetTextIndex (int index)
protected void	SetTextIndexBroadcast (int index)
EEditorTaskCompletionType	GetTaskCompletionType ()
void	SetTaskCompletionType (EEditorTaskCompletionType completionType)
protected void	SetTaskCompletionTypeBroadcast (EEditorTaskCompletionType completionType)
protected void	UpdateText ()
override protected void	GetOnLocationChange (SCR_EditableEntityComponent nearestLocation)
override Faction	GetFaction ()
override void	SetTransform (vector transform[4], bool changedByUser=false)
override bool	Serialize (out SCR_EditableEntityComponent outTarget=null, out int outTargetIndex=-1, out EEditableEntitySaveFlag outSaveFlags=0)
override void	Deserialize (SCR_EditableEntityComponent target, int targetValue)
override ScriptInvoker	GetOnUIRefresh ()
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override SCR_EditableEntityComponent	EOnEditorPlace (out SCR_EditableEntityComponent parent, SCR_EditableEntityComponent recipient, EEditorPlacingFlags flags, bool isQueue, int playerID=0)
void	SCR_EditableTaskComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
override bool	Delete (bool changedByUser=false, bool updateNavmesh=true)

Variables
SCR_EditableTaskComponentClass	m_Task
	Editable SCR_BaseTask. More...
protected Faction	m_TargetFaction
protected int	m_iTextIndex

Function Documentation

ActivateTask()

void ActivateTask

(

)

Reveal the task to all players.

Definition at line 27 of file SCR_EditableTaskComponent.c.

Delete()

override bool Delete	(	bool	changedByUser = false,
		bool	updateNavmesh = true
	)

Definition at line 229 of file SCR_EditableTaskComponent.c.

Deserialize()

override void Deserialize	(	SCR_EditableEntityComponent	target,
		int	targetValue
	)

Definition at line 142 of file SCR_EditableTaskComponent.c.

EOnEditorPlace()

override SCR_EditableEntityComponent EOnEditorPlace	(	out SCR_EditableEntityComponent	parent,
		SCR_EditableEntityComponent	recipient,
		EEditorPlacingFlags	flags,
		bool	isQueue,
		int	playerID = 0
	)

Definition at line 201 of file SCR_EditableTaskComponent.c.

GetFaction()

override Faction GetFaction

(

)

Definition at line 122 of file SCR_EditableTaskComponent.c.

GetOnLocationChange()

override protected void GetOnLocationChange

(

SCR_EditableEntityComponent

nearestLocation

)

Definition at line 116 of file SCR_EditableTaskComponent.c.

GetOnUIRefresh()

override ScriptInvoker GetOnUIRefresh

(

)

Definition at line 155 of file SCR_EditableTaskComponent.c.

GetTaskCompletionType()

EEditorTaskCompletionType GetTaskCompletionType

(

)

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 82 of file SCR_EditableTaskComponent.c.

GetTextIndex()

int GetTextIndex

(

)

Get index of custom text from SCR_TextsTaskManagerComponent.

Returns

Index from the array of texts

Definition at line 56 of file SCR_EditableTaskComponent.c.

GetTextType()

ETaskTextType GetTextType

(

)

Get type of custom texts this task should use.

Returns

Type of texts

Definition at line 48 of file SCR_EditableTaskComponent.c.

IsTaskActivated()

bool IsTaskActivated

(

)

Check if the task is active, i.e., shown to players.

Returns

true when active

Definition at line 40 of file SCR_EditableTaskComponent.c.

RplLoad()

override bool RplLoad

(

ScriptBitReader

reader

)

Definition at line 180 of file SCR_EditableTaskComponent.c.

RplSave()

override bool RplSave

(

ScriptBitWriter

writer

)

Definition at line 161 of file SCR_EditableTaskComponent.c.

SCR_EditableTaskComponent()

void SCR_EditableTaskComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Parameters

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

Definition at line 223 of file SCR_EditableTaskComponent.c.

Serialize()

override bool Serialize	(	out SCR_EditableEntityComponent	outTarget = null,
		out int	outTargetIndex = -1,
		out EEditableEntitySaveFlag	outSaveFlags = 0
	)

Definition at line 135 of file SCR_EditableTaskComponent.c.

SetTaskCompletionType()

void SetTaskCompletionType

(

EEditorTaskCompletionType

completionType

)

Set the task completion type

Parameters

[in]

completionType

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 90 of file SCR_EditableTaskComponent.c.

SetTaskCompletionTypeBroadcast()

protected void SetTaskCompletionTypeBroadcast

(

EEditorTaskCompletionType

completionType

)

Definition at line 101 of file SCR_EditableTaskComponent.c.

SetTextIndex()

void SetTextIndex

(

int

index

)

Set index of custom text from SCR_TextsTaskManagerComponent.

Parameters

[in]

index

Index from the array of texts

Definition at line 64 of file SCR_EditableTaskComponent.c.

SetTextIndexBroadcast()

protected void SetTextIndexBroadcast

(

int

index

)

Definition at line 72 of file SCR_EditableTaskComponent.c.

SetTransform()

override void SetTransform	(	vector	transform[4],
		bool	changedByUser = false
	)

Definition at line 128 of file SCR_EditableTaskComponent.c.

UpdateText()

protected void UpdateText

(

)

Definition at line 107 of file SCR_EditableTaskComponent.c.

Variable Documentation

m_iTextIndex

protected int m_iTextIndex

Definition at line 23 of file SCR_EditableTaskComponent.c.

m_TargetFaction

protected Faction m_TargetFaction

Definition at line 22 of file SCR_EditableTaskComponent.c.