Inheritance diagram for SCR_TaskDeliver:

[legend]

Public Member Functions
int	GetTaskDeliverState ()

void	SetDeliveryTrigger ()
	Sets delivery trigger by name if it exists in the world.

void	SetDeliveryTrigger (SCR_BaseTriggerEntity trigger)

void	SetTriggerNameToDeliver (string triggerName)

string	GetTriggerNameToDeliver ()

void	OnDeliveryTriggerActivated (notnull SCR_ScenarioFrameworkTriggerEntity trigger)

void	OnObjectPossessed (IEntity item, BaseInventoryStorageComponent pStorageOwner)
	Updates task title and description if possessed item matches asset, sets delivery item found flag if not, and progresses state if.

void	OnObjectDropped (IEntity item, BaseInventoryStorageComponent pStorageOwner)
	Updates task state and title/description when an item is dropped into inventory.

void	UpdateTaskTitleAndDescription (int iPossessed=-1)
	Updates task title and description based on object state, triggers delivery, and sets task title and description for the support entity.

override void	UpdateMapTaskIcon ()
	Updates map task icon visibility based on object state, sets opacity and visibility accordingly.

override bool	SetSupportEntity ()
	Sets support entity for task delivery, returns true if found, logs error if not found.

override void	Init ()
	Initializes inventory component, registers players, and sets event handlers for player spawning and disconnecting.

Public Member Functions inherited from SCR_ScenarioFrameworkTask
void	SetTaskState (SCR_TaskState state)

void	SetLayerTask (SCR_ScenarioFrameworkLayerTask layer)

SCR_ScenarioFrameworkLayerTask	GetLayerTask ()

override void	OnStateChanged (SCR_TaskState previousState, SCR_TaskState newState)
	An event called when the state of this task has been changed.

override void	Finish (bool showMsg=true)
	Finishes mission based on player's faction, shows message if player's faction matches target faction.

void	SetTaskAsset (IEntity object)

void	RehookTaskAsset (IEntity object)
	Updates linked entity for this task.

IEntity	GetAsset ()

void	SetSlotTask (SCR_ScenarioFrameworkSlotTask slotTask)

SCR_ScenarioFrameworkSlotTask	GetSlotTask ()

SCR_ScenarioFrameworkTaskSupportEntity	GetSupportEntity ()

void	SetTaskExecutionBriefing (string text)

string	GetTaskExecutionBriefing ()

void	SetSpawnedEntityName (string name)

string	GetSpawnedEntityName ()

override string	GetTaskListTaskText ()

override void	Serialize (ScriptBitWriter writer)
	Serializes task execution briefing and spawned entity name.

override void	Deserialize (ScriptBitReader reader)
	Deserializes task execution briefing and spawned entity name from ScriptBitReader.

void	Init ()
	Initializes support entity, sets task entity, updates blacklist if necessary.

override void	EOnInit (IEntity owner)
	Initializes task manager if it exists, otherwise returns without action.

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 ()

void	SetTitleWidgetText (notnull TextWidget textWidget, string taskText)

string	GetTitleText ()

void	SetDescriptionWidgetText (notnull TextWidget textWidget, string taskText)

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)

string	GetTitle ()
	Return the title of this task.

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	Cancel (bool showMsg=true)

void	Remove ()
	Marks the task as removed.

void	Create (bool showMsg=true)
	When the task is created.

void	Finish (bool showMsg=true)
	Marks the task as finished.

void	Fail (bool showMsg=true)
	Fails the task.

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 ()

Public Attributes
SCR_EScenarioFrameworkItemGCState	m_eGarbageCollectionStatus = SCR_EScenarioFrameworkItemGCState.UNDEFINED

Public Attributes inherited from SCR_ScenarioFrameworkTask
string	m_sTaskIntroVoiceline

Protected Member Functions
void	UpdateDroppedTaskMarker ()
	Updates dropped task marker position, checks if it's a deliver task, schedules marker position update if it is.

void	MoveTaskMarkerPosition ()
	Updates task position, moves marker if asset exists, logs error if asset not assigned.

void	OnItemCarrierChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)
	Handles item carrier changes, removes/adds event handlers, and updates garbage collection status.

void	HandleNewSlotGC (IEntity entity)
	Handles the cases where GarbageSystem might delete new slot entity.

void	HandleOldSlotGC (IEntity entity)
	Handles possible revert of case prevention where GarbageSystem might delete root entity.

void	OnDestroyed (IEntity destroyedEntity)
	Used to remove task item from destroyed entity inventory and drop it to the ground.

void	OnDisconnected (int iPlayerID)

void	RegisterPlayer (int iPlayerID, IEntity playerEntity)
	Registers player with inventory and event handlers.

void	InvokedSetDeliveryTrigger ()
	Sets delivery trigger for an event.

bool	SetSupportEntity ()
	Sets support entity for task.

Protected Member Functions inherited from SCR_BaseTask
void	ShowPopUpNotification (string subtitle)

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.

void	OnStateChanged (SCR_TaskState previousState, SCR_TaskState newState)
	An event called when the state of this task has been changed.

Protected Attributes
string	m_sDeliveryTriggerName

int	m_iObjectState = 0

SCR_BaseTriggerEntity	m_TriggerDeliver

bool	m_bDeliveryItemFound

bool	m_bTaskPositionUpdated

Protected Attributes inherited from SCR_ScenarioFrameworkTask
IEntity	m_Asset

SCR_ScenarioFrameworkTaskSupportEntity	m_SupportEntity

SCR_ScenarioFrameworkLayerTask	m_LayerTask

SCR_ScenarioFrameworkSlotTask	m_SlotTask

string	m_sTaskExecutionBriefing

string	m_sSpawnedEntityName

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"

Static Protected Attributes inherited from SCR_BaseTask
static const float	PLATFORM_ICON_SIZE = 2

Member Function Documentation

◆ GetTaskDeliverState()

int SCR_TaskDeliver.GetTaskDeliverState ( )

Returns: Represents current state of task delivery object. 0 if item is not possesed and 1 if possesed (someone has it in his possesion)

◆ GetTriggerNameToDeliver()

string SCR_TaskDeliver.GetTriggerNameToDeliver ( )

Returns: the name of trigger for delivery.

◆ HandleNewSlotGC()

void SCR_TaskDeliver.HandleNewSlotGC ( IEntity entity )

protected

Handles the cases where GarbageSystem might delete new slot entity.

◆ HandleOldSlotGC()

void SCR_TaskDeliver.HandleOldSlotGC ( IEntity entity )

protected

Handles possible revert of case prevention where GarbageSystem might delete root entity.

◆ Init()

override void SCR_TaskDeliver.Init ( )

Initializes inventory component, registers players, and sets event handlers for player spawning and disconnecting.

Implements SCR_ScenarioFrameworkTask.

◆ InvokedSetDeliveryTrigger()

void SCR_TaskDeliver.InvokedSetDeliveryTrigger ( )

protected

Sets delivery trigger for an event.

◆ MoveTaskMarkerPosition()

void SCR_TaskDeliver.MoveTaskMarkerPosition ( )

protected

Updates task position, moves marker if asset exists, logs error if asset not assigned.

◆ OnDeliveryTriggerActivated()

void SCR_TaskDeliver.OnDeliveryTriggerActivated ( notnull SCR_ScenarioFrameworkTriggerEntity trigger )

Parameters

[in] trigger Trigger activates when entities enter its area, checks if asset is inside, finishes task if found, else checks ch

◆ OnDestroyed()

void SCR_TaskDeliver.OnDestroyed ( IEntity destroyedEntity )

protected

Used to remove task item from destroyed entity inventory and drop it to the ground.

◆ OnDisconnected()

void SCR_TaskDeliver.OnDisconnected ( int iPlayerID )

protected

Parameters

[in] iPlayerID iPlayerID represents the unique identifier for the player being disconnected from the server.

◆ OnItemCarrierChanged()

void SCR_TaskDeliver.OnItemCarrierChanged	(	InventoryStorageSlot	oldSlot,
		InventoryStorageSlot	newSlot
	)

protected

Handles item carrier changes, removes/adds event handlers, and updates garbage collection status.

Parameters

[in]	oldSlot	Represents the previous inventory storage slot of an item before it was moved or changed.
[in]	newSlot	New slot represents the new location where an item is moved in the inventory system.

◆ OnObjectDropped()

void SCR_TaskDeliver.OnObjectDropped	(	IEntity	item,
		BaseInventoryStorageComponent	pStorageOwner
	)

Updates task state and title/description when an item is dropped into inventory.

Parameters

[in]	item	Item dropped event, checks if dropped item matches assigned asset, updates task state if match found.
[in]	pStorageOwner	Represents inventory storage component of an entity in the method.

◆ OnObjectPossessed()

void SCR_TaskDeliver.OnObjectPossessed	(	IEntity	item,
		BaseInventoryStorageComponent	pStorageOwner
	)

Updates task title and description if possessed item matches asset, sets delivery item found flag if not, and progresses state if.

Parameters

[in]	item	Checks if possessed item matches task asset, updates title and description if so, sets state to PROGRESSED if delivery
[in]	pStorageOwner	Represents inventory storage component for item possession tracking.

◆ RegisterPlayer()

void SCR_TaskDeliver.RegisterPlayer	(	int	iPlayerID,
		IEntity	playerEntity
	)

protected

Registers player with inventory and event handlers.

Parameters

[in]	iPlayerID	Player ID representing the controlled entity in the game.
[in]	playerEntity	Player entity represents an in-game player controlled by a human player.

◆ SetDeliveryTrigger() [1/2]

void SCR_TaskDeliver.SetDeliveryTrigger ( )

Sets delivery trigger by name if it exists in the world.

◆ SetDeliveryTrigger() [2/2]

void SCR_TaskDeliver.SetDeliveryTrigger ( SCR_BaseTriggerEntity trigger )

Parameters

[in] trigger Trigger entity for delivery activation.

◆ SetSupportEntity()

override bool SCR_TaskDeliver.SetSupportEntity ( )

Sets support entity for task delivery, returns true if found, logs error if not found.

Returns: true if support entity is found and set, false otherwise.

Implements SCR_ScenarioFrameworkTask.

◆ SetTriggerNameToDeliver()

void SCR_TaskDeliver.SetTriggerNameToDeliver ( string triggerName )

Parameters

[in] triggerName Represents the name of the trigger for delivering an object in the scenario.

◆ UpdateDroppedTaskMarker()

void SCR_TaskDeliver.UpdateDroppedTaskMarker ( )

protected

Updates dropped task marker position, checks if it's a deliver task, schedules marker position update if it is.

◆ UpdateMapTaskIcon()

override void SCR_TaskDeliver.UpdateMapTaskIcon ( )

Updates map task icon visibility based on object state, sets opacity and visibility accordingly.

Implements SCR_BaseTask.

◆ UpdateTaskTitleAndDescription()

void SCR_TaskDeliver.UpdateTaskTitleAndDescription ( int iPossessed = -1 )

Updates task title and description based on object state, triggers delivery, and sets task title and description for the support entity.

Parameters

[in] iPossessed iPossessed represents the possession state of the task, either 0 (not possessed) or 1 (possessed

Member Data Documentation

◆ m_bDeliveryItemFound

bool SCR_TaskDeliver.m_bDeliveryItemFound

protected

◆ m_bTaskPositionUpdated

bool SCR_TaskDeliver.m_bTaskPositionUpdated

protected

◆ m_eGarbageCollectionStatus

SCR_EScenarioFrameworkItemGCState SCR_TaskDeliver.m_eGarbageCollectionStatus = SCR_EScenarioFrameworkItemGCState.UNDEFINED

◆ m_iObjectState

int SCR_TaskDeliver.m_iObjectState = 0

protected

◆ m_sDeliveryTriggerName

string SCR_TaskDeliver.m_sDeliveryTriggerName

protected

◆ m_TriggerDeliver

SCR_BaseTriggerEntity SCR_TaskDeliver.m_TriggerDeliver

protected

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

Game/ScenarioFramework/Tasks/SCR_ScenarioFrameworkTaskDeliver.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetTaskDeliverState()

◆ GetTriggerNameToDeliver()

◆ HandleNewSlotGC()

◆ HandleOldSlotGC()

◆ Init()

◆ InvokedSetDeliveryTrigger()

◆ MoveTaskMarkerPosition()

◆ OnDeliveryTriggerActivated()

◆ OnDestroyed()

◆ OnDisconnected()

◆ OnItemCarrierChanged()

◆ OnObjectDropped()

◆ OnObjectPossessed()

◆ RegisterPlayer()

◆ SetDeliveryTrigger() [1/2]

◆ SetDeliveryTrigger() [2/2]

◆ SetSupportEntity()

◆ SetTriggerNameToDeliver()

◆ UpdateDroppedTaskMarker()

◆ UpdateMapTaskIcon()

◆ UpdateTaskTitleAndDescription()

Member Data Documentation

◆ m_bDeliveryItemFound

◆ m_bTaskPositionUpdated

◆ m_eGarbageCollectionStatus

◆ m_iObjectState

◆ m_sDeliveryTriggerName

◆ m_TriggerDeliver