Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_BaseContextAction Interface Reference

Base container class for editor context actions. More...

Inheritance diagram for SCR_BaseContextAction:
SCR_BaseEditorAction SCR_AssetBrowserContextAction SCR_AttachToParentContextAction SCR_CopyAttributesContextAction SCR_CopyIngameTimestampContextAction SCR_CopyPrefabNameContextAction SCR_CopyServerTimestampContextAction SCR_CopyWorldPositionContextAction SCR_CreateLayerWithSelectionContextAction SCR_CreateNewGroupContextAction SCR_CycleContextAction SCR_DeleteContextAction SCR_DetachContextAction SCR_DisableSimulationContextAction SCR_DuplicateContextAction SCR_EnableSimulationContextAction SCR_FillVehicleContextAction SCR_FindInContentBrowserContextAction SCR_FindInWorkshopContextAction SCR_FocusHereContextAction SCR_GeneralContextAction SCR_GetInContextAction SCR_GetOutContextAction SCR_HideSelectionContextAction SCR_LightningContextAction SCR_LockLayerContextAction SCR_MoveInFormationContextAction SCR_MoveToFlightAltitudeContextAction SCR_MoveToRootContextAction SCR_MoveToSeatPositionContextAction SCR_PasteAttributesContextAction SCR_PasteContextAction SCR_PasteOnOriginalPositionContextAction SCR_PatrolContextAction SCR_PingContextAction SCR_RefuelContextAction SCR_ReplaceWithContextAction SCR_SelectContextAction SCR_SelectCrewContextAction SCR_SelectOccupantContextAction SCR_SelectPassengersContextAction SCR_SelectedEntitiesContextAction SCR_SetAsLeaderContextAction SCR_ShowSelectionContextAction SCR_SpawnCrewContextAction SCR_SpawnPassengersContextAction SCR_SuppressContextAction SCR_SwitchCameraToContextAction SCR_TeleportCameraToPlayerContextAction SCR_TeleportPlayerHereContextAction SCR_TransportContextAction SCR_UnloadContextAction SCR_UnlockLayerContextAction SCR_UserContextAction

Public Member Functions

override bool IsServer ()
 Should action be sent to server.
 
- Public Member Functions inherited from SCR_BaseEditorAction
bool IsEnabled ()
 
bool CanBeShown (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags)
 Determine if action can be shown with passed hovered entity and selected entitites.
 
bool CanBePerformed (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags)
 Determine if action can be performed with passed hovered entity and selected entitites.
 
void Perform (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags, int param=-1)
 Perform action.
 
void PerformOwner (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags, int param=-1)
 
SCR_UIInfo GetInfo ()
 
EEditorActionType GetActionType ()
 
EEditorActionGroup GetActionGroup ()
 
string GetShortcut ()
 Get action shortcut that triggers this action.
 
void SetShortcutRef (string shortcutRef)
 Set shortcut reference - it's shown in GUI, but not actually listened to.
 
int GetOrder ()
 Get order of this entity, can be any integer value including negative.
 
int GetParam ()
 Get custom param which can be used to pass extra information to performed action.
 
array< ref SCR_BaseEditorEffectGetEffects ()
 Get effects tied to the action.
 
void AddShortcut (SCR_BaseActionsEditorComponent actionsManager)
 
void RemoveShortcut ()
 
bool CheckAndSetCooldown ()
 Check if action is on cooldown and if not set action on cooldown The cooldown will never be set if cooldownTime is equal or less than 0.
 
bool IsOnCooldown ()
 Check if action is on cooldown.
 
void ~SCR_BaseEditorAction ()
 

Additional Inherited Members

- Protected Member Functions inherited from SCR_BaseEditorAction
void OnShortcut ()
 
void ActivateCooldown ()
 
void UpdateCooldown ()
 
void OnCooldownDone ()
 
- Protected Attributes inherited from SCR_BaseEditorAction
bool m_bEnabled
 
ref SCR_UIInfo m_Info
 
EEditorActionType m_ActionType
 
EEditorActionGroup m_ActionGroup
 
int m_iOrder
 
string m_sShortcut
 
bool m_bEnableShortcutLogics
 
ref array< ref SCR_BaseEditorEffectm_Effects
 
SCR_BaseActionsEditorComponent m_ActionsManager
 
string m_sShortcutRef
 
float m_fCooldownTime
 
float m_fCurrentCooldownTime
 
float m_fCooldownUpdateFreq = 50
 
bool m_bShowOnCooldownNotification
 
bool m_bIsOnCooldown
 

Detailed Description

Base container class for editor context actions.

For implementation of a new action inherit either SCR_GeneralContextAction, SCR_HoverEntityContextAction, or SCR_SelectedEntitiesContextAction

Member Function Documentation

◆ IsServer()

override bool SCR_BaseContextAction.IsServer ( )

Should action be sent to server.

Returns
True if action is handled on server

Implements SCR_BaseEditorAction.


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