Inheritance diagram for SCR_ResourcePlayerControllerInventoryComponent:

Public Member Functions
ScriptInvokerResourceOnPlayerInteraction	GetOnPlayerInteraction ()

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 rplIdResourceComponent, RplId rplIdInventoryManager, RplId rplIdStorageComponent, ResourceName resourceNameItem, EResourceType resourceType)

void	RpcAsk_ArsenalRefundItem (RplId rplIdResourceComponent, RplId rplIdInventoryItem, 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 rplIdResourceComponent, RplId rplIdInventoryManager, RplId rplIdStorageComponent, EResourceType resourceType, float requestedResources)

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

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)

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

Protected Attributes
ref ScriptInvokerResourceOnPlayerInteraction	m_OnPlayerInteractionInvoker

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.

◆ GetOnPlayerInteraction()

ScriptInvokerResourceOnPlayerInteraction SCR_ResourcePlayerControllerInventoryComponent.GetOnPlayerInteraction ( )

Returns

◆ 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

◆ 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	rplIdResourceComponent,
		RplId	rplIdInventoryItem,
		EResourceType	resourceType )

Parameters

[in]	rplIdResourceComponent
[in]	rplIdInventoryItem
[in]	resourceType

◆ RpcAsk_ArsenalRequestItem()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_ArsenalRequestItem	(	RplId	rplIdResourceComponent,
		RplId	rplIdInventoryManager,
		RplId	rplIdStorageComponent,
		ResourceName	resourceNameItem,
		EResourceType	resourceType )

Parameters

[in]	rplIdResourceComponent
[in]	rplIdInventoryManager
[in]	rplIdStorageComponent
[in]	resourceNameItem
[in]	resourceType

◆ RpcAsk_CreatePhysicalContainerWithContainer()

void SCR_ResourcePlayerControllerInventoryComponent.RpcAsk_CreatePhysicalContainerWithContainer	(	RplId	rplIdResourceComponent,
		RplId	rplIdInventoryManager,
		RplId	rplIdStorageComponent,
		EResourceType	resourceType,
		float	requestedResources )

Parameters

[in]	rplIdResourceComponent
[in]	rplIdInventoryManager
[in]	rplIdStorageComponent
[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_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

◆ 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

◆ m_OnPlayerInteractionInvoker

ref ScriptInvokerResourceOnPlayerInteraction SCR_ResourcePlayerControllerInventoryComponent.m_OnPlayerInteractionInvoker

protected

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

Game/Components/Sandbox/SCR_ResourcePlayerControllerInventoryComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ CheckResourceConsumptionAvailability()

◆ CheckResourceGenerationAvailability()

◆ GetOnPlayerInteraction()

◆ OnDelete()

◆ OnPlayerInteraction()

◆ RequestSubscription()

◆ RequestUnsubscription()

◆ RpcAsk_ArsenalRefundItem()

◆ RpcAsk_ArsenalRequestItem()

◆ RpcAsk_CreatePhysicalContainerWithContainer()

◆ RpcAsk_MergeContainerWithContainer()

◆ RpcAsk_MergeContainerWithContainerPartial()

◆ RpcAsk_OnPlayerInteraction()

◆ RpcAsk_RequestSubscription()

◆ RpcAsk_RequestUnsubscription()

◆ TryGetConsumptionActor()

◆ TryGetGenerationActor()

◆ TryPerformResourceConsumption()

◆ TryPerformResourceGeneration()

Member Data Documentation

◆ m_OnPlayerInteractionInvoker