Arma Reforger Script API
|
Public Member Functions | |
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. | |
void | CancelPlayerAnimation (notnull IEntity entity) |
override void | PerformAction (IEntity pOwnerEntity, IEntity pUserEntity) |
Called when someone tries to perform the action, user entity is typically character. | |
void | TryToSendNotification (IEntity pOwnerEntity, IEntity pUserEntity, notnull SCR_CampaignBuildingNetworkComponent networkComponent) |
bool | HasCompositionService () |
override bool | CanBeShownScript (IEntity user) |
Can this entity be shown in the UI by the provided user entity? | |
void | SetNewGadgetManager (IEntity from, IEntity to) |
Sets a new gadget manager. Controlled by an event when the controlled entity has changed. | |
override bool | CanBePerformedScript (IEntity user) |
Can this action be performed by the provided user entity? | |
override bool | HasLocalEffectOnlyScript () |
Does this action only have client side effect? | |
void | GetBuildingAction () |
Search for first instance of building action, as we can safely assume there is only one per entity. | |
void | SetEditorManager () |
void | GetAllTurretsInComposition () |
Check the hierarchy of the composition for any turret and make a list of them. | |
void | OnCompositionSpawned (bool compositionSpawned) |
Get call once the composition is fully spawned. | |
void | CacheFactionAffiliationComponent () |
Get call once the provider is set. | |
IEntity | GetBuildingTool (notnull IEntity ent) |
Get building tool entity. | |
bool | IsPlayerFactionSame (notnull IEntity user) |
Is user faction same as the composition one. | |
void | ~SCR_CampaignBuildingDisassemblyUserAction () |
![]() | |
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. | |
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 | 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. | |
![]() | |
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? | |
Public Attributes | |
SCR_CampaignBuildingBuildUserAction | m_BuildAction |
![]() | |
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 | |
override void | Init (IEntity pOwnerEntity, GenericComponent pManagerComponent) |
Called when object is initialized and registered to actions manager. | |
SCR_CampaignBuildingNetworkComponent | GetNetworkManager () |
GetNetworkManager. | |
![]() | |
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. | |
Protected Attributes | |
SCR_CampaignBuildingLayoutComponent | m_LayoutComponent |
SCR_CampaignBuildingCompositionComponent | m_CompositionComponent |
SCR_EditableEntityComponent | m_EditableEntity |
SCR_EditorManagerEntity | m_EditorManager |
FactionAffiliationComponent | m_FactionComponent |
SCR_MilitaryBaseComponent | m_BaseComponent |
ref array< SCR_EditableVehicleComponent > | m_EditableVehicle = {} |
bool | m_bCompositionSpawned |
bool | m_bTurretCollected |
bool | m_DoNotDisassemble |
IEntity | m_RootEntity |
IEntity | m_User |
bool | m_bDisassembleOnlyWhenCapturing = false |
bool | m_bSameFactionDisassembleOnly = false |
SCR_GadgetManagerComponent | m_GadgetManager |
![]() | |
string | m_sCannotPerformReason |
The reason why action cannot be performed. | |
void SCR_CampaignBuildingDisassemblyUserAction.~SCR_CampaignBuildingDisassemblyUserAction | ( | ) |
void SCR_CampaignBuildingDisassemblyUserAction.CacheFactionAffiliationComponent | ( | ) |
Get call once the provider is set.
override bool SCR_CampaignBuildingDisassemblyUserAction.CanBePerformedScript | ( | IEntity | user | ) |
Can this action be performed by the provided user entity?
Implements ScriptedUserAction.
override bool SCR_CampaignBuildingDisassemblyUserAction.CanBeShownScript | ( | IEntity | user | ) |
Can this entity be shown in the UI by the provided user entity?
Implements ScriptedUserAction.
void SCR_CampaignBuildingDisassemblyUserAction.CancelPlayerAnimation | ( | notnull IEntity | entity | ) |
void SCR_CampaignBuildingDisassemblyUserAction.GetAllTurretsInComposition | ( | ) |
Check the hierarchy of the composition for any turret and make a list of them.
void SCR_CampaignBuildingDisassemblyUserAction.GetBuildingAction | ( | ) |
Search for first instance of building action, as we can safely assume there is only one per entity.
IEntity SCR_CampaignBuildingDisassemblyUserAction.GetBuildingTool | ( | notnull IEntity | ent | ) |
Get building tool entity.
|
protected |
GetNetworkManager.
bool SCR_CampaignBuildingDisassemblyUserAction.HasCompositionService | ( | ) |
override bool SCR_CampaignBuildingDisassemblyUserAction.HasLocalEffectOnlyScript | ( | ) |
Does this action only have client side effect?
Implements ScriptedUserAction.
|
protected |
Called when object is initialized and registered to actions manager.
Implements ScriptedUserAction.
bool SCR_CampaignBuildingDisassemblyUserAction.IsPlayerFactionSame | ( | notnull IEntity | user | ) |
Is user faction same as the composition one.
override void SCR_CampaignBuildingDisassemblyUserAction.OnActionCanceled | ( | IEntity | pOwnerEntity, |
IEntity | pUserEntity ) |
Method called when the action is interrupted/canceled.
pUserEntity | The entity that was performing this action prior to interruption |
Implements ScriptedUserAction.
override void SCR_CampaignBuildingDisassemblyUserAction.OnActionStart | ( | IEntity | pUserEntity | ) |
Method called from scripted interaction handler when an action is started (progress bar appeared)
pUserEntity | The entity that started performing this action |
Implements ScriptedUserAction.
void SCR_CampaignBuildingDisassemblyUserAction.OnCompositionSpawned | ( | bool | compositionSpawned | ) |
Get call once the composition is fully spawned.
override void SCR_CampaignBuildingDisassemblyUserAction.PerformAction | ( | IEntity | pOwnerEntity, |
IEntity | pUserEntity ) |
Called when someone tries to perform the action, user entity is typically character.
Implements ScriptedUserAction.
void SCR_CampaignBuildingDisassemblyUserAction.SetEditorManager | ( | ) |
void SCR_CampaignBuildingDisassemblyUserAction.SetNewGadgetManager | ( | IEntity | from, |
IEntity | to ) |
Sets a new gadget manager. Controlled by an event when the controlled entity has changed.
void SCR_CampaignBuildingDisassemblyUserAction.TryToSendNotification | ( | IEntity | pOwnerEntity, |
IEntity | pUserEntity, | ||
notnull SCR_CampaignBuildingNetworkComponent | networkComponent ) |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
SCR_CampaignBuildingBuildUserAction SCR_CampaignBuildingDisassemblyUserAction.m_BuildAction |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |