Inheritance diagram for SCR_ResourcePlayerControllerInventoryComponent:

Public Member Functions
ScriptInvokerResourceOnPlayerInteraction	GetOnPlayerInteraction ()

ScriptInvokerResourceOnPlayerInteraction	GetOnBeforePlayerInteraction ()

void	RequestSubscription (RplId resourceComponentRplId, TypeName interactorType, EResourceType resourceType, EResourceGeneratorID resourceIdentifier)

void	RequestUnsubscription (RplId resourceComponentRplId, TypeName interactorType, EResourceType resourceType, EResourceGeneratorID resourceIdentifier)

void	RpcAsk_RequestSubscription (RplId resourceComponentRplId, string interactorType, EResourceType resourceType, EResourceGeneratorID resourceIdentifier)

void	RpcAsk_RequestUnsubscription (RplId resourceComponentRplId, string interactorType, EResourceType resourceType, EResourceGeneratorID resourceIdentifier)

void	RpcAsk_OnPlayerInteraction (EResourcePlayerInteractionType interactionType, RplId rplIdResourceComponentFrom, RplId rplIdResourceComponentTo, EResourceType resourceType, float resourceValue)

void	RpcAsk_ArsenalRequestItem (RplId resourceComponentRplId, RplId storageComponentRplId, ResourceName resourceNameItem, EResourceType resourceType)

void	RpcAsk_ArsenalRefundItem (RplId resourceComponentRplId, RplId inventoryItemRplId, EResourceType resourceType)

void	RpcAsk_MergeContainerWithContainer (RplId rplIdFrom, RplId rplIdTo, EResourceType resourceType)

void	RpcAsk_MergeContainerWithContainerPartial (RplId rplIdFrom, RplId rplIdTo, EResourceType resourceType, float requestedResources)

void	RpcAsk_CreatePhysicalContainerWithContainer (RplId resourceComponentRplId, RplId inventoryManagerRplId, RplId storageComponentRplId, EResourceType resourceType, float requestedResources)

void	OnPlayerInteraction (EResourcePlayerInteractionType interactionType, SCR_ResourceComponent resourceComponentFrom, SCR_ResourceComponent resourceComponentTo, EResourceType resourceType, float resourceValue, bool shouldBroadcast=true)

void	OnBeforePlayerInteraction (EResourcePlayerInteractionType interactionType, SCR_ResourceComponent resourceComponentFrom, SCR_ResourceComponent resourceComponentTo, EResourceType resourceType, float resourceValue)

Static Public Member Functions
static OnArsenalItemRequestedInvoker	GetOnArsenalItemRequested ()

static void	FindSuitablePosition (inout vector position, float maxHorizontalOffset, float maxVerticalOffset)
	Method used for finding a position at which supplies can be spawned.

Protected Member Functions
SCR_ResourceActor	TryGetGenerationActor (notnull SCR_ResourceComponent resourceComponent, EResourceType resourceType, out float currentResourceValue, out float maxResourceValue)

SCR_ResourceActor	TryGetConsumptionActor (notnull SCR_ResourceComponent resourceComponent, EResourceType resourceType, out float currentResourceValue, out float maxResourceValue)

bool	CheckResourceConsumptionAvailability (notnull SCR_ResourceActor actor, float resourceValue)
	Checks if it's possible to comnsume resourceValue resources from the specified actor.

bool	CheckResourceGenerationAvailability (notnull SCR_ResourceActor actor, float resourceValue)
	Checks if it's possible to generate resourceValue resources from the specified actor.

bool	TryPerformResourceConsumption (notnull SCR_ResourceActor actor, float resourceValue, bool ignoreOnEmptyBehavior=false)

bool	TryPerformResourceGeneration (notnull SCR_ResourceActor actor, float resourceValue)

void	RpcAsk_ArsenalRequestItem_ (RplId resourceComponentRplId, RplId storageComponentRplId, ResourceName resourceNameItem, EResourceType resourceType)

void	RpcAsk_ArsenalRefundItem_ (RplId resourceComponentRplId, RplId inventoryItemRplId, EResourceType resourceType)

void	RpcAsk_MergeContainerWithContainerPartial_ (RplId rplIdFrom, RplId rplIdTo, EResourceType resourceType, float requestedResources)

void	RpcAsk_CreatePhysicalContainerWithContainer_ (RplId resourceComponentRplId, RplId inventoryManagerRplId, RplId storageComponentRplId, EResourceType resourceType, float requestedResources)

override void	OnDelete (IEntity owner)
	Called when Entity is being to be destroyed (deleted) or component to be deleted (see Game::DeleteScriptComponent).

Static Protected Member Functions
static bool	TraceFilter (notnull IEntity e, vector start=vector.Zero, vector dir=vector.Zero)
	Method used to filter entities found by the trace.

Protected Attributes
ref ScriptInvokerResourceOnPlayerInteraction	m_OnPlayerInteractionInvoker

ref ScriptInvokerResourceOnPlayerInteraction	m_OnBeforePlayerInteractionInvoker

Static Protected Attributes
static ref OnArsenalItemRequestedInvoker	s_OnArsenalItemRequested

const float	VERTICAL_SPAWN_OFFSET = 10

const float	HORIZONTAL_SPAWN_OFFSET = 2.5

const int	MAX_REFUNDING_DISTANCE_SQ = 900
	30m to compensate for some large entities like Mi-8 which with arsenal truck can result in transaction across about 27m

Member Function Documentation

◆ CheckResourceConsumptionAvailability()

bool SCR_ResourcePlayerControllerInventoryComponent.CheckResourceConsumptionAvailability	(	notnull SCR_ResourceActor	actor,
		float	resourceValue )

protected

Checks if it's possible to comnsume resourceValue resources from the specified actor.

Parameters

[in]	actor	Actor to consume from.
[in]	resourceValue	The resource value to consume.

◆ CheckResourceGenerationAvailability()

bool SCR_ResourcePlayerControllerInventoryComponent.CheckResourceGenerationAvailability	(	notnull SCR_ResourceActor	actor,
		float	resourceValue )

protected

Checks if it's possible to generate resourceValue resources from the specified actor.

Parameters

[in]	actor	Actor to generate to.
[in]	resourceValue	The resource value to generate.

◆ FindSuitablePosition()

static void SCR_ResourcePlayerControllerInventoryComponent.FindSuitablePosition	(	inout vector	position,
		float	maxHorizontalOffset,
		float	maxVerticalOffset )

static

Method used for finding a position at which supplies can be spawned.

Parameters

[in,out]	position	around which we want to search
[in]	maxHorizontalOffset	determines how far the position can be on the X and Z axis
[in]	maxVerticalOffset	determines how much higher search will be starting

◆ GetOnArsenalItemRequested()

static OnArsenalItemRequestedInvoker SCR_ResourcePlayerControllerInventoryComponent.GetOnArsenalItemRequested ( )

static

◆ GetOnBeforePlayerInteraction()

ScriptInvokerResourceOnPlayerInteraction SCR_ResourcePlayerControllerInventoryComponent.GetOnBeforePlayerInteraction ( )

Returns

◆ GetOnPlayerInteraction()

ScriptInvokerResourceOnPlayerInteraction SCR_ResourcePlayerControllerInventoryComponent.GetOnPlayerInteraction ( )

Returns

◆ OnBeforePlayerInteraction()

void SCR_ResourcePlayerControllerInventoryComponent.OnBeforePlayerInteraction	(	EResourcePlayerInteractionType	interactionType,
		SCR_ResourceComponent	resourceComponentFrom,
		SCR_ResourceComponent	resourceComponentTo,
		EResourceType	resourceType,
		float	resourceValue )

Parameters

[in]	interactionType
[in]	resourceComponentFrom
[in]	resourceComponentTo
[in]	resourceType
[in]	resourceValue

◆ OnDelete()

override void SCR_ResourcePlayerControllerInventoryComponent.OnDelete ( IEntity owner )

protected

Called when Entity is being to be destroyed (deleted) or component to be deleted (see Game::DeleteScriptComponent).

Parameters

[in] owner Entity which owns the component

◆ OnPlayerInteraction()

void SCR_ResourcePlayerControllerInventoryComponent.OnPlayerInteraction	(	EResourcePlayerInteractionType	interactionType,
		SCR_ResourceComponent	resourceComponentFrom,
		SCR_ResourceComponent	resourceComponentTo,
		EResourceType	resourceType,
		float	resourceValue,
		bool	shouldBroadcast = true )

Parameters

[in]	interactionType
[in]	resourceComponentFrom
[in]	resourceComponentTo
[in]	resourceType
[in]	resourceValue
[in]	shouldBroadcast

◆ RequestSubscription()

void SCR_ResourcePlayerControllerInventoryComponent.RequestSubscription	(	RplId	resourceComponentRplId,
		TypeName	interactorType,
		EResourceType	resourceType,
		EResourceGeneratorID	resourceIdentifier )

Parameters

[in]	resourceComponentRplId
[in]	interactorType
[in]	resourceType
[in]	resourceIdentifier

◆ RequestUnsubscription()

void SCR_ResourcePlayerControllerInventoryComponent.RequestUnsubscription	(	RplId	resourceComponentRplId,
		TypeName	interactorType,
		EResourceType	resourceType,
		EResourceGeneratorID	resourceIdentifier )

Parameters

[in]	resourceComponentRplId
[in]	interactorType
[in]	resourceType
[in]	resourceIdentifier

◆ RpcAsk_ArsenalRefundItem()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_ArsenalRefundItem	(	RplId	resourceComponentRplId,
		RplId	inventoryItemRplId,
		EResourceType	resourceType )

Parameters

[in]	resourceComponentRplId	RplId of the resource component of the arsenal which is going to be refunding the item
[in]	inventoryItemRplId	RplId of the inventory item component of the item that is being refunded
[in]	resourceType

◆ RpcAsk_ArsenalRefundItem_()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_ArsenalRefundItem_	(	RplId	resourceComponentRplId,
		RplId	inventoryItemRplId,
		EResourceType	resourceType )

protected

Parameters

[in]	resourceComponentRplId	RplId of the resource component of the arsenal which is going to be refunding the item
[in]	inventoryItemRplId	RplId of the inventory item component of the item that is being refunded
[in]	resourceType

◆ RpcAsk_ArsenalRequestItem()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_ArsenalRequestItem	(	RplId	resourceComponentRplId,
		RplId	storageComponentRplId,
		ResourceName	resourceNameItem,
		EResourceType	resourceType )

Parameters

[in]	resourceComponentRplId	RplId of the resource component of the arsenal which is going to be refunding the item
[in]	storageComponentRplId	RplId of the storage component inside of which item palced after it is spawned
[in]	resourceNameItem	Prefab that should be spawned
[in]	resourceType

◆ RpcAsk_ArsenalRequestItem_()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_ArsenalRequestItem_	(	RplId	resourceComponentRplId,
		RplId	storageComponentRplId,
		ResourceName	resourceNameItem,
		EResourceType	resourceType )

protected

Parameters

[in]	resourceComponentRplId	RplId of the resource component of the arsenal which is going to be refunding the item
[in]	storageComponentRplId	RplId of the storage component inside of which item palced after it is spawned
[in]	resourceNameItem	Prefab that should be spawned
[in]	resourceType

◆ RpcAsk_CreatePhysicalContainerWithContainer()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_CreatePhysicalContainerWithContainer	(	RplId	resourceComponentRplId,
		RplId	inventoryManagerRplId,
		RplId	storageComponentRplId,
		EResourceType	resourceType,
		float	requestedResources )

◆ RpcAsk_CreatePhysicalContainerWithContainer_()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_CreatePhysicalContainerWithContainer_	(	RplId	resourceComponentRplId,
		RplId	inventoryManagerRplId,
		RplId	storageComponentRplId,
		EResourceType	resourceType,
		float	requestedResources )

protected

Parameters

[in]	resourceComponentRplId
[in]	inventoryManagerRplId
[in]	storageComponentRplId
[in]	resourceType
[in]	requestedResources

◆ RpcAsk_MergeContainerWithContainer()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_MergeContainerWithContainer	(	RplId	rplIdFrom,
		RplId	rplIdTo,
		EResourceType	resourceType )

Parameters

[in]	rplIdFrom
[in]	rplIdTo
[in]	resourceType

◆ RpcAsk_MergeContainerWithContainerPartial()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_MergeContainerWithContainerPartial	(	RplId	rplIdFrom,
		RplId	rplIdTo,
		EResourceType	resourceType,
		float	requestedResources )

Parameters

[in]	rplIdFrom
[in]	rplIdTo
[in]	resourceType
[in]	requestedResources

◆ RpcAsk_MergeContainerWithContainerPartial_()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_MergeContainerWithContainerPartial_	(	RplId	rplIdFrom,
		RplId	rplIdTo,
		EResourceType	resourceType,
		float	requestedResources )

protected

Parameters

[in]	rplIdFrom
[in]	rplIdTo
[in]	resourceType
[in]	requestedResources

◆ RpcAsk_OnPlayerInteraction()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_OnPlayerInteraction	(	EResourcePlayerInteractionType	interactionType,
		RplId	rplIdResourceComponentFrom,
		RplId	rplIdResourceComponentTo,
		EResourceType	resourceType,
		float	resourceValue )

Parameters

[in]	interactionType
[in]	rplIdResourceComponentFrom
[in]	rplIdResourceComponentTo
[in]	resourceType
[in]	resourceValue

◆ RpcAsk_RequestSubscription()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_RequestSubscription	(	RplId	resourceComponentRplId,
		string	interactorType,
		EResourceType	resourceType,
		EResourceGeneratorID	resourceIdentifier )

Parameters

[in]	resourceComponentRplId
[in]	interactorType
[in]	resourceType
[in]	resourceIdentifier

◆ RpcAsk_RequestUnsubscription()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_RequestUnsubscription	(	RplId	resourceComponentRplId,
		string	interactorType,
		EResourceType	resourceType,
		EResourceGeneratorID	resourceIdentifier )

Parameters

[in]	resourceComponentRplId
[in]	interactorType
[in]	resourceType
[in]	resourceIdentifier

◆ TraceFilter()

static bool SCR_ResourcePlayerControllerInventoryComponent.TraceFilter	(	notnull IEntity	e,
		vector	start = vector::Zero,
		vector	dir = vector::Zero )

staticprotected

Method used to filter entities found by the trace.

Parameters

[in]	e
[in]	start
[in]	dir

◆ TryGetConsumptionActor()

SCR_ResourceActor SCR_ResourcePlayerControllerInventoryComponent.TryGetConsumptionActor	(	notnull SCR_ResourceComponent	resourceComponent,
		EResourceType	resourceType,
		out float	currentResourceValue,
		out float	maxResourceValue )

protected

◆ TryGetGenerationActor()

SCR_ResourceActor SCR_ResourcePlayerControllerInventoryComponent.TryGetGenerationActor	(	notnull SCR_ResourceComponent	resourceComponent,
		EResourceType	resourceType,
		out float	currentResourceValue,
		out float	maxResourceValue )

protected

◆ TryPerformResourceConsumption()

bool SCR_ResourcePlayerControllerInventoryComponent.TryPerformResourceConsumption	(	notnull SCR_ResourceActor	actor,
		float	resourceValue,
		bool	ignoreOnEmptyBehavior = false )

protected

Parameters

[in]	actor	from which we want to try to consume resources from
[in]	resourceValue	amount of resources that should be consumed
[in]	ignoreOnEmptyBehavior

◆ TryPerformResourceGeneration()

bool SCR_ResourcePlayerControllerInventoryComponent.TryPerformResourceGeneration	(	notnull SCR_ResourceActor	actor,
		float	resourceValue )

protected

Parameters

[in]	actor	to which we want to try to add resources
[in]	resourceValue	amount of resources that should be added

Member Data Documentation

◆ HORIZONTAL_SPAWN_OFFSET

const float SCR_ResourcePlayerControllerInventoryComponent.HORIZONTAL_SPAWN_OFFSET = 2.5

staticprotected

◆ m_OnBeforePlayerInteractionInvoker

ref ScriptInvokerResourceOnPlayerInteraction SCR_ResourcePlayerControllerInventoryComponent.m_OnBeforePlayerInteractionInvoker

protected

◆ m_OnPlayerInteractionInvoker

ref ScriptInvokerResourceOnPlayerInteraction SCR_ResourcePlayerControllerInventoryComponent.m_OnPlayerInteractionInvoker

protected

◆ MAX_REFUNDING_DISTANCE_SQ

const int SCR_ResourcePlayerControllerInventoryComponent.MAX_REFUNDING_DISTANCE_SQ = 900

staticprotected

30m to compensate for some large entities like Mi-8 which with arsenal truck can result in transaction across about 27m

◆ s_OnArsenalItemRequested

ref OnArsenalItemRequestedInvoker SCR_ResourcePlayerControllerInventoryComponent.s_OnArsenalItemRequested

staticprotected

◆ VERTICAL_SPAWN_OFFSET

const float SCR_ResourcePlayerControllerInventoryComponent.VERTICAL_SPAWN_OFFSET = 10

staticprotected

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

Game/Components/Sandbox/SCR_ResourcePlayerControllerInventoryComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Function Documentation

◆ CheckResourceConsumptionAvailability()

◆ CheckResourceGenerationAvailability()

◆ FindSuitablePosition()

◆ GetOnArsenalItemRequested()

◆ GetOnBeforePlayerInteraction()

◆ GetOnPlayerInteraction()

◆ OnBeforePlayerInteraction()

◆ OnDelete()

◆ OnPlayerInteraction()

◆ RequestSubscription()

◆ RequestUnsubscription()

◆ RpcAsk_ArsenalRefundItem()

◆ RpcAsk_ArsenalRefundItem_()

◆ RpcAsk_ArsenalRequestItem()

◆ RpcAsk_ArsenalRequestItem_()

◆ RpcAsk_CreatePhysicalContainerWithContainer()

◆ RpcAsk_CreatePhysicalContainerWithContainer_()

◆ RpcAsk_MergeContainerWithContainer()

◆ RpcAsk_MergeContainerWithContainerPartial()

◆ RpcAsk_MergeContainerWithContainerPartial_()

◆ RpcAsk_OnPlayerInteraction()

◆ RpcAsk_RequestSubscription()

◆ RpcAsk_RequestUnsubscription()

◆ TraceFilter()

◆ TryGetConsumptionActor()

◆ TryGetGenerationActor()

◆ TryPerformResourceConsumption()

◆ TryPerformResourceGeneration()

Member Data Documentation

◆ HORIZONTAL_SPAWN_OFFSET

◆ m_OnBeforePlayerInteractionInvoker

◆ m_OnPlayerInteractionInvoker

◆ MAX_REFUNDING_DISTANCE_SQ

◆ s_OnArsenalItemRequested

◆ VERTICAL_SPAWN_OFFSET