SCR_ResourceConsumerServicePoint Interface Reference

Inheritance diagram for SCR_ResourceConsumerServicePoint:

Public Member Functions
override bool	CanInteractWith (notnull SCR_ResourceContainer container)
override void	OnResourceGridUpdated (notnull SCR_ResourceGrid grid)
	Gets called when the interactor container queue is updated by the resource grid.
void	OnBaseRegistered (notnull SCR_ServicePointComponent servicePoint, notnull SCR_MilitaryBaseComponent base)
	Event that gets called upon a base registering the service.
void	OnBaseUnregistered (notnull SCR_ServicePointComponent servicePoint, notnull SCR_MilitaryBaseComponent base)
	Event that gets called upon a base unregistering the service.
override void	Initialize (notnull IEntity owner)
override void	Clear ()
Public Member Functions inherited from SCR_ResourceConsumer
override float	GetResourceGridRange ()
float	GetResourceRange ()
float	GetBuyMultiplier ()
float	GetSellMultiplier ()
override float	GetAggregatedResourceValue ()
override float	GetAggregatedMaxResourceValue ()
override int	GetContainerCount ()
override SCR_ResourceContainerQueueBase	GetContainerQueue ()
ScriptInvoker	GetOnResourceRangeChanged ()
ScriptInvoker	GetOnBuyMultiplierChanged ()
ScriptInvoker	GetOnSellMultiplierChanged ()
ScriptInvoker	GetOnConsumtionStateChanged ()
ScriptInvoker	GetOnExchangeStateChanged ()
EResourceGeneratorID	GetGeneratorIdentifier ()
override EResourceGeneratorID	GetIdentifier ()
bool	IsIgnoringItself ()
bool	IsConsuming ()
bool	IsExchanging ()
override bool	ShouldUpdate ()
override bool	CanInteractWith (notnull SCR_ResourceContainer container)
override int	FindContainer (notnull SCR_ResourceContainer container)
bool	SetResourceRange (float value, bool notifyChange=true)
bool	SetBuyMultiplier (float value, bool notifyChange=true)
bool	SetSellMultiplier (float value, bool notifyChange=true)
bool	EnableConsumtion (bool shouldEnable, bool notifyChange=true)
bool	EnableExchange (bool shouldEnable, bool notifyChange=true)
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)
SCR_ResourceConsumtionResponse	RequestAvailability (float resourceCost, bool performFullQuery=false)
SCR_ResourceConsumtionResponse	RequestConsumtion (float resourceCost)
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 ()
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 Member Functions
void	OnBaseContainerRegistered (notnull SCR_ResourceConsumerMilitaryBase consumer, notnull SCR_ResourceContainer container)
	Event that gets called upon a base registering a resource container.
void	OnBaseContainerUnregistered (notnull SCR_ResourceConsumerMilitaryBase consumer, notnull SCR_ResourceContainer container)
	Event that gets called upon a base unregistering a resource container.
Protected Member Functions inherited from SCR_ResourceConsumer
void	OnResourceRangeChanged (float previousValue)
void	OnBuyMultiplierChanged (float previousValue)
void	OnSellMultiplierChanged (float previousValue)
void	OnConsumtionStateChanged (float previousValue)
void	OnExchangeStateChanged (float previousValue)
bool	PropCompareNetworkedVariables (SSnapSerializerBase snapshot, ScriptCtx hint)
bool	ExtractNetworkedVariables (SSnapSerializerBase snapshot, ScriptCtx hint)
bool	InjectNetworkedVariables (SSnapSerializerBase snapshot, ScriptCtx hint)

Protected Attributes
SCR_ServicePointComponent	m_ServicePointComponent
ref set< SCR_ResourceConsumerMilitaryBase >	m_aBaseConsumers
Protected Attributes inherited from SCR_ResourceConsumer
EResourceGeneratorID	m_eGeneratorIdentifier
float	m_fResourceRange
float	m_fBuyMultiplier
float	m_fSellMultiplier
bool	m_bIsIgnoringItself
ref SCR_ResourceConsumerContainerQueue	m_ContainerQueue
bool	m_bIsConsuming
bool	m_bIsExchanging
ref ScriptInvoker	m_OnResourceRangeChangedInvoker
ref ScriptInvoker	m_OnBuyMultiplierChangedInvoker
ref ScriptInvoker	m_OnSellMultiplierChangedInvoker
ref ScriptInvoker	m_OnConsumtionStateChangedInvoker
ref ScriptInvoker	m_OnExchangeStateChangedInvoker
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
Static Public Member Functions inherited from SCR_ResourceConsumer
static void	Encode (SSnapSerializerBase snapshot, ScriptCtx ctx, ScriptBitSerializer packet)
static bool	Decode (ScriptBitSerializer packet, ScriptCtx ctx, SSnapSerializerBase snapshot)
static bool	SnapCompare (SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx ctx)
static bool	PropCompare (SCR_ResourceConsumer instance, SSnapSerializerBase snapshot, ScriptCtx ctx)
static bool	Extract (SCR_ResourceConsumer instance, ScriptCtx ctx, SSnapSerializerBase snapshot)
static bool	Inject (SSnapSerializerBase snapshot, ScriptCtx ctx, SCR_ResourceConsumer instance)
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_ResourceConsumer
static const int	CODEC_CONSUMER_PACKET_BYTESIZE = 38
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

CanInteractWith()

override bool SCR_ResourceConsumerServicePoint.CanInteractWith

(

notnull SCR_ResourceContainer

container

)

Parameters

[in]

container

Returns

Implements SCR_ResourceConsumer.

Clear()

override void SCR_ResourceConsumerServicePoint.Clear

(

)

Implements SCR_ResourceConsumer.

Initialize()

override void SCR_ResourceConsumerServicePoint.Initialize

(

notnull IEntity

owner

)

Parameters

[in]

owner

Implements SCR_ResourceConsumer.

OnBaseContainerRegistered()

void SCR_ResourceConsumerServicePoint.OnBaseContainerRegistered ( notnull SCR_ResourceConsumerMilitaryBase  consumer, notnull SCR_ResourceContainer  container  )

protected

Event that gets called upon a base registering a resource container.

Parameters

[in]	consumer	The consumer that registered the container, in this case it is expected to be the base that registered the container.
[in]	container	The container that was registered into the base.

OnBaseContainerUnregistered()

void SCR_ResourceConsumerServicePoint.OnBaseContainerUnregistered ( notnull SCR_ResourceConsumerMilitaryBase  consumer, notnull SCR_ResourceContainer  container  )

protected

Event that gets called upon a base unregistering a resource container.

Parameters

[in]	consumer	The consumer that unregistered the container, in this case it is expected to be the base that unregistered the container.
[in]	container	The container that was unregistered into the base.

OnBaseRegistered()

void SCR_ResourceConsumerServicePoint.OnBaseRegistered	(	notnull SCR_ServicePointComponent	servicePoint,
		notnull SCR_MilitaryBaseComponent	base
	)

Event that gets called upon a base registering the service.

Parameters

[in]	servicePoint	The service point that was registered, in this case it is expected to be the service point tied to this consumer.
[in]	base	The base that registered the service.

OnBaseUnregistered()

void SCR_ResourceConsumerServicePoint.OnBaseUnregistered	(	notnull SCR_ServicePointComponent	servicePoint,
		notnull SCR_MilitaryBaseComponent	base
	)

Event that gets called upon a base unregistering the service.

Parameters

[in]	servicePoint	The service point that was unregistered, in this case it is expected to be the service point tied to this consumer.
[in]	base	The base that unregistered the service.

OnResourceGridUpdated()

override void SCR_ResourceConsumerServicePoint.OnResourceGridUpdated

(

notnull SCR_ResourceGrid

grid

)

Gets called when the interactor container queue is updated by the resource grid.

Parameters

[in]

grid

The resource grid that cause the update.

Implements SCR_ResourceInteractor.

Member Data Documentation

m_aBaseConsumers

ref set<SCR_ResourceConsumerMilitaryBase> SCR_ResourceConsumerServicePoint.m_aBaseConsumers

protected

m_ServicePointComponent

SCR_ServicePointComponent SCR_ResourceConsumerServicePoint.m_ServicePointComponent

protected

---

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

• Game/GameMode/Components/Resources/Consumer/SCR_ResourceConsumerServicePoint.c