SCR_BaseTaskExecutor Interface Reference

Inheritance diagram for SCR_BaseTaskExecutor:

Public Member Functions
int	GetExecutorID ()
IEntity	GetControlledEntity ()
SCR_BaseTask	GetAssignedTask ()
	Returns currently assigned task.
string	GetPlayerName ()
	Returns player name of this task executor.
void	SetPlayerID (int playerID)
	Sets this task executor the given player ID.
void	AssignNewTask (SCR_BaseTask task)
	Assigns new task.
void	OnAssignedTaskRemoved ()
	An event called when the assigned task has been removed.
void	OnAssignedTaskFailed ()
	An event called when the assigned task has failed.
void	OnAssignedTaskFinished ()
	An event called when the assigned task has been finished.
void	SCR_BaseTaskExecutor (IEntitySource src, IEntity parent)
void	~SCR_BaseTaskExecutor ()

Static Public Member Functions
static map< SCR_BaseTaskExecutor, int >	GetTaskExecutorsMap ()
static int	GetTaskExecutorID (SCR_BaseTaskExecutor taskExecutor)
static int	GetLocalExecutorID ()
static SCR_BaseTaskExecutor	GetLocalExecutor ()
	Returns the local task executor.
static SCR_BaseTaskExecutor	FindTaskExecutorByID (int playerID)
static notnull SCR_BaseTaskExecutor	GetTaskExecutorByID (int playerID)
	Returns the task executor with given ID.

Static Public Attributes
static const int	INVALID_PLAYER_ID = -1

Protected Member Functions
void	OnNewTaskAssigned (SCR_BaseTask oldTask, SCR_BaseTask newTask)
	An event called when a new task has been assigned to this task executor.

Protected Attributes
SCR_BaseTask	m_CurrentTask

Static Protected Attributes
static ref map< SCR_BaseTaskExecutor, int >	s_mTaskExecutors = new map<SCR_BaseTaskExecutor, int>()
static SCR_BaseTaskExecutor	s_LocalTaskExecutor = null

Constructor & Destructor Documentation

SCR_BaseTaskExecutor()

void SCR_BaseTaskExecutor.SCR_BaseTaskExecutor	(	IEntitySource	src,
		IEntity	parent
	)

~SCR_BaseTaskExecutor()

void SCR_BaseTaskExecutor.~SCR_BaseTaskExecutor

(

)

Member Function Documentation

AssignNewTask()

void SCR_BaseTaskExecutor.AssignNewTask

(

SCR_BaseTask

task

)

Assigns new task.

FindTaskExecutorByID()

static SCR_BaseTaskExecutor SCR_BaseTaskExecutor.FindTaskExecutorByID ( int  playerID )

static

GetAssignedTask()

SCR_BaseTask SCR_BaseTaskExecutor.GetAssignedTask

(

)

Returns currently assigned task.

GetControlledEntity()

IEntity SCR_BaseTaskExecutor.GetControlledEntity

(

)

GetExecutorID()

int SCR_BaseTaskExecutor.GetExecutorID

(

)

GetLocalExecutor()

static SCR_BaseTaskExecutor SCR_BaseTaskExecutor.GetLocalExecutor ( )

static

Returns the local task executor.

GetLocalExecutorID()

static int SCR_BaseTaskExecutor.GetLocalExecutorID ( )

static

GetPlayerName()

string SCR_BaseTaskExecutor.GetPlayerName

(

)

Returns player name of this task executor.

GetTaskExecutorByID()

static notnull SCR_BaseTaskExecutor SCR_BaseTaskExecutor.GetTaskExecutorByID ( int  playerID )

static

Returns the task executor with given ID.

GetTaskExecutorID()

static int SCR_BaseTaskExecutor.GetTaskExecutorID ( SCR_BaseTaskExecutor  taskExecutor )

static

GetTaskExecutorsMap()

static map< SCR_BaseTaskExecutor, int > SCR_BaseTaskExecutor.GetTaskExecutorsMap ( )

static

OnAssignedTaskFailed()

void SCR_BaseTaskExecutor.OnAssignedTaskFailed

(

)

An event called when the assigned task has failed.

OnAssignedTaskFinished()

void SCR_BaseTaskExecutor.OnAssignedTaskFinished

(

)

An event called when the assigned task has been finished.

OnAssignedTaskRemoved()

void SCR_BaseTaskExecutor.OnAssignedTaskRemoved

(

)

An event called when the assigned task has been removed.

OnNewTaskAssigned()

void SCR_BaseTaskExecutor.OnNewTaskAssigned ( SCR_BaseTask  oldTask, SCR_BaseTask  newTask  )

protected

An event called when a new task has been assigned to this task executor.

SetPlayerID()

void SCR_BaseTaskExecutor.SetPlayerID

(

int

playerID

)

Sets this task executor the given player ID.

Member Data Documentation

INVALID_PLAYER_ID

const int SCR_BaseTaskExecutor.INVALID_PLAYER_ID = -1

static

m_CurrentTask

SCR_BaseTask SCR_BaseTaskExecutor.m_CurrentTask

protected

s_LocalTaskExecutor

SCR_BaseTaskExecutor SCR_BaseTaskExecutor.s_LocalTaskExecutor = null

staticprotected

s_mTaskExecutors

ref map<SCR_BaseTaskExecutor, int> SCR_BaseTaskExecutor.s_mTaskExecutors = new map<SCR_BaseTaskExecutor, int>()

staticprotected

---

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

• Game/Tasks/SCR_BaseTaskExecutor.c