SCR_BasePlacingToolbarAction Interface Reference

Inheritance diagram for SCR_BasePlacingToolbarAction:

Public Member Functions
override 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.
override 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.
override void	Perform (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags, int param=-1)
	Perform action.
void	PerformCancel ()
	Called by SCR_ToolbarActionsEditorComponent when action was interrupted or entity did not spawn.
void	PerformFinish (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, SCR_EditableEntityComponent placedEntity)
	Called by SCR_ToolbarActionsEditorComponent when entity is placed, after abiility was initiated.
bool	GetPrefab (out ResourceName prefab)
Public Member Functions inherited from SCR_EditorToolbarAction
void	OnInit (SCR_ActionsToolbarEditorUIComponent toolbar)
void	OnExit (SCR_ActionsToolbarEditorUIComponent toolbar)
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.
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 ()

Public Attributes
ResourceName	m_PlaceablePrefab

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_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

Member Function Documentation

CanBePerformed()

override bool SCR_BasePlacingToolbarAction.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.

Implements SCR_BaseEditorAction.

CanBeShown()

override bool SCR_BasePlacingToolbarAction.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.

Implements SCR_BaseEditorAction.

GetPrefab()

bool SCR_BasePlacingToolbarAction.GetPrefab

(

out ResourceName

prefab

)

Perform()

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

Perform action.

Implements SCR_BaseEditorAction.

PerformCancel()

void SCR_BasePlacingToolbarAction.PerformCancel

(

)

Called by SCR_ToolbarActionsEditorComponent when action was interrupted or entity did not spawn.

PerformFinish()

void SCR_BasePlacingToolbarAction.PerformFinish	(	SCR_EditableEntityComponent	hoveredEntity,
		notnull set< SCR_EditableEntityComponent >	selectedEntities,
		SCR_EditableEntityComponent	placedEntity
	)

Called by SCR_ToolbarActionsEditorComponent when entity is placed, after abiility was initiated.

Parameters

hoveredEntity	hovered entity when the action was initiated (hovered entity may be different when this function is called)
selectedEntities	selected entities when the action was initiated (selected entities may be different when this function is called)
placedEntity	Reference to the placed entity

Member Data Documentation

m_PlaceablePrefab

ResourceName SCR_BasePlacingToolbarAction.m_PlaceablePrefab

---

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

• Game/Editor/Containers/Actions/ToolbarActions/SCR_BasePlacingToolbarAction.c