Arma Reforger Script API
|
Public Member Functions | |
ENotification | GetNotificationOnUse () |
override bool | CanBeShownScript (IEntity user) |
Can this entity be shown in the UI by the provided user entity? | |
override bool | CanBePerformedScript (IEntity user) |
Can this action be performed by the provided user entity? | |
override void | PerformAction (IEntity pOwnerEntity, IEntity pUserEntity) |
Called when someone tries to perform the action, user entity is typically character. | |
SCR_InventoryStorageManagerComponent | GetTargetInventory () |
![]() | |
ResourceName | GetItemPrefab () |
![]() | |
bool | CanPerform (out ESupportStationReasonInvalid cannotPerformReason) |
override void | PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice) |
Called when someone tries to perform the continuous action, user entity is typically character. | |
override void | Init (IEntity pOwnerEntity, GenericComponent pManagerComponent) |
Called when object is initialized and registered to actions manager. | |
override bool | CanBroadcastScript () |
If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients. | |
override void | OnActionStart (IEntity pUserEntity) |
Method called from scripted interaction handler when an action is started (progress bar appeared) | |
override void | OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity) |
Method called when the action is interrupted/canceled. | |
override bool | GetActionNameScript (out string outName) |
If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called. | |
void | ~SCR_BaseUseSupportStationAction () |
![]() | |
vector | GetLocalPositionAction () |
Get action local position Used for such things like playing audio at the correct location on action use. | |
vector | GetWorldPositionAction () |
Get action world position Used for such things like playing audio at the correct location on action use. | |
override float | GetActionProgressScript (float fProgress, float timeSlice) |
bool | IsActionLooping () |
float | GetLoopActionHoldDuration () |
![]() | |
void | OnConfirmed (IEntity pUserEntity) |
If action passed as callback OnConfirmed will be called when reached execution, user entity is typically character. | |
void | OnRejected (IEntity pUserEntity) |
If action passed as callback OnRejected will be called when execution was rejected, user entity is typically character. | |
bool | GetActionDescriptionScript (out string outName) |
If overridden and true is returned, outName is returned when BaseUserAction.GetActionDescription is called. | |
bool | HasLocalEffectOnlyScript () |
Does this action only have client side effect? | |
![]() | |
void | SetCannotPerformReason (string reason) |
Sets the reason why action couldn't be performed. | |
string | GetCannotPerformReason () |
Returns the reason why action couldn't be performed. | |
proto external int | GetContextIndex (string sContextName) |
Returns the index of the context this action is registered in as or -1 if none. | |
proto external void | SetActiveContext (UserActionContext context) |
Setter for m_pActiveContext. | |
proto external UserActionContext | GetActiveContext () |
Getter for m_pActiveContext. | |
proto external bool | CanBePerformed (IEntity user) |
Can this action be performed by the user? | |
proto external bool | CanBeShown (IEntity user) |
Can this action be shown in the UI for the user? | |
proto external bool | HasLocalEffectOnly () |
Does this action only have client side effect? | |
proto external bool | CanBroadcast () |
If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients. | |
proto external bool | ShouldPerformPerFrame () |
Should this action be performed every frame the input action is triggered? | |
proto external string | GetActionName () |
Return the name of this action. | |
proto external string | GetActionDescription () |
Return the description of this action. | |
proto external float | GetVisibilityRange () |
Returns the visibility range of this action in metres. | |
proto external void | SetActionDuration (float duration) |
Sets the duration of this action in seconds. | |
proto external float | GetActionDuration () |
Returns the duration of this action in seconds. | |
proto external float | GetActionProgress (float fProgress, float timeSlice) |
Returns the progress of this action in seconds. | |
proto external bool | IsInProgress () |
Returns true while continuous or timed action is being used. | |
proto external UIInfo | GetUIInfo () |
Returns the UIInfo set for this user action or null if none. | |
proto external IEntity | GetOwner () |
Returns the parent entity of this action. | |
proto external bool | CanAggregate () |
Whether action can be aggregated by name, this is a temp workaround for localization. | |
proto external int | GetActionID () |
Returns the ID with which this action is registered in its parent ActionsManagerComponent. | |
proto external void | SetSendActionDataFlag () |
Used to ask to send action data again during continuous action. | |
proto external ActionsManagerComponent | GetActionsManager () |
proto external void | SetActionEnabled_S (bool enable) |
Action can be enabled/disabled by the server. Disabled actions return false for CanBeShown(). Has no effect when called from the client. | |
proto external bool | WasDisabledByServer () |
Was the action disabled by the server? | |
Protected Member Functions | |
override ESupportStationType | GetSupportStationType () |
override LocalizedString | GetInvalidPerformReasonString (ESupportStationReasonInvalid reasonInvalid) |
bool | GetShowButDisabled () |
override bool | CanHaveMultipleUsers () |
override void | CanBePerformedUpdate (IEntity user) |
void | UpdateCanResupply (IEntity owner, IEntity user) |
void | SetTargetInventory (IEntity user, IEntity owner) |
InventoryStorageManagerComponent | GetProviderInventory () |
override void | ResetReferencesOnServer () |
override void | DelayedInit (IEntity owner) |
override string | GetActionStringParam () |
![]() | |
void | SetItemName () |
![]() | |
SCR_BaseSupportStationComponent | GetClosestValidSupportStation (IEntity actionOwner, IEntity actionUser, out ESupportStationReasonInvalid reasonInvalid=0) |
bool | CanShowDestroyed () |
void | SetCanPerform (bool canPerform, ESupportStationReasonInvalid reasonInvalid) |
float | GetActionPercentage () |
If not -1 it will show the percentage on the current action. | |
int | GetActionDecimalCount () |
bool | RequiresGadget () |
If true will only show the action if the player is holding the correct support station gadget. | |
bool | PrioritizeHeldGadget () |
If true will always take support station from held gadget and skip any other checks if a held support station is found. RequiresGadget() is not required to be true. | |
bool | AllowGetSupportStationFromGadget () |
If true it allows getting the support station from gadgets. | |
IEntity | GetCurrentActionUser () |
Get which entity is currently activly using the action. | |
bool | IsUserInVehicle (notnull IEntity user) |
override void | OnActionSelected () |
Callback for when action is selected by the local player and the local player ONLY. | |
override void | OnActionDeselected () |
Callback for when action is deselected by the local player and the local player ONLY. | |
![]() | |
bool | IsSameVehicleOrNone (notnull IEntity user) |
bool | LoopActionUpdate (float timeSlice) |
![]() | |
bool | OnRplSave (ScriptBitWriter writer) |
bool | OnRplLoad (ScriptBitReader reader) |
bool | OnSaveActionData (ScriptBitWriter writer) |
Before performing the action the caller can store some data in it which is delivered to others. | |
bool | OnLoadActionData (ScriptBitReader reader) |
If the one performing the action packed some data in it everybody receiving the action. | |
Static Protected Attributes | |
const LocalizedString | X_OUTOF_Y_FORMATTING = "#AR-SupportStation_ActionFormat_ItemAmount" |
const LocalizedString | CURRENT_ITEM_AMOUNT_FORMATTING = "#AR-SupportStation_ActionFormat_CurrentItemAmount" |
![]() | |
const int | DELAY_CAN_PERFORM = 500 |
const LocalizedString | ACTION_WITH_SUPPLYCOST_FORMATTING = "#AR-ActionFormat_SupplyCost" |
const LocalizedString | ACTION_WITH_SUPPLYGAIN_FORMATTING = "#AR-ActionFormat_SupplyGain" |
const LocalizedString | ACTION_WITH_PARAM_FORMATTING = "#AR-SupportStation_ActionFormat_WithParam" |
const LocalizedString | ACTION_PERCENTAGE_FORMATTING = "#AR-SupportStation_ActionFormat_Percentage" |
Additional Inherited Members | |
![]() | |
string | ActionNameParams [9] |
Can be filled in scripts to be used as params when name is being formatted when displayed in UI. | |
override bool SCR_BaseResupplySupportStationAction.CanBePerformedScript | ( | IEntity | user | ) |
Can this action be performed by the provided user entity?
Implements SCR_BaseUseSupportStationAction.
Implemented in SCR_ResupplyOtherSupportStationAction, and SCR_ResupplySelfSupportStationAction.
|
protected |
Implements SCR_BaseUseSupportStationAction.
override bool SCR_BaseResupplySupportStationAction.CanBeShownScript | ( | IEntity | user | ) |
Can this entity be shown in the UI by the provided user entity?
Implements SCR_BaseUseSupportStationAction.
Implemented in SCR_ResupplyOtherSupportStationAction, and SCR_ResupplySelfSupportStationAction.
|
protected |
Implements SCR_BaseUseSupportStationAction.
|
protected |
Implements SCR_BaseItemHolderSupportStationAction.
Implemented in SCR_ResupplyOtherSupportStationAction.
|
protected |
Implements SCR_BaseUseSupportStationAction.
|
protected |
Implements SCR_BaseItemHolderSupportStationAction.
ENotification SCR_BaseResupplySupportStationAction.GetNotificationOnUse | ( | ) |
|
protected |
Implemented in SCR_ResupplySelfSupportStationAction.
|
protected |
|
protected |
Implements SCR_BaseUseSupportStationAction.
SCR_InventoryStorageManagerComponent SCR_BaseResupplySupportStationAction.GetTargetInventory | ( | ) |
override void SCR_BaseResupplySupportStationAction.PerformAction | ( | IEntity | pOwnerEntity, |
IEntity | pUserEntity ) |
Called when someone tries to perform the action, user entity is typically character.
Implements SCR_BaseUseSupportStationAction.
|
protected |
Implements SCR_BaseUseSupportStationAction.
Implemented in SCR_ResupplySelfSupportStationAction.
|
protected |
Implemented in SCR_ResupplySelfSupportStationAction.
|
protected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |