SCR_BaseToggleToolbarAction Interface Reference

Inheritance diagram for SCR_BaseToggleToolbarAction:

Public Member Functions
ScriptInvoker	GetOnToggleChange ()
	Get ScriptInvoker called when the action is toggled by some external event.
int	GetCurrentValue ()
	Current value.
int	GetCurrentHighlight ()
	Current value.
void	Track ()
	Track events which influence the action.
void	Untrack ()
	Untrack events which influence the action.
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	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	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
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

GetCurrentHighlight()

int SCR_BaseToggleToolbarAction.GetCurrentHighlight

(

)

Current value.

GetCurrentValue()

int SCR_BaseToggleToolbarAction.GetCurrentValue

(

)

Current value.

GetInfoToggled()

SCR_UIInfo SCR_BaseToggleToolbarAction.GetInfoToggled

(

)

GetOnToggleChange()

ScriptInvoker SCR_BaseToggleToolbarAction.GetOnToggleChange

(

)

Get ScriptInvoker called when the action is toggled by some external event.

Toggle()

void SCR_BaseToggleToolbarAction.Toggle ( int value, bool highlight = false )

protected

Toggle action state.

To be called by inherited classes.

Track()

void SCR_BaseToggleToolbarAction.Track

(

)

Track events which influence the action.

Called when the action's GUI representation is created. To be overloaded by inherited classes.

Implemented in SCR_BaseCommandAction, SCR_FlashlightToolbarAction, SCR_HintSequenceToolbarAction, SCR_PauseGameTimeToolbarAction, SCR_PlacingFlagToolbarAction, and SCR_ToggleLocalEditorNightModeToolbarAction.

Untrack()

void SCR_BaseToggleToolbarAction.Untrack

(

)

Untrack events which influence the action.

Called when the action's GUI representation is destroyed. To be overloaded by inherited classes.

Implemented in SCR_BaseCommandAction, SCR_FlashlightToolbarAction, SCR_HintSequenceToolbarAction, SCR_PauseGameTimeToolbarAction, SCR_PlacingFlagToolbarAction, and SCR_ToggleLocalEditorNightModeToolbarAction.

Member Data Documentation

m_bCurrentHighlight

bool SCR_BaseToggleToolbarAction.m_bCurrentHighlight = false

protected

m_iCurrentValue

int SCR_BaseToggleToolbarAction.m_iCurrentValue = -1

protected

m_InfoToggled

ref SCR_UIInfo SCR_BaseToggleToolbarAction.m_InfoToggled

protected

m_OnToggleChanged

ref ScriptInvoker SCR_BaseToggleToolbarAction.m_OnToggleChanged = new ScriptInvoker()

protected

---

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

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