Arma Reforger Script API
|
modded version for to be used with the inventory 2.0 More...
Public Member Functions | |
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. | |
override bool | GetActionNameScript (out string outName) |
If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called. | |
override bool | HasLocalEffectOnlyScript () |
Does this action only have client side effect? | |
override void | Init (IEntity pOwnerEntity, GenericComponent pManagerComponent) |
Called when object is initialized and registered to actions manager. | |
Public Member Functions inherited from ScriptedUserAction | |
void | Init (IEntity pOwnerEntity, GenericComponent pManagerComponent) |
Called when object is initialized and registered to actions manager. | |
void | PerformAction (IEntity pOwnerEntity, IEntity pUserEntity) |
Called when someone tries to perform the action, user entity is typically character. | |
void | PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice) |
Called when someone tries to perform the continuous action, user entity is typically character. | |
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. | |
void | OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity) |
Method called when the action is interrupted/canceled. | |
void | OnActionStart (IEntity pUserEntity) |
Method called from scripted interaction handler when an action is started (progress bar appeared) | |
bool | GetActionNameScript (out string outName) |
If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called. | |
bool | GetActionDescriptionScript (out string outName) |
If overridden and true is returned, outName is returned when BaseUserAction.GetActionDescription is called. | |
bool | CanBePerformedScript (IEntity user) |
Can this action be performed by the provided user entity? | |
bool | CanBeShownScript (IEntity user) |
Can this entity be shown in the UI by the provided user entity? | |
bool | HasLocalEffectOnlyScript () |
Does this action only have client side effect? | |
bool | CanBroadcastScript () |
If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients. | |
float | GetActionProgressScript (float fProgress, float timeSlice) |
Returns the progress of this action in seconds. | |
Public Member Functions inherited from BaseUserAction | |
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 () |
Public Attributes | |
InventoryItemComponent | m_Item |
Public Attributes inherited from BaseUserAction | |
string | ActionNameParams [9] |
Can be filled in scripts to be used as params when name is being formatted when displayed in UI. | |
Protected Member Functions | |
string | GetReason (SCR_InventoryStorageManagerComponent pInventoryManager) |
void | PerformActionInternal (SCR_InventoryStorageManagerComponent manager, IEntity pOwnerEntity, IEntity pUserEntity) |
Protected Member Functions inherited from BaseUserAction | |
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. | |
void | OnActionSelected () |
Callback for when action is selected by the local player and the local player ONLY. | |
void | OnActionDeselected () |
Callback for when action is deselected by the local player and the local player ONLY. | |
Static Protected Attributes | |
const string | SREASON_TOO_BIG = "#AR-Inventory_InfoTooBig" |
const string | SREASON_TOO_HEAVY = "#AR-Inventory_InfoTooHeavy" |
Additional Inherited Members | |
Protected Attributes inherited from BaseUserAction | |
string | m_sCannotPerformReason |
The reason why action cannot be performed. | |
modded version for to be used with the inventory 2.0
override bool SCR_InventoryAction.CanBePerformedScript | ( | IEntity | user | ) |
Can this action be performed by the provided user entity?
Implements ScriptedUserAction.
Implemented in SCR_DeployableInventoryItemEquipClothAction, SCR_DeployableInventoryItemPickUpAction, SCR_ResourceStorageOpenAction, SCR_AttachementAction, SCR_EquipClothAction, SCR_EquipGadgetAction, SCR_EquipWeaponAction, SCR_EquipWeaponHolsterAction, SCR_LootDeadBodyAction, and SCR_PickUpItemAction.
override bool SCR_InventoryAction.CanBeShownScript | ( | IEntity | user | ) |
Can this entity be shown in the UI by the provided user entity?
Implements ScriptedUserAction.
Implemented in SCR_DeployableInventoryItemEquipClothAction, SCR_DeployableInventoryItemPickUpAction, SCR_OpenDeployableSpawnPointStorageAction, SCR_DetachMagazineUserAction, SCR_FireModeSwitchUserAction, SCR_InspectionUserAction, SCR_RadioToggleUserAction, SCR_RadioTuningUserAction, SCR_ToggleSafetyUserAction, SCR_AttachementAction, SCR_AttachItemFromInventoryAction, SCR_EquipWeaponAttachment, SCR_LootDeadBodyAction, SCR_MineEquipWeaponAction, SCR_MineEquipHolsterAction, SCR_MinePickUpItemAction, and SCR_OpenVehicleStorageAction.
override bool SCR_InventoryAction.GetActionNameScript | ( | out string | outName | ) |
If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
If not overridden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)
Implements ScriptedUserAction.
Implemented in SCR_DetachMagazineUserAction, SCR_RadioToggleUserAction, SCR_RadioTuningUserAction, SCR_ToggleSafetyUserAction, SCR_AttachementAction, SCR_AttachItemFromInventoryAction, SCR_EquipClothAction, SCR_EquipWeaponAction, and SCR_EquipWeaponHolsterAction.
|
protected |
override bool SCR_InventoryAction.HasLocalEffectOnlyScript | ( | ) |
Does this action only have client side effect?
Implements ScriptedUserAction.
Implemented in SCR_RadioToggleUserAction, and SCR_RadioTuningUserAction.
override void SCR_InventoryAction.Init | ( | IEntity | pOwnerEntity, |
GenericComponent | pManagerComponent | ||
) |
Called when object is initialized and registered to actions manager.
Implements ScriptedUserAction.
Implemented in SCR_OpenDeployableSpawnPointStorageAction, SCR_ResourceStorageOpenAction, SCR_InspectionUserAction, SCR_RadioToggleUserAction, SCR_RadioTuningUserAction, SCR_ToggleSafetyUserAction, SCR_AttachementAction, SCR_AttachItemFromInventoryAction, SCR_BaseWeaponAction, SCR_EquipClothAction, SCR_EquipWeaponAttachment, and SCR_OpenVehicleStorageAction.
override void SCR_InventoryAction.PerformAction | ( | IEntity | pOwnerEntity, |
IEntity | pUserEntity | ||
) |
Called when someone tries to perform the action, user entity is typically character.
Implements ScriptedUserAction.
Implemented in SCR_FireModeSwitchUserAction, SCR_RadioToggleUserAction, SCR_RadioTuningUserAction, SCR_ToggleSafetyUserAction, and SCR_MineFlagPickUpAction.
|
protected |
Implemented in SCR_ResourceStorageOpenAction, SCR_DetachMagazineUserAction, SCR_AttachementAction, SCR_AttachItemFromInventoryAction, SCR_EquipClothAction, SCR_EquipGadgetAction, SCR_EquipWeaponAction, SCR_EquipWeaponHolsterAction, SCR_EquipWeaponAttachment, SCR_LootAction, SCR_OpenStorageAction, SCR_OpenTurretStorageAction, SCR_OpenVehicleStorageAction, and SCR_PickUpItemAction.
InventoryItemComponent SCR_InventoryAction.m_Item |
|
staticprotected |
|
staticprotected |