Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_BaseEditorAction Class Reference
Inheritance diagram for SCR_BaseEditorAction:
SCR_BaseContextAction SCR_DoubleClickAction SCR_EditorToolbarAction SCR_LayerContextAction SCR_SwitchToPlayerContextAction SCR_TakeControlContextAction 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 SCR_OpenAttributeWindowContextAction SCR_PlaceEntityContextAction SCR_BasePlacingToolbarAction SCR_BaseToggleToolbarAction SCR_BrowserToolbarAction SCR_CameraAttributesToolbarAction SCR_DeleteDestroyedToolbarAction SCR_EndGameToolbarAction SCR_GlobalAttributesToolbarAction SCR_InstantActionTest SCR_LeaveModeToolbarAction SCR_LoadSessionToolbarAction SCR_MapToolbarAction SCR_NewSessionToolbarAction SCR_OpenWorldToolbarAction SCR_ResetEditorComponentsToolbarAction SCR_RewindToolbarAction SCR_SaveSessionToolbarAction SCR_SnapToTerrainToolbarAction SCR_TakeScreenshotDebugToolbarAction SCR_ToggleInterfaceToolbarAction

Protected Member Functions

bool IsEnabled ()
bool CanBeShown (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags)
bool CanBePerformed (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags)
void Perform (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags, int param=-1)
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 ()
void SetShortcutRef (string shortcutRef)
int GetOrder ()
bool IsServer ()
int GetParam ()
array< ref SCR_BaseEditorEffect > GetEffects ()
void OnShortcut ()
void AddShortcut (SCR_BaseActionsEditorComponent actionsManager)
void RemoveShortcut ()
bool CheckAndSetCooldown ()
bool IsOnCooldown ()
void ActivateCooldown ()
void UpdateCooldown ()
void OnCooldownDone ()
void ~SCR_BaseEditorAction ()

Protected Attributes

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_BaseEditorEffect > m_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 all editor action types (ContextActions, WaypointActions, AbiliityActions)

Definition at line 24 of file SCR_BaseEditorAction.c.

Constructor & Destructor Documentation

◆ ~SCR_BaseEditorAction()

void SCR_BaseEditorAction::~SCR_BaseEditorAction ( )
inlineprotected

Definition at line 272 of file SCR_BaseEditorAction.c.

Member Function Documentation

◆ ActivateCooldown()

void SCR_BaseEditorAction::ActivateCooldown ( )
inlineprotected

Definition at line 243 of file SCR_BaseEditorAction.c.

◆ AddShortcut()

void SCR_BaseEditorAction::AddShortcut ( SCR_BaseActionsEditorComponent actionsManager)
inlineprotected

Definition at line 190 of file SCR_BaseEditorAction.c.

◆ CanBePerformed()

bool SCR_BaseEditorAction::CanBePerformed ( SCR_EditableEntityComponent hoveredEntity,
notnull set< SCR_EditableEntityComponent > selectedEntities,
vector cursorWorldPosition,
int flags )
inlineprotected

Determine if action can be performed with passed hovered entity and selected entitites

Definition at line 86 of file SCR_BaseEditorAction.c.

◆ CanBeShown()

bool SCR_BaseEditorAction::CanBeShown ( SCR_EditableEntityComponent hoveredEntity,
notnull set< SCR_EditableEntityComponent > selectedEntities,
vector cursorWorldPosition,
int flags )
inlineprotected

Determine if action can be shown with passed hovered entity and selected entitites

Definition at line 77 of file SCR_BaseEditorAction.c.

◆ CheckAndSetCooldown()

bool SCR_BaseEditorAction::CheckAndSetCooldown ( )
inlineprotected

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

Returns
Returns true if currently on cooldown

Definition at line 212 of file SCR_BaseEditorAction.c.

◆ GetActionGroup()

EEditorActionGroup SCR_BaseEditorAction::GetActionGroup ( )
inlineprotected

Definition at line 123 of file SCR_BaseEditorAction.c.

◆ GetActionType()

EEditorActionType SCR_BaseEditorAction::GetActionType ( )
inlineprotected

Definition at line 119 of file SCR_BaseEditorAction.c.

◆ GetEffects()

array< ref SCR_BaseEditorEffect > SCR_BaseEditorAction::GetEffects ( )
inlineprotected

Get effects tied to the action

Returns
Array of effects

Definition at line 180 of file SCR_BaseEditorAction.c.

◆ GetInfo()

SCR_UIInfo SCR_BaseEditorAction::GetInfo ( )
inlineprotected

Definition at line 111 of file SCR_BaseEditorAction.c.

◆ GetOrder()

int SCR_BaseEditorAction::GetOrder ( )
inlineprotected

Get order of this entity, can be any integer value including negative.

Definition at line 151 of file SCR_BaseEditorAction.c.

◆ GetParam()

int SCR_BaseEditorAction::GetParam ( )
inlineprotected

Get custom param which can be used to pass extra information to performed action. Called on the machine of whoever called the action, with the editor opened. Sent to Perform function, even when it's called on server.

Returns
Param value

Definition at line 171 of file SCR_BaseEditorAction.c.

◆ GetShortcut()

string SCR_BaseEditorAction::GetShortcut ( )
inlineprotected

Get action shortcut that triggers this action.

Returns
Action name

Definition at line 132 of file SCR_BaseEditorAction.c.

◆ IsEnabled()

bool SCR_BaseEditorAction::IsEnabled ( )
inlineprotected
Returns
True if the action is enabled

Definition at line 69 of file SCR_BaseEditorAction.c.

◆ IsOnCooldown()

bool SCR_BaseEditorAction::IsOnCooldown ( )
inlineprotected

Check if action is on cooldown

Returns
Returns true if currently on cooldown

Definition at line 237 of file SCR_BaseEditorAction.c.

◆ IsServer()

bool SCR_BaseEditorAction::IsServer ( )
inlineprotected

Should action be sent to server

Returns
True if action is handled on server

Definition at line 160 of file SCR_BaseEditorAction.c.

◆ OnCooldownDone()

void SCR_BaseEditorAction::OnCooldownDone ( )
inlineprotected

Definition at line 266 of file SCR_BaseEditorAction.c.

◆ OnShortcut()

void SCR_BaseEditorAction::OnShortcut ( )
inlineprotected

Definition at line 185 of file SCR_BaseEditorAction.c.

◆ Perform()

void SCR_BaseEditorAction::Perform ( SCR_EditableEntityComponent hoveredEntity,
notnull set< SCR_EditableEntityComponent > selectedEntities,
vector cursorWorldPosition,
int flags,
int param = -1 )
inlineprotected

Perform action

Definition at line 94 of file SCR_BaseEditorAction.c.

◆ PerformOwner()

void SCR_BaseEditorAction::PerformOwner ( SCR_EditableEntityComponent hoveredEntity,
notnull set< SCR_EditableEntityComponent > selectedEntities,
vector cursorWorldPosition,
int flags,
int param = -1 )
inlineprotected

Definition at line 102 of file SCR_BaseEditorAction.c.

◆ RemoveShortcut()

void SCR_BaseEditorAction::RemoveShortcut ( )
inlineprotected

Definition at line 198 of file SCR_BaseEditorAction.c.

◆ SetShortcutRef()

void SCR_BaseEditorAction::SetShortcutRef ( string shortcutRef)
inlineprotected

Set shortcut reference - it's shown in GUI, but not actually listened to.

Parameters
shortcutRefAction name

Definition at line 143 of file SCR_BaseEditorAction.c.

◆ UpdateCooldown()

void SCR_BaseEditorAction::UpdateCooldown ( )
inlineprotected

Definition at line 257 of file SCR_BaseEditorAction.c.

Member Data Documentation

◆ m_ActionGroup

EEditorActionGroup SCR_BaseEditorAction::m_ActionGroup
protected

Definition at line 36 of file SCR_BaseEditorAction.c.

◆ m_ActionsManager

SCR_BaseActionsEditorComponent SCR_BaseEditorAction::m_ActionsManager
protected

Definition at line 50 of file SCR_BaseEditorAction.c.

◆ m_ActionType

EEditorActionType SCR_BaseEditorAction::m_ActionType
protected

Definition at line 33 of file SCR_BaseEditorAction.c.

◆ m_bEnabled

bool SCR_BaseEditorAction::m_bEnabled
protected

Definition at line 27 of file SCR_BaseEditorAction.c.

◆ m_bEnableShortcutLogics

bool SCR_BaseEditorAction::m_bEnableShortcutLogics
protected

Definition at line 45 of file SCR_BaseEditorAction.c.

◆ m_bIsOnCooldown

bool SCR_BaseEditorAction::m_bIsOnCooldown
protected

Definition at line 64 of file SCR_BaseEditorAction.c.

◆ m_bShowOnCooldownNotification

bool SCR_BaseEditorAction::m_bShowOnCooldownNotification
protected

Definition at line 62 of file SCR_BaseEditorAction.c.

◆ m_Effects

ref array<ref SCR_BaseEditorEffect> SCR_BaseEditorAction::m_Effects
protected

Definition at line 48 of file SCR_BaseEditorAction.c.

◆ m_fCooldownTime

float SCR_BaseEditorAction::m_fCooldownTime
protected

Definition at line 54 of file SCR_BaseEditorAction.c.

◆ m_fCooldownUpdateFreq

float SCR_BaseEditorAction::m_fCooldownUpdateFreq = 50
protected

Definition at line 59 of file SCR_BaseEditorAction.c.

◆ m_fCurrentCooldownTime

float SCR_BaseEditorAction::m_fCurrentCooldownTime
protected

Definition at line 56 of file SCR_BaseEditorAction.c.

◆ m_Info

ref SCR_UIInfo SCR_BaseEditorAction::m_Info
protected

Definition at line 30 of file SCR_BaseEditorAction.c.

◆ m_iOrder

int SCR_BaseEditorAction::m_iOrder
protected

Definition at line 39 of file SCR_BaseEditorAction.c.

◆ m_sShortcut

string SCR_BaseEditorAction::m_sShortcut
protected

Definition at line 42 of file SCR_BaseEditorAction.c.

◆ m_sShortcutRef

string SCR_BaseEditorAction::m_sShortcutRef
protected

Definition at line 51 of file SCR_BaseEditorAction.c.

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