Classes
class	SCR_TaskDeliverClass

Enumerations
enum	SCR_EScenarioFrameworkItemGCState { UNDEFINED , NOT_EXCLUDED , EXCLUDED }

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)
void	OnObjectDropped (IEntity item, BaseInventoryStorageComponent pStorageOwner)
void	UpdateTaskTitleAndDescription (int iPossessed=-1)
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)
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)
override void	HookTaskAsset (IEntity object)
void	InvokedSetDeliveryTrigger ()
	Sets delivery trigger for an event.

Variables
enum SCR_EScenarioFrameworkItemGCState	m_sDeliveryTriggerName
int	m_iObjectState = 0
SCR_BaseTriggerEntity	m_TriggerDeliver
bool	m_bDeliveryItemFound
bool	m_bTaskPositionUpdated
SCR_EScenarioFrameworkItemGCState	m_eGarbageCollectionStatus = SCR_EScenarioFrameworkItemGCState.UNDEFINED

Enumeration Type Documentation

◆ SCR_EScenarioFrameworkItemGCState

enum SCR_EScenarioFrameworkItemGCState

Enumerator
UNDEFINED
NOT_EXCLUDED
EXCLUDED

Definition at line 25 of file SCR_ScenarioFrameworkTaskDeliver.c.

Function Documentation

◆ GetTaskDeliverState()

int GetTaskDeliverState ( )

protected

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

Definition at line 44 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ GetTriggerNameToDeliver()

string GetTriggerNameToDeliver ( )

protected

Returns: the name of trigger for delivery.

Definition at line 96 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ HandleNewSlotGC()

void HandleNewSlotGC ( IEntity entity )

protected

Handles the cases where GarbageSystem might delete new slot entity.

Definition at line 340 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ HandleOldSlotGC()

void HandleOldSlotGC ( IEntity entity )

protected

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

Definition at line 356 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ HookTaskAsset()

override void HookTaskAsset ( IEntity object )

protected

Rehooks task asset, sets up damage state change listener, checks engine stop after 5 seconds if vehicle.

Parameters

[in] object to be linked to this task.

Definition at line 455 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ InvokedSetDeliveryTrigger()

void InvokedSetDeliveryTrigger ( )

protected

Sets delivery trigger for an event.

Definition at line 492 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ MoveTaskMarkerPosition()

void MoveTaskMarkerPosition ( )

protected

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

Definition at line 252 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ OnDeliveryTriggerActivated()

void OnDeliveryTriggerActivated ( notnull SCR_ScenarioFrameworkTriggerEntity trigger )

protected

Parameters

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

Definition at line 103 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ OnDestroyed()

void OnDestroyed ( IEntity destroyedEntity )

protected

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

Definition at line 368 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ OnDisconnected()

void OnDisconnected ( int iPlayerID )

protected

Parameters

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

Definition at line 421 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ OnItemCarrierChanged()

void 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.

Definition at line 265 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ OnObjectDropped()

void OnObjectDropped	(	IEntity	item,
		BaseInventoryStorageComponent	pStorageOwner )

protected

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.

Definition at line 160 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ OnObjectPossessed()

void OnObjectPossessed	(	IEntity	item,
		BaseInventoryStorageComponent	pStorageOwner )

protected

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.

Definition at line 143 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ RegisterPlayer()

void 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.

Definition at line 434 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ SetDeliveryTrigger() [1/2]

void SetDeliveryTrigger ( )

protected

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

Definition at line 51 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ SetDeliveryTrigger() [2/2]

void SetDeliveryTrigger ( SCR_BaseTriggerEntity trigger )

protected

Parameters

[in] trigger Trigger entity for delivery activation.

Definition at line 71 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ SetTriggerNameToDeliver()

void SetTriggerNameToDeliver ( string triggerName )

protected

Parameters

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

Definition at line 83 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ UpdateDroppedTaskMarker()

void UpdateDroppedTaskMarker ( )

protected

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

Definition at line 236 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ UpdateTaskTitleAndDescription()

void UpdateTaskTitleAndDescription ( int iPossessed = -1 )

protected

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

Definition at line 172 of file SCR_ScenarioFrameworkTaskDeliver.c.

Variable Documentation

◆ m_bDeliveryItemFound

bool m_bDeliveryItemFound

protected

Definition at line 38 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ m_bTaskPositionUpdated

bool m_bTaskPositionUpdated

protected

Definition at line 39 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ m_eGarbageCollectionStatus

SCR_EScenarioFrameworkItemGCState m_eGarbageCollectionStatus = SCR_EScenarioFrameworkItemGCState.UNDEFINED

protected

Definition at line 40 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ m_iObjectState

int m_iObjectState = 0

protected

Definition at line 36 of file SCR_ScenarioFrameworkTaskDeliver.c.

◆ m_sDeliveryTriggerName

enum SCR_EScenarioFrameworkItemGCState m_sDeliveryTriggerName

◆ m_TriggerDeliver

SCR_BaseTriggerEntity m_TriggerDeliver

protected

Definition at line 37 of file SCR_ScenarioFrameworkTaskDeliver.c.

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ SCR_EScenarioFrameworkItemGCState

Function Documentation

◆ GetTaskDeliverState()

◆ GetTriggerNameToDeliver()

◆ HandleNewSlotGC()

◆ HandleOldSlotGC()

◆ HookTaskAsset()

◆ InvokedSetDeliveryTrigger()

◆ MoveTaskMarkerPosition()

◆ OnDeliveryTriggerActivated()

◆ OnDestroyed()

◆ OnDisconnected()

◆ OnItemCarrierChanged()

◆ OnObjectDropped()

◆ OnObjectPossessed()

◆ RegisterPlayer()

◆ SetDeliveryTrigger() [1/2]

◆ SetDeliveryTrigger() [2/2]

◆ SetTriggerNameToDeliver()

◆ UpdateDroppedTaskMarker()

◆ UpdateTaskTitleAndDescription()

Variable Documentation

◆ m_bDeliveryItemFound

◆ m_bTaskPositionUpdated

◆ m_eGarbageCollectionStatus

◆ m_iObjectState

◆ m_sDeliveryTriggerName

◆ m_TriggerDeliver