SCR_TransportTaskSupportEntity Interface Reference

Inheritance diagram for SCR_TransportTaskSupportEntity:

Public Member Functions
float	GetMaxDistanceAssigneeSq ()
float	GetMaxDistanceDestinationSq ()
SCR_TransportTask	CreateNewTransportTask (int requesterID, vector fromPosition, vector toPosition)
void	SetTargetPosition (notnull SCR_TransportTask task, vector position)
void	TransportTaskNextPhase (notnull SCR_TransportTask transportTask)
void	RPC_SetTargetPosition (int taskID, vector position)
void	RequestTransport (int requesterID, vector fromPosition, vector toPosition)
override bool	CanRequest ()
override void	SetRequestButtonText (notnull TextWidget textWidget)
override void	Request ()
Public Member Functions inherited from SCR_RequestedTaskSupportEntity
void	SetLocallyRequestedTask (notnull SCR_RequestedTask requestedTask)
SCR_RequestedTask	GetLocallyRequestedTask ()
void	SetRequester (notnull SCR_RequestedTask task, SCR_BaseTaskExecutor requester)
void	RPC_SetRequester (int taskID, int requesterID)
vector	GetRequestPosition ()
bool	CanRequest ()
void	SetRequestButtonText (notnull TextWidget textWidget)
void	Request ()
Widget	CreateButtonAndSetPadding (Widget parentWidget, notnull inout array< Widget > widgets, float left=4, float top=4, float right=4, float bottom=4)
Public Member Functions inherited from SCR_BaseTaskSupportEntity
void	SetTargetFaction (notnull SCR_BaseTask task, notnull Faction faction)
void	RPC_SetTargetFaction (int taskID, int factionIndex)
SCR_BaseTask	CreateTask ()
void	Initialize ()
void	OnTaskListOpen (notnull SCR_UITaskManagerComponent uiTaskManagerComponent)
ResourceName	GetTaskDescriptionWidgetResource ()
ResourceName	GetResourceName ()
Resource	GetTaskPrefab ()
void	MoveTask (vector newPosition, int taskID)
void	RPC_MoveTask (int taskID, vector newPosition)
void	AssignTask (notnull SCR_BaseTask task, notnull SCR_BaseTaskExecutor assignee, bool forced=false)
void	RPC_AssignTask (int playerID, int taskID, float timestamp, bool forced)
	Assigns a task on clients.
void	CancelTask (int taskID)
void	FinishTask (notnull SCR_BaseTask task)
void	FailTask (notnull SCR_BaseTask task)
void	UnassignTask (notnull SCR_BaseTask task, notnull SCR_BaseTaskExecutor assignee, SCR_EUnassignReason reason)
void	RPC_UnassignTask (int taskID, int playerID, SCR_EUnassignReason reason)
	Assigns a task on clients.
void	SetTaskDescription (notnull SCR_BaseTask task, string description)
void	RPC_SetTaskDescription (int taskID, string description)
void	SetTaskTitle (notnull SCR_BaseTask task, string title)
void	RPC_SetTaskTitle (int taskID, string title)
void	OnMapOpen (MapConfiguration config)
override void	EOnInit (IEntity owner)
void	SCR_BaseTaskSupportEntity (IEntitySource src, IEntity parent)
void	~SCR_BaseTaskSupportEntity ()

Protected Member Functions
void	RPC_TransportTaskNextPhase (int taskID)
override void	RegisterContextualMenuCallbacks ()
void	SetToPosition ()
void	SetFromPosition ()
override void	RegisterContextualMenuCallbacks ()
Protected Member Functions inherited from SCR_BaseTaskSupportEntity
void	RPC_CancelTask (int taskID)
void	RPC_FinishTask (int taskID)
void	RPC_FailTask (int taskID)
void	RegisterContextualMenuCallbacks ()

Protected Attributes
LocalizedString	m_sRequestFromText
LocalizedString	m_sRequestToText
float	m_fMaxDistanceAssignee
float	m_fMaxDistanceDestination
bool	m_bSetFromPosition
vector	m_vFromPosition
vector	m_vToPosition
Protected Attributes inherited from SCR_RequestedTaskSupportEntity
ResourceName	m_sUIRequestButtonResource
SCR_EUIRequestType	m_eRequestType
LocalizedString	m_sRequestButtonText
SCR_RequestedTask	m_LocallyRequestedTask
Protected Attributes inherited from SCR_BaseTaskSupportEntity
ResourceName	m_sTaskDescriptionWidgetResource
ResourceName	m_sTaskPrefab

Member Function Documentation

CanRequest()

override bool SCR_TransportTaskSupportEntity.CanRequest

(

)

Implements SCR_RequestedTaskSupportEntity.

CreateNewTransportTask()

SCR_TransportTask SCR_TransportTaskSupportEntity.CreateNewTransportTask	(	int	requesterID,
		vector	fromPosition,
		vector	toPosition
	)

GetMaxDistanceAssigneeSq()

float SCR_TransportTaskSupportEntity.GetMaxDistanceAssigneeSq

(

)

GetMaxDistanceDestinationSq()

float SCR_TransportTaskSupportEntity.GetMaxDistanceDestinationSq

(

)

RegisterContextualMenuCallbacks()

override void SCR_TransportTaskSupportEntity.RegisterContextualMenuCallbacks ( )

protected

Implements SCR_RequestedTaskSupportEntity.

Request()

override void SCR_TransportTaskSupportEntity.Request

(

)

Implements SCR_RequestedTaskSupportEntity.

RequestTransport()

void SCR_TransportTaskSupportEntity.RequestTransport	(	int	requesterID,
		vector	fromPosition,
		vector	toPosition
	)

RPC_SetTargetPosition()

void SCR_TransportTaskSupportEntity.RPC_SetTargetPosition	(	int	taskID,
		vector	position
	)

RPC_TransportTaskNextPhase()

void SCR_TransportTaskSupportEntity.RPC_TransportTaskNextPhase ( int  taskID )

protected

SetFromPosition()

void SCR_TransportTaskSupportEntity.SetFromPosition ( )

protected

SetRequestButtonText()

override void SCR_TransportTaskSupportEntity.SetRequestButtonText

(

notnull TextWidget

textWidget

)

Implements SCR_RequestedTaskSupportEntity.

SetTargetPosition()

void SCR_TransportTaskSupportEntity.SetTargetPosition	(	notnull SCR_TransportTask	task,
		vector	position
	)

SetToPosition()

void SCR_TransportTaskSupportEntity.SetToPosition ( )

protected

TransportTaskNextPhase()

void SCR_TransportTaskSupportEntity.TransportTaskNextPhase

(

notnull SCR_TransportTask

transportTask

)

Member Data Documentation

m_bSetFromPosition

bool SCR_TransportTaskSupportEntity.m_bSetFromPosition

protected

m_fMaxDistanceAssignee

float SCR_TransportTaskSupportEntity.m_fMaxDistanceAssignee

protected

m_fMaxDistanceDestination

float SCR_TransportTaskSupportEntity.m_fMaxDistanceDestination

protected

m_sRequestFromText

LocalizedString SCR_TransportTaskSupportEntity.m_sRequestFromText

protected

m_sRequestToText

LocalizedString SCR_TransportTaskSupportEntity.m_sRequestToText

protected

m_vFromPosition

vector SCR_TransportTaskSupportEntity.m_vFromPosition

protected

m_vToPosition

vector SCR_TransportTaskSupportEntity.m_vToPosition

protected

---

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

• Game/Tasks/SupportEntities/SCR_TransportTaskSupportEntity.c