Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_ResourceGeneratorServicePoint Interface Reference
Inheritance diagram for SCR_ResourceGeneratorServicePoint:
SCR_ResourceGenerator SCR_ResourceInteractor SCR_ResourceActor

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_ResourceGenerator
override float GetResourceGridRange ()
 
float GetStorageRange ()
 
float GetResourceMultiplier ()
 
override EResourceGeneratorID GetIdentifier ()
 
override float GetAggregatedResourceValue ()
 
override float GetAggregatedMaxResourceValue ()
 
override int GetContainerCount ()
 
override SCR_ResourceContainerQueueBase GetContainerQueue ()
 
bool IsIgnoringItself ()
 
override int FindContainer (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)
 
SCR_ResourceGenerationResponse RequestAvailability (float resourceAmount)
 
SCR_ResourceGenerationResponse RequestGeneration (float resourceAmount, SCR_ResourceGenerator generator=null)
 
void DebugDraw ()
 
override void UpdateContainerResourceValue (SCR_ResourceContainer container, float previousValue)
 
override void UpdateContainerMaxResourceValue (SCR_ResourceContainer container, float previousValue)
 
- Public Member Functions inherited from SCR_ResourceInteractor
override int GetGridUpdateId ()
 
vector GetLastPosition ()
 
EResourceType GetResourceType ()
 
ScriptInvoker< SCR_ResourceInteractor, float > GetOnResourcesChanged ()
 
ScriptInvoker< SCR_ResourceInteractor, float > GetOnMaxResourcesChanged ()
 
override bool IsGridUpdateIdGreaterThan (int gridUpdateId)
 
bool IsAllowed (notnull SCR_ResourceContainer container)
 
bool IsAllowed (notnull IEntity entity, EResourceType resourceType)
 
override void SetGridUpdateId (int gridUpdateId)
 
void UpdateLastPosition ()
 Updates the last known position of the interactor.
 
void Replicate ()
 
void ReplicateEx ()
 
void OnResourcesChanged (float previousValue)
 
void OnMaxResourcesChanged (float previousValue)
 
void OnContainerRegistered (notnull SCR_ResourceContainer container)
 
void OnContainerUnregistered (notnull SCR_ResourceContainer container)
 
- Public Member Functions inherited from SCR_ResourceActor
Color GetDebugColor ()
 
vector GetOwnerOrigin ()
 
string GetDebugName ()
 
int GetDebugNameHash ()
 
SCR_ResourceComponent GetComponent ()
 
IEntity GetOwner ()
 
EResourceRights GetResourceRight ()
 
bool ShouldUpdate ()
 
bool IsIsolated ()
 
void SetResourceRights (EResourceRights rights)
 
void Update (float timeslice)
 Method used to perform a periodic/iterative update on the state of the resource actor.
 
void Update (WorldTimestamp timestamp)
 Method used to perform a periodic/iterative update on the state of the resource actor.
 
void UpdateInner (float timeslice)
 
void ~SCR_ResourceActor ()
 

Protected Member Functions

void OnBaseContainerRegistered (notnull SCR_ResourceGeneratorMilitaryBase generator, notnull SCR_ResourceContainer container)
 Event that gets called upon a base registering a resource container.
 
void OnBaseContainerUnregistered (notnull SCR_ResourceGeneratorMilitaryBase generator, notnull SCR_ResourceContainer container)
 Event that gets called upon a base unregistering a resource container.
 
- Protected Member Functions inherited from SCR_ResourceGenerator
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_ResourceGeneratorMilitaryBasem_aBaseGenerators
 
- Protected Attributes inherited from SCR_ResourceGenerator
float m_fResourceMultiplier
 
float m_fStorageRange
 
bool m_bIsIgnoringItself
 
ref SCR_ResourceGeneratorContainerQueue m_ContainerQueue
 
ref array< ref SCR_ResourceGeneratorActionBasem_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

- Static Public Member Functions inherited from SCR_ResourceGenerator
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_ResourceGenerator instance, SSnapSerializerBase snapshot, ScriptCtx ctx)
 
static bool Extract (SCR_ResourceGenerator instance, ScriptCtx ctx, SSnapSerializerBase snapshot)
 
static bool Inject (SSnapSerializerBase snapshot, ScriptCtx ctx, SCR_ResourceGenerator instance)
 
- Public Attributes inherited from SCR_ResourceGenerator
EResourceGeneratorID m_eIdentifier
 
- 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

◆ CanInteractWith()

override bool SCR_ResourceGeneratorServicePoint.CanInteractWith ( notnull SCR_ResourceContainer container)
Parameters
[in]container
Returns

Implements SCR_ResourceGenerator.

◆ Clear()

override void SCR_ResourceGeneratorServicePoint.Clear ( )

Implements SCR_ResourceGenerator.

◆ Initialize()

override void SCR_ResourceGeneratorServicePoint.Initialize ( notnull IEntity owner)
Parameters
[in]owner

Implements SCR_ResourceGenerator.

◆ OnBaseContainerRegistered()

void SCR_ResourceGeneratorServicePoint.OnBaseContainerRegistered ( notnull SCR_ResourceGeneratorMilitaryBase generator,
notnull SCR_ResourceContainer container )
protected

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

Parameters
[in]generatorThe generator that registered the container, in this case it is expected to be the base that registered the container.
[in]containerThe container that was registered into the base.

◆ OnBaseContainerUnregistered()

void SCR_ResourceGeneratorServicePoint.OnBaseContainerUnregistered ( notnull SCR_ResourceGeneratorMilitaryBase generator,
notnull SCR_ResourceContainer container )
protected

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

Parameters
[in]generatorThe generator that unregistered the container, in this case it is expected to be the base that unregistered the container.
[in]containerThe container that was unregistered into the base.

◆ OnBaseRegistered()

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

Event that gets called upon a base registering the service.

Parameters
[in]servicePointThe service point that was registered, in this case it is expected to be the service point tied to this generator.
[in]baseThe base that registered the service.

◆ OnBaseUnregistered()

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

Event that gets called upon a base unregistering the service.

Parameters
[in]servicePointThe service point that was unregistered, in this case it is expected to be the service point tied to this generator.
[in]baseThe base that unregistered the service.

◆ OnResourceGridUpdated()

override void SCR_ResourceGeneratorServicePoint.OnResourceGridUpdated ( notnull SCR_ResourceGrid grid)

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

Parameters
[in]gridThe resource grid that cause the update.

Implements SCR_ResourceInteractor.

Member Data Documentation

◆ m_aBaseGenerators

ref set<SCR_ResourceGeneratorMilitaryBase> SCR_ResourceGeneratorServicePoint.m_aBaseGenerators
protected

◆ m_ServicePointComponent

SCR_ServicePointComponent SCR_ResourceGeneratorServicePoint.m_ServicePointComponent
protected

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