Inheritance diagram for SCR_ResourceEncapsulator:

[legend]

Public Member Functions
override float	GetAggregatedResourceValue ()

override float	GetAggregatedMaxResourceValue ()

override int	GetContainerCount ()

override SCR_ResourceContainerQueueBase	GetContainerQueue ()

SCR_ResourceContainer	GetContainerRepresentative ()

array< ref SCR_ResourceEncapsulatorActionBase >	GetActions ()

override bool	IsAllowed (notnull SCR_ResourceContainer container)

bool	IsContainerRepresentative (notnull SCR_ResourceContainer container)

override bool	ShouldUpdate ()

override int	FindContainer (notnull SCR_ResourceContainer container)

void	SetContainerRepresentative (notnull SCR_ResourceContainer container)

override bool	RegisterContainer (notnull SCR_ResourceContainer container)

override bool	RegisterContainerForced (notnull SCR_ResourceContainer container)

override bool	UnregisterContainer (int containerIndex)

override bool	UnregisterContainer (notnull SCR_ResourceContainer container)

void	RequestConsumtion (float resourceCost, bool notifyChange=true)

void	RequestGeneration (float resourceAmount, bool notifyChange=true)

void	DebugDraw ()

override void	UpdateContainerResourceValue (SCR_ResourceContainer container, float previousValue)

override void	UpdateContainerMaxResourceValue (SCR_ResourceContainer container, float previousValue)

override void	Initialize (notnull IEntity owner)

override void	Clear ()

override void	OnResourcesChanged (float previousValue)

override void	OnMaxResourcesChanged (float previousValue)

override void	OnContainerRegistered (notnull SCR_ResourceContainer container)

override void	OnContainerUnregistered (notnull SCR_ResourceContainer container)

Public Member Functions inherited from SCR_ResourceInteractor
override int	GetGridUpdateId ()

float	GetResourceGridRange ()

float	GetAggregatedResourceValue ()

float	GetAggregatedMaxResourceValue ()

int	GetContainerCount ()

vector	GetLastPosition ()

EResourceType	GetResourceType ()

SCR_ResourceContainerQueueBase	GetContainerQueue ()

ScriptInvoker< SCR_ResourceInteractor, float >	GetOnResourcesChanged ()

ScriptInvoker< SCR_ResourceInteractor, float >	GetOnMaxResourcesChanged ()

EResourceGeneratorID	GetIdentifier ()

override bool	IsGridUpdateIdGreaterThan (int gridUpdateId)

bool	IsAllowed (notnull SCR_ResourceContainer container)

bool	IsAllowed (notnull IEntity entity, EResourceType resourceType)

bool	CanInteractWith (notnull SCR_ResourceContainer container)

int	FindContainer (notnull SCR_ResourceContainer container)

override void	SetGridUpdateId (int gridUpdateId)

void	UpdateLastPosition ()
	Updates the last known position of the interactor.

bool	RegisterContainer (notnull SCR_ResourceContainer container)

bool	RegisterContainerForced (notnull SCR_ResourceContainer container)

bool	UnregisterContainer (int containerIndex)

bool	UnregisterContainer (notnull SCR_ResourceContainer container)

void	Replicate ()

void	ReplicateEx ()

void	UpdateContainerResourceValue (SCR_ResourceContainer container, float previousValue)

void	UpdateContainerMaxResourceValue (SCR_ResourceContainer container, float previousValue)

void	OnResourceGridUpdated (notnull SCR_ResourceGrid grid)
	Gets called when the interactor container queue is updated by the resource grid.

void	OnResourcesChanged (float previousValue)

void	OnMaxResourcesChanged (float previousValue)

void	OnContainerRegistered (notnull SCR_ResourceContainer container)

void	OnContainerUnregistered (notnull SCR_ResourceContainer container)

void	Initialize (notnull IEntity owner)

override void	Clear ()

Public Member Functions inherited from SCR_ResourceActor
Color	GetDebugColor ()

int	GetGridUpdateId ()

vector	GetOwnerOrigin ()

string	GetDebugName ()

int	GetDebugNameHash ()

SCR_ResourceComponent	GetComponent ()

IEntity	GetOwner ()

EResourceRights	GetResourceRight ()

bool	ShouldUpdate ()

bool	IsIsolated ()

bool	IsGridUpdateIdGreaterThan (int gridUpdateId)

void	SetResourceRights (EResourceRights rights)

void	SetGridUpdateId (int gridUpdateId)

void	Update (float timeslice)

void	UpdateInner (float timeslice)

void	Clear ()

void	~SCR_ResourceActor ()

Protected Attributes
SCR_ResourceContainer	m_ContainerRepresentative

ref SCR_ResourceEncapsulatorContainerQueue	m_ContainerQueue

ref array< ref SCR_ResourceEncapsulatorActionBase >	m_aActions

Protected Attributes inherited from SCR_ResourceInteractor
ref ScriptInvoker< SCR_ResourceInteractor, float >	m_OnResourcesChangedInvoker

ref ScriptInvoker< SCR_ResourceInteractor, float >	m_OnMaxResourcesChangedInvoker

int	m_iGridUpdateId = int.MIN

float	m_fAggregatedResourceValue = -1.0
	HOTFIX: Until replication issues are resolved.

float	m_fAggregatedMaxResourceValue = -1.0

vector	m_LastPosition = vector.Zero

Protected Attributes inherited from SCR_ResourceActor
EResourceRights	m_eResourceRights

EResourceType	m_eResourceType

SCR_ResourceComponent	m_ResourceComponent

IEntity	m_Owner

Additional Inherited Members
Public Attributes inherited from SCR_ResourceActor
string	m_sDebugName

Static Public Attributes inherited from SCR_ResourceActor
static const float	RESOURCES_LOWER_LIMIT = 0.0

Static Protected Attributes inherited from SCR_ResourceActor
static const float	UPDATE_PERIOD = 10.0 / 60.0

static const int	CODEC_GENERATOR_PACKET_BYTESIZE = 32

Member Function Documentation

◆ Clear()

override void SCR_ResourceEncapsulator.Clear ( )

Implements SCR_ResourceInteractor.

◆ DebugDraw()

void SCR_ResourceEncapsulator.DebugDraw ( )

◆ FindContainer()

override int SCR_ResourceEncapsulator.FindContainer ( notnull SCR_ResourceContainer container )

Parameters

[in] container

Returns

Implements SCR_ResourceInteractor.

◆ GetActions()

array< ref SCR_ResourceEncapsulatorActionBase > SCR_ResourceEncapsulator.GetActions ( )

◆ GetAggregatedMaxResourceValue()

override float SCR_ResourceEncapsulator.GetAggregatedMaxResourceValue ( )

Returns

Implements SCR_ResourceInteractor.

◆ GetAggregatedResourceValue()

override float SCR_ResourceEncapsulator.GetAggregatedResourceValue ( )

Returns

Implements SCR_ResourceInteractor.

◆ GetContainerCount()

override int SCR_ResourceEncapsulator.GetContainerCount ( )

Returns

Implements SCR_ResourceInteractor.

◆ GetContainerQueue()

override SCR_ResourceContainerQueueBase SCR_ResourceEncapsulator.GetContainerQueue ( )

Returns

Implements SCR_ResourceInteractor.

◆ GetContainerRepresentative()

SCR_ResourceContainer SCR_ResourceEncapsulator.GetContainerRepresentative ( )

◆ Initialize()

override void SCR_ResourceEncapsulator.Initialize ( notnull IEntity owner )

Parameters

[in] owner

Implements SCR_ResourceInteractor.

◆ IsAllowed()

override bool SCR_ResourceEncapsulator.IsAllowed ( notnull SCR_ResourceContainer container )

Parameters

[in] container

Returns

Implements SCR_ResourceInteractor.

◆ IsContainerRepresentative()

bool SCR_ResourceEncapsulator.IsContainerRepresentative ( notnull SCR_ResourceContainer container )

◆ OnContainerRegistered()

override void SCR_ResourceEncapsulator.OnContainerRegistered ( notnull SCR_ResourceContainer container )

Parameters

[in] container

Implements SCR_ResourceInteractor.

◆ OnContainerUnregistered()

override void SCR_ResourceEncapsulator.OnContainerUnregistered ( notnull SCR_ResourceContainer container )

Parameters

[in] container

Implements SCR_ResourceInteractor.

◆ OnMaxResourcesChanged()

override void SCR_ResourceEncapsulator.OnMaxResourcesChanged ( float previousValue )

Parameters

[in] previousValue

Implements SCR_ResourceInteractor.

◆ OnResourcesChanged()

override void SCR_ResourceEncapsulator.OnResourcesChanged ( float previousValue )

Parameters

[in] previousValue

Implements SCR_ResourceInteractor.

◆ RegisterContainer()

override bool SCR_ResourceEncapsulator.RegisterContainer ( notnull SCR_ResourceContainer container )

Parameters

[in] container

Returns

Implements SCR_ResourceInteractor.

◆ RegisterContainerForced()

override bool SCR_ResourceEncapsulator.RegisterContainerForced ( notnull SCR_ResourceContainer container )

Parameters

[in] container

Returns

Implements SCR_ResourceInteractor.

◆ RequestConsumtion()

void SCR_ResourceEncapsulator.RequestConsumtion	(	float	resourceCost,
		bool	notifyChange = `true`
	)

◆ RequestGeneration()

void SCR_ResourceEncapsulator.RequestGeneration	(	float	resourceAmount,
		bool	notifyChange = `true`
	)

◆ SetContainerRepresentative()

void SCR_ResourceEncapsulator.SetContainerRepresentative ( notnull SCR_ResourceContainer container )

◆ ShouldUpdate()

override bool SCR_ResourceEncapsulator.ShouldUpdate ( )

Returns

Implements SCR_ResourceActor.

◆ UnregisterContainer() [1/2]

override bool SCR_ResourceEncapsulator.UnregisterContainer ( int containerIndex )

Parameters

[in] containerIndex

Returns

Implements SCR_ResourceInteractor.

◆ UnregisterContainer() [2/2]

override bool SCR_ResourceEncapsulator.UnregisterContainer ( notnull SCR_ResourceContainer container )

Parameters

[in] container

Returns

Implements SCR_ResourceInteractor.

◆ UpdateContainerMaxResourceValue()

override void SCR_ResourceEncapsulator.UpdateContainerMaxResourceValue	(	SCR_ResourceContainer	container,
		float	previousValue
	)

Parameters

[in]	container
[in]	previousValue

Implements SCR_ResourceInteractor.

◆ UpdateContainerResourceValue()

override void SCR_ResourceEncapsulator.UpdateContainerResourceValue	(	SCR_ResourceContainer	container,
		float	previousValue
	)

Parameters

[in]	container
[in]	previousValue

Implements SCR_ResourceInteractor.

Member Data Documentation

◆ m_aActions

ref array<ref SCR_ResourceEncapsulatorActionBase> SCR_ResourceEncapsulator.m_aActions

protected

◆ m_ContainerQueue

ref SCR_ResourceEncapsulatorContainerQueue SCR_ResourceEncapsulator.m_ContainerQueue

protected

◆ m_ContainerRepresentative

SCR_ResourceContainer SCR_ResourceEncapsulator.m_ContainerRepresentative

protected

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

Game/Sandbox/Resources/Encapsulator/SCR_ResourceEncapsulator.c

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ Clear()

◆ DebugDraw()

◆ FindContainer()

◆ GetActions()

◆ GetAggregatedMaxResourceValue()

◆ GetAggregatedResourceValue()

◆ GetContainerCount()

◆ GetContainerQueue()

◆ GetContainerRepresentative()

◆ Initialize()

◆ IsAllowed()

◆ IsContainerRepresentative()

◆ OnContainerRegistered()

◆ OnContainerUnregistered()

◆ OnMaxResourcesChanged()

◆ OnResourcesChanged()

◆ RegisterContainer()

◆ RegisterContainerForced()

◆ RequestConsumtion()

◆ RequestGeneration()

◆ SetContainerRepresentative()

◆ ShouldUpdate()

◆ UnregisterContainer() [1/2]

◆ UnregisterContainer() [2/2]

◆ UpdateContainerMaxResourceValue()

◆ UpdateContainerResourceValue()

Member Data Documentation

◆ m_aActions

◆ m_ContainerQueue

◆ m_ContainerRepresentative