Arma Reforger Script API
|
Public Member Functions | |
float | GetResourceValue () |
float | GetMaxResourceValue () |
float | GetWeightMultiplier () |
float | GetResourceGain () |
float | GetResourceDecay () |
float | GetResourceGainTickrate () |
float | GetResourceDecayTickrate () |
void | GetBoundingVolume (inout vector mins, inout vector maxs) |
void | GetAxisAlignedBoundingVolume (inout vector mins, inout vector maxs) |
EResourceContainerStorageType | GetStorageType () |
EResourceType | GetResourceType () |
EResourceContainerOnEmptyBehavior | GetOnEmptyBehavior () |
SCR_ResourceEncapsulator | GetResourceEncapsulator () |
set< SCR_ResourceInteractor > | GetLinkedInteractors () |
array< SCR_ResourceInteractor > | GetLinkedInteractorsCopy () |
int | GetLinkedInteractorsCount () |
SCR_ResourceInteractor | GetLinkedInteractorAt (int index) |
int | GetLinkedInteractorIndex (notnull SCR_ResourceInteractor interactor) |
WorldTimestamp | GetLastUpdateTimestamp () |
Returns the timestamp that is aimed to be used for the computation of gain and decay. | |
bool | IsInteractorLinked (notnull SCR_ResourceInteractor interactor) |
bool | IsAllowed (notnull SCR_ResourceInteractor interactor) |
override bool | IsIsolated () |
bool | IsInRange (vector origin, float range) |
bool | IsResourceDecayEnabled () |
bool | IsResourceGainEnabled () |
bool | IsEncapsulated () |
override bool | ShouldUpdate () |
bool | IsAllowedToStoreResource () |
bool | CanStoreResource () |
ScriptInvoker | GetOnResourcesChanged () |
ScriptInvoker | GetOnMaxResourcesChanged () |
ScriptInvoker | GetOnResourcesDepleted () |
ScriptInvoker | GetOnResourcesMaxedOut () |
ScriptInvoker | GetOnGainChanged () |
ScriptInvoker | GetOnDecayChanged () |
ScriptInvoker | GetOnGainEnabledChanged () |
ScriptInvoker | GetOnDecayEnabledChanged () |
void | SetLastUpdateTimestamp (WorldTimestamp timestamp) |
Sets the timestamp that is aimed to be used for the computation of gain and decay. | |
bool | SetResourceValue (float value, bool notifyChange=true) |
Sets the resource value of the container to the specified value, clamped to the maximum resource value. | |
bool | SetResourceValueUnsafe (float value, bool notifyChange=true) |
Unsafely sets the resource value of the container to the specified value, clamped to the maximum resource value. | |
bool | SetMaxResourceValue (float value, bool notifyChange=true) |
bool | SetResourceGain (float value, bool notifyChange=true) |
bool | SetResourceDecay (float value, bool notifyChange=true) |
void | SetResourceGainTickrate (float tickrate) |
void | SetResourceDecayTickrate (float tickrate) |
void | SetResourceGainTimeout (float timeout) |
void | SetResourceDecayTimeout (float timeout) |
void | SetResourceEncapsulator (SCR_ResourceEncapsulator encapsulator) |
bool | IncreaseResourceValue (float value, bool notifyChange=true) |
bool | DecreaseResourceValue (float value, bool notifyChange=true) |
bool | MaxOutResourceValue (bool notifyChange=true) |
bool | DepleteResourceValue (bool notifyChange=true) |
void | SetOnEmptyBehavior (EResourceContainerOnEmptyBehavior behavior) |
bool | LinkInteractor (notnull SCR_ResourceInteractor interactor) |
bool | UnlinkInteractor (notnull SCR_ResourceInteractor interactor) |
void | UnlinkEveryInteractor () |
bool | EnableGain (bool shouldEnable, bool notifyChange=true) |
bool | EnableDecay (bool shouldEnable, bool notifyChange=true) |
void | SetIsEncapsulated (bool shouldEnable) |
void | UpdateWeightMultiplier () |
void | DebugDraw (bool shouldShowRange=true) |
override void | Update (WorldTimestamp timestamp) |
Method used to perform a periodic/iterative update on the state of the resource actor. | |
float | ComputeResourceDifference () |
void | CopyFromContainer (notnull SCR_ResourceContainer container) |
void | Initialize (notnull IEntity owner, notnull SCR_ResourceContainer container) |
override void | Clear () |
![]() | |
Color | GetDebugColor () |
int | GetGridUpdateId () |
vector | GetOwnerOrigin () |
string | GetDebugName () |
int | GetDebugNameHash () |
SCR_ResourceComponent | GetComponent () |
IEntity | GetOwner () |
EResourceRights | GetResourceRight () |
bool | IsGridUpdateIdGreaterThan (int gridUpdateId) |
void | SetResourceRights (EResourceRights rights) |
void | SetGridUpdateId (int gridUpdateId) |
void | Update (float timeslice) |
Method used to perform a periodic/iterative update on the state of the resource actor. | |
void | UpdateInner (float timeslice) |
void | ~SCR_ResourceActor () |
Public Attributes | |
float | debugControlOffset = 0.25 |
![]() | |
string | m_sDebugName |
Protected Member Functions | |
void | ComputeResourceGain (float timeslice, out float resourceValue) |
void | ComputeResourceDecay (float timeslice, out float resourceValue) |
void | OnResourcesChanged (float previousValue) |
void | OnResourcesIncreased (float previousValue) |
void | OnResourcesDecreased (float previousValue) |
void | OnResourcesDepleted (float previousValue) |
void | OnResourcesMaxedOut (float previousValue) |
void | OnMaxResourcesChanged (float previousValue) |
void | OnGainChanged (float previousValue) |
void | OnDecayChanged (float previousValue) |
void | OnGainEnabledChanged (float previousValue) |
void | OnDecayEnabledChanged (float previousValue) |
Additional Inherited Members | |
![]() | |
static const float | RESOURCES_LOWER_LIMIT = 0.0 |
![]() | |
static const float | UPDATE_PERIOD = 10.0 / 60.0 |
static const int | CODEC_GENERATOR_PACKET_BYTESIZE = 32 |
bool SCR_ResourceContainer.CanStoreResource | ( | ) |
override void SCR_ResourceContainer.Clear | ( | ) |
Implements SCR_ResourceActor.
|
protected |
float SCR_ResourceContainer.ComputeResourceDifference | ( | ) |
|
protected |
void SCR_ResourceContainer.CopyFromContainer | ( | notnull SCR_ResourceContainer | container | ) |
Implemented in SCR_ResourceContainerVirtual.
void SCR_ResourceContainer.DebugDraw | ( | bool | shouldShowRange = true | ) |
Implemented in SCR_ResourceContainerVirtual.
bool SCR_ResourceContainer.DecreaseResourceValue | ( | float | value, |
bool | notifyChange = true ) |
bool SCR_ResourceContainer.DepleteResourceValue | ( | bool | notifyChange = true | ) |
bool SCR_ResourceContainer.EnableDecay | ( | bool | shouldEnable, |
bool | notifyChange = true ) |
bool SCR_ResourceContainer.EnableGain | ( | bool | shouldEnable, |
bool | notifyChange = true ) |
void SCR_ResourceContainer.GetAxisAlignedBoundingVolume | ( | inout vector | mins, |
inout vector | maxs ) |
Implemented in SCR_ResourceContainerVirtual.
void SCR_ResourceContainer.GetBoundingVolume | ( | inout vector | mins, |
inout vector | maxs ) |
Implemented in SCR_ResourceContainerVirtual.
WorldTimestamp SCR_ResourceContainer.GetLastUpdateTimestamp | ( | ) |
Returns the timestamp that is aimed to be used for the computation of gain and decay.
SCR_ResourceInteractor SCR_ResourceContainer.GetLinkedInteractorAt | ( | int | index | ) |
int SCR_ResourceContainer.GetLinkedInteractorIndex | ( | notnull SCR_ResourceInteractor | interactor | ) |
set< SCR_ResourceInteractor > SCR_ResourceContainer.GetLinkedInteractors | ( | ) |
array< SCR_ResourceInteractor > SCR_ResourceContainer.GetLinkedInteractorsCopy | ( | ) |
int SCR_ResourceContainer.GetLinkedInteractorsCount | ( | ) |
float SCR_ResourceContainer.GetMaxResourceValue | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnDecayChanged | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnDecayEnabledChanged | ( | ) |
EResourceContainerOnEmptyBehavior SCR_ResourceContainer.GetOnEmptyBehavior | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnGainChanged | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnGainEnabledChanged | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnMaxResourcesChanged | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnResourcesChanged | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnResourcesDepleted | ( | ) |
ScriptInvoker SCR_ResourceContainer.GetOnResourcesMaxedOut | ( | ) |
float SCR_ResourceContainer.GetResourceDecay | ( | ) |
float SCR_ResourceContainer.GetResourceDecayTickrate | ( | ) |
SCR_ResourceEncapsulator SCR_ResourceContainer.GetResourceEncapsulator | ( | ) |
float SCR_ResourceContainer.GetResourceGain | ( | ) |
float SCR_ResourceContainer.GetResourceGainTickrate | ( | ) |
EResourceType SCR_ResourceContainer.GetResourceType | ( | ) |
float SCR_ResourceContainer.GetResourceValue | ( | ) |
EResourceContainerStorageType SCR_ResourceContainer.GetStorageType | ( | ) |
float SCR_ResourceContainer.GetWeightMultiplier | ( | ) |
bool SCR_ResourceContainer.IncreaseResourceValue | ( | float | value, |
bool | notifyChange = true ) |
void SCR_ResourceContainer.Initialize | ( | notnull IEntity | owner, |
notnull SCR_ResourceContainer | container ) |
Finds the top most faction affiliation component of the parents, if any and also finds the first resource encapsulator from parent to parent that can register the container, then registers the container into that encapsulator.
bool SCR_ResourceContainer.IsAllowed | ( | notnull SCR_ResourceInteractor | interactor | ) |
bool SCR_ResourceContainer.IsAllowedToStoreResource | ( | ) |
bool SCR_ResourceContainer.IsEncapsulated | ( | ) |
bool SCR_ResourceContainer.IsInRange | ( | vector | origin, |
float | range ) |
Implemented in SCR_ResourceContainerVirtual.
bool SCR_ResourceContainer.IsInteractorLinked | ( | notnull SCR_ResourceInteractor | interactor | ) |
override bool SCR_ResourceContainer.IsIsolated | ( | ) |
Implements SCR_ResourceActor.
bool SCR_ResourceContainer.IsResourceDecayEnabled | ( | ) |
bool SCR_ResourceContainer.IsResourceGainEnabled | ( | ) |
bool SCR_ResourceContainer.LinkInteractor | ( | notnull SCR_ResourceInteractor | interactor | ) |
bool SCR_ResourceContainer.MaxOutResourceValue | ( | bool | notifyChange = true | ) |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
void SCR_ResourceContainer.SetIsEncapsulated | ( | bool | shouldEnable | ) |
void SCR_ResourceContainer.SetLastUpdateTimestamp | ( | WorldTimestamp | timestamp | ) |
Sets the timestamp that is aimed to be used for the computation of gain and decay.
[in] | timestamp | the timestamp to set as last update timestamp. |
bool SCR_ResourceContainer.SetMaxResourceValue | ( | float | value, |
bool | notifyChange = true ) |
void SCR_ResourceContainer.SetOnEmptyBehavior | ( | EResourceContainerOnEmptyBehavior | behavior | ) |
bool SCR_ResourceContainer.SetResourceDecay | ( | float | value, |
bool | notifyChange = true ) |
void SCR_ResourceContainer.SetResourceDecayTickrate | ( | float | tickrate | ) |
void SCR_ResourceContainer.SetResourceDecayTimeout | ( | float | timeout | ) |
void SCR_ResourceContainer.SetResourceEncapsulator | ( | SCR_ResourceEncapsulator | encapsulator | ) |
bool SCR_ResourceContainer.SetResourceGain | ( | float | value, |
bool | notifyChange = true ) |
void SCR_ResourceContainer.SetResourceGainTickrate | ( | float | tickrate | ) |
void SCR_ResourceContainer.SetResourceGainTimeout | ( | float | timeout | ) |
bool SCR_ResourceContainer.SetResourceValue | ( | float | value, |
bool | notifyChange = true ) |
Sets the resource value of the container to the specified value, clamped to the maximum resource value.
[in] | value | The resource value to set the container to. |
[in] | notifyChange | Whenever or not changes in resource value should be notified for this instance. |
bool SCR_ResourceContainer.SetResourceValueUnsafe | ( | float | value, |
bool | notifyChange = true ) |
Unsafely sets the resource value of the container to the specified value, clamped to the maximum resource value.
[in] | value | The resource value to set the container to. |
[in] | notifyChange | Whenever or not changes in resource value should be notified for this instance. |
override bool SCR_ResourceContainer.ShouldUpdate | ( | ) |
Implements SCR_ResourceActor.
void SCR_ResourceContainer.UnlinkEveryInteractor | ( | ) |
bool SCR_ResourceContainer.UnlinkInteractor | ( | notnull SCR_ResourceInteractor | interactor | ) |
override void SCR_ResourceContainer.Update | ( | WorldTimestamp | timestamp | ) |
Method used to perform a periodic/iterative update on the state of the resource actor.
[in] | timestamp | WorldTimestamp object of the moment when the method was called. |
Implements SCR_ResourceActor.
void SCR_ResourceContainer.UpdateWeightMultiplier | ( | ) |
float SCR_ResourceContainer.debugControlOffset = 0.25 |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |