Loading...
Searching...
No Matches
Public Member Functions | List of all members
SCR_SpawnPointBaseCommandAction Interface Reference
Inheritance diagram for SCR_SpawnPointBaseCommandAction:
SCR_BaseCommandAction SCR_BaseToggleToolbarAction SCR_EditorToolbarAction SCR_BaseEditorAction

Public Member Functions

override void FilterEntities (notnull set< SCR_EditableEntityComponent > inEntities, out notnull set< SCR_EditableEntityComponent > outEntities)
 
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.
 
- Public Member Functions inherited from SCR_BaseCommandAction
ResourceName GetCommandPrefab ()
 
bool StartPlacing (notnull set< SCR_EditableEntityComponent > selectedEntities)
 
override void Perform (SCR_EditableEntityComponent hoveredEntity, notnull set< SCR_EditableEntityComponent > selectedEntities, vector cursorWorldPosition, int flags, int param=-1)
 Perform action.
 
override void Track ()
 Track events which influence the action.
 
override void Untrack ()
 Untrack events which influence the action.
 
override bool IsServer ()
 Should action be sent to server.
 
- Public Member Functions inherited from SCR_BaseToggleToolbarAction
ScriptInvoker GetOnToggleChange ()
 Get ScriptInvoker called when the action is toggled by some external event.
 
int GetCurrentValue ()
 Current value.
 
int GetCurrentHighlight ()
 Current value.
 
SCR_UIInfo GetInfoToggled ()
 
- 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 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 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_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 ()
 

Additional Inherited Members

- Protected Member Functions inherited from SCR_BaseCommandAction
set< SCR_EditableEntityComponent > GetSelectedEntities (notnull set< SCR_EditableEntityComponent > inEntities)
 
void OnCurrentActionChanged ()
 
- Protected Member Functions inherited from SCR_BaseToggleToolbarAction
void Toggle (int value, bool highlight=false)
 Toggle action state.
 
- Protected Member Functions inherited from SCR_BaseEditorAction
void OnShortcut ()
 
void ActivateCooldown ()
 
void UpdateCooldown ()
 
void OnCooldownDone ()
 
- Protected Attributes inherited from SCR_BaseCommandAction
ResourceName m_CommandPrefab
 
- Protected Attributes inherited from SCR_BaseToggleToolbarAction
ref SCR_UIInfo m_InfoToggled
 
ref ScriptInvoker m_OnToggleChanged = new ScriptInvoker()
 
int m_iCurrentValue = -1
 
bool m_bCurrentHighlight = false
 
- 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

◆ CanBeShown()

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

◆ FilterEntities()

override void SCR_SpawnPointBaseCommandAction.FilterEntities ( notnull set< SCR_EditableEntityComponent > inEntities,
out notnull set< SCR_EditableEntityComponent > outEntities )

Implements SCR_BaseCommandAction.

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