Base container class for all editor action types (ContextActions, WaypointActions, AbiliityActions) More...

Inheritance diagram for SCR_BaseEditorAction:

Public Member Functions
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.

bool	IsServer ()
	Should action be sent to server.

int	GetParam ()
	Get custom param which can be used to pass extra information to performed action.

array< ref SCR_BaseEditorEffect >	GetEffects ()
	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 ()

Protected Member Functions
void	OnShortcut ()

void	ActivateCooldown ()

void	UpdateCooldown ()

void	OnCooldownDone ()

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)

Constructor & Destructor Documentation

◆ ~SCR_BaseEditorAction()

void SCR_BaseEditorAction.~SCR_BaseEditorAction ( )

Member Function Documentation

◆ ActivateCooldown()

void SCR_BaseEditorAction.ActivateCooldown ( )

protected

◆ AddShortcut()

void SCR_BaseEditorAction.AddShortcut ( SCR_BaseActionsEditorComponent actionsManager )

Implemented in SCR_DoubleClickAction.

◆ CanBePerformed()

bool SCR_BaseEditorAction.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.

Implemented in SCR_AssetBrowserContextAction, SCR_AttachToParentContextAction, SCR_BasePlacingToolbarAction, SCR_CameraAttributesToolbarAction, SCR_CaptureBasesContextAction, SCR_ChooseAndSpawnOccupantsContextAction, SCR_CopyAttributesContextAction, SCR_CopyIngameTimestampContextAction, SCR_CopyPrefabNameContextAction, SCR_CopyServerTimestampContextAction, SCR_CopyWorldPositionContextAction, SCR_CreateLayerContextAction, SCR_CreateLayerWithSelectionContextAction, SCR_CreateNewGroupContextAction, SCR_CycleContextAction, SCR_DeleteContextAction, SCR_DeleteDestroyedToolbarAction, SCR_DetachContextAction, SCR_DisableSimulationContextAction, SCR_DuplicateContextAction, SCR_EnableSimulationContextAction, SCR_EndGameToolbarAction, SCR_FillVehicleContextAction, SCR_FindInWorkshopContextAction, SCR_FlashlightToolbarAction, SCR_FocusHereContextAction, SCR_GeneralContextAction, SCR_GetInContextAction, SCR_GetOutContextAction, SCR_GlobalAttributesToolbarAction, SCR_HideSelectionContextAction, SCR_InstantActionTest, SCR_LayerContextAction, SCR_LeaveModeToolbarAction, SCR_LightningContextAction, SCR_LoadSessionToolbarAction, SCR_LockLayerContextAction, SCR_MapToolbarAction, SCR_MoveInFormationContextAction, SCR_MoveToFlightAltitudeContextAction, SCR_MoveToRootContextAction, SCR_MoveToSeatPositionContextAction, SCR_NewSessionToolbarAction, SCR_OpenAttributeWindowContextAction, SCR_PasteAttributesContextAction, SCR_PasteContextAction, SCR_PasteOnOriginalPositionContextAction, SCR_PatrolContextAction, SCR_PauseGameTimeToolbarAction, SCR_PingContextAction, SCR_PlaceEntityContextAction, SCR_PlacingFlagToolbarAction, SCR_RefuelContextAction, SCR_ReplaceWithContextAction, SCR_ResetEditorComponentsToolbarAction, SCR_SaveSessionToolbarAction, SCR_SelectContextAction, SCR_SelectCrewContextAction, SCR_SelectedEntitiesContextAction, SCR_SelectOccupantContextAction, SCR_SelectPassengersContextAction, SCR_SetAsLeaderContextAction, SCR_ShowSelectionContextAction, SCR_SnapToTerrainToolbarAction, SCR_SpawnCrewContextAction, SCR_SpawnPassengersContextAction, SCR_SupplyBasesContextAction, SCR_SuppressContextAction, SCR_SwitchCameraToContextAction, SCR_SwitchToPlayerContextAction, SCR_TakeControlContextAction, SCR_TakeScreenshotDebugToolbarAction, SCR_TeleportCameraContextAction, SCR_TeleportCameraToPlayerContextAction, SCR_TeleportPlayerHereContextAction, SCR_ToggleLocalEditorNightModeToolbarAction, SCR_TransportContextAction, SCR_UnloadContextAction, SCR_UnlockLayerContextAction, and SCR_UserContextAction.

◆ CanBeShown()

bool SCR_BaseEditorAction.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.

◆ CheckAndSetCooldown()

bool SCR_BaseEditorAction.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.

Returns: Returns true if currently on cooldown

◆ GetActionGroup()

EEditorActionGroup SCR_BaseEditorAction.GetActionGroup ( )

◆ GetActionType()

EEditorActionType SCR_BaseEditorAction.GetActionType ( )

◆ GetEffects()

array< ref SCR_BaseEditorEffect > SCR_BaseEditorAction.GetEffects ( )

Get effects tied to the action.

Returns: Array of effects

◆ GetInfo()

SCR_UIInfo SCR_BaseEditorAction.GetInfo ( )

Implemented in SCR_KickPlayerContextAction.

◆ GetOrder()

int SCR_BaseEditorAction.GetOrder ( )

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

◆ GetParam()

int SCR_BaseEditorAction.GetParam ( )

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

Implemented in SCR_CampaignBuildingDeleteSelectedContextAction, and SCR_TakeControlContextAction.

◆ GetShortcut()

string SCR_BaseEditorAction.GetShortcut ( )

Get action shortcut that triggers this action.

Returns: Action name

◆ IsEnabled()

bool SCR_BaseEditorAction.IsEnabled ( )

Returns: True if the action is enabled

◆ IsOnCooldown()

bool SCR_BaseEditorAction.IsOnCooldown ( )

Check if action is on cooldown.

Returns: Returns true if currently on cooldown

◆ IsServer()

bool SCR_BaseEditorAction.IsServer ( )

Should action be sent to server.

Returns: True if action is handled on server

Implemented in SCR_BaseCommandAction, SCR_BaseContextAction, SCR_BrowserToolbarAction, SCR_CameraAttributesToolbarAction, SCR_DeleteDestroyedToolbarAction, SCR_EndGameToolbarAction, SCR_FlashlightToolbarAction, SCR_GlobalAttributesToolbarAction, SCR_HintSequenceToolbarAction, SCR_LayerContextAction, SCR_LoadSessionToolbarAction, SCR_MapToolbarAction, SCR_NewSessionToolbarAction, SCR_OpenAttributeWindowContextAction, SCR_OpenWorldToolbarAction, SCR_PauseGameTimeToolbarAction, SCR_PlaceEntityContextAction, SCR_PlacingFlagToolbarAction, SCR_ResetEditorComponentsToolbarAction, SCR_SaveSessionToolbarAction, SCR_SnapToTerrainToolbarAction, SCR_SwitchToPlayerContextAction, SCR_TakeControlContextAction, SCR_ToggleInterfaceToolbarAction, and SCR_ToggleLocalEditorNightModeToolbarAction.

◆ OnCooldownDone()

void SCR_BaseEditorAction.OnCooldownDone ( )

protected

◆ OnShortcut()

void SCR_BaseEditorAction.OnShortcut ( )

protected

◆ Perform()

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

Perform action.

Implemented in SCR_AssetBrowserContextAction, SCR_AttachToParentContextAction, SCR_BaseCommandAction, SCR_BasePlacingToolbarAction, SCR_BrowserToolbarAction, SCR_CameraAttributesToolbarAction, SCR_CampaignBuildingDeleteSelectedContextAction, SCR_CaptureBasesContextAction, SCR_ChooseAndSpawnOccupantsContextAction, SCR_CopyAttributesContextAction, SCR_CopyIngameTimestampContextAction, SCR_CopyPrefabNameContextAction, SCR_CopyServerTimestampContextAction, SCR_CopyWorldPositionContextAction, SCR_CreateLayerContextAction, SCR_CreateLayerWithSelectionContextAction, SCR_CreateNewGroupContextAction, SCR_CycleContextAction, SCR_DeleteContextAction, SCR_DeleteDestroyedToolbarAction, SCR_DetachContextAction, SCR_DisableSimulationContextAction, SCR_DuplicateContextAction, SCR_EnableSimulationContextAction, SCR_EndGameToolbarAction, SCR_FillVehicleContextAction, SCR_FindInContentBrowserContextAction, SCR_FindInWorkshopContextAction, SCR_FlashlightToolbarAction, SCR_FocusHereContextAction, SCR_GeneralContextAction, SCR_GetInContextAction, SCR_GetOutContextAction, SCR_GlobalAttributesToolbarAction, SCR_HideSelectionContextAction, SCR_HintSequenceToolbarAction, SCR_InstantActionTest, SCR_KickPlayerContextAction, SCR_LayerContextAction, SCR_LeaveModeToolbarAction, SCR_LightningContextAction, SCR_LoadSessionToolbarAction, SCR_LockLayerContextAction, SCR_MapToolbarAction, SCR_MoveInFormationContextAction, SCR_MoveToFlightAltitudeContextAction, SCR_MoveToRootContextAction, SCR_MoveToSeatPositionContextAction, SCR_NewSessionToolbarAction, SCR_OpenAttributeWindowContextAction, SCR_OpenWorldToolbarAction, SCR_PasteAttributesContextAction, SCR_PasteContextAction, SCR_PasteOnOriginalPositionContextAction, SCR_PatrolContextAction, SCR_PauseGameTimeToolbarAction, SCR_PingContextAction, SCR_PlaceEntityContextAction, SCR_PlacingFlagToolbarAction, SCR_RefuelContextAction, SCR_ReplaceWithContextAction, SCR_ResetEditorComponentsToolbarAction, SCR_RewindToolbarAction, SCR_SaveSessionToolbarAction, SCR_SelectContextAction, SCR_SelectCrewContextAction, SCR_SelectedEntitiesContextAction, SCR_SelectOccupantContextAction, SCR_SelectPassengersContextAction, SCR_SetAsLeaderContextAction, SCR_ShowSelectionContextAction, SCR_SnapToTerrainToolbarAction, SCR_SpawnCrewContextAction, SCR_SpawnOccupantsContextAction, SCR_SpawnPassengersContextAction, SCR_SupplyBasesContextAction, SCR_SuppressContextAction, SCR_SwitchCameraToContextAction, SCR_SwitchToPlayerContextAction, SCR_TakeControlContextAction, SCR_TakeScreenshotDebugToolbarAction, SCR_TaskBaseCommandAction, SCR_TeleportCameraContextAction, SCR_TeleportCameraToPlayerContextAction, SCR_TeleportPlayerHereContextAction, SCR_ToggleInterfaceToolbarAction, SCR_ToggleLocalEditorNightModeToolbarAction, SCR_TransportContextAction, SCR_UnloadContextAction, SCR_UnlockLayerContextAction, SCR_UserContextAction, and SCR_WaypointBaseCommandAction.

◆ PerformOwner()

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

Implemented in SCR_SelectedEntitiesContextAction.

◆ RemoveShortcut()

void SCR_BaseEditorAction.RemoveShortcut ( )

Implemented in SCR_DoubleClickAction.

◆ SetShortcutRef()

void SCR_BaseEditorAction.SetShortcutRef ( string shortcutRef )

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

Parameters

shortcutRef Action name

◆ UpdateCooldown()

void SCR_BaseEditorAction.UpdateCooldown ( )

protected

Member Data Documentation

◆ m_ActionGroup

EEditorActionGroup SCR_BaseEditorAction.m_ActionGroup

protected

◆ m_ActionsManager

SCR_BaseActionsEditorComponent SCR_BaseEditorAction.m_ActionsManager

protected

◆ m_ActionType

EEditorActionType SCR_BaseEditorAction.m_ActionType

protected

◆ m_bEnabled

bool SCR_BaseEditorAction.m_bEnabled

protected

◆ m_bEnableShortcutLogics

bool SCR_BaseEditorAction.m_bEnableShortcutLogics

protected

◆ m_bIsOnCooldown

bool SCR_BaseEditorAction.m_bIsOnCooldown

protected

◆ m_bShowOnCooldownNotification

bool SCR_BaseEditorAction.m_bShowOnCooldownNotification

protected

◆ m_Effects

ref array<ref SCR_BaseEditorEffect> SCR_BaseEditorAction.m_Effects

protected

◆ m_fCooldownTime

float SCR_BaseEditorAction.m_fCooldownTime

protected

◆ m_fCooldownUpdateFreq

float SCR_BaseEditorAction.m_fCooldownUpdateFreq = 50

protected

◆ m_fCurrentCooldownTime

float SCR_BaseEditorAction.m_fCurrentCooldownTime

protected

◆ m_Info

ref SCR_UIInfo SCR_BaseEditorAction.m_Info

protected

◆ m_iOrder

int SCR_BaseEditorAction.m_iOrder

protected

◆ m_sShortcut

string SCR_BaseEditorAction.m_sShortcut

protected

◆ m_sShortcutRef

string SCR_BaseEditorAction.m_sShortcutRef

protected

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

Game/Editor/Containers/Actions/SCR_BaseEditorAction.c

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~SCR_BaseEditorAction()

Member Function Documentation

◆ ActivateCooldown()

◆ AddShortcut()

◆ CanBePerformed()

◆ CanBeShown()

◆ CheckAndSetCooldown()

◆ GetActionGroup()

◆ GetActionType()

◆ GetEffects()

◆ GetInfo()

◆ GetOrder()

◆ GetParam()

◆ GetShortcut()

◆ IsEnabled()

◆ IsOnCooldown()

◆ IsServer()

◆ OnCooldownDone()

◆ OnShortcut()

◆ Perform()

◆ PerformOwner()

◆ RemoveShortcut()

◆ SetShortcutRef()

◆ UpdateCooldown()

Member Data Documentation

◆ m_ActionGroup

◆ m_ActionsManager

◆ m_ActionType

◆ m_bEnabled

◆ m_bEnableShortcutLogics

◆ m_bIsOnCooldown

◆ m_bShowOnCooldownNotification

◆ m_Effects

◆ m_fCooldownTime

◆ m_fCooldownUpdateFreq

◆ m_fCurrentCooldownTime

◆ m_Info

◆ m_iOrder

◆ m_sShortcut

◆ m_sShortcutRef