SCR_DoubleClickAction Interface Reference

Inheritance diagram for SCR_DoubleClickAction:

Public Member Functions
override void	AddShortcut (SCR_BaseActionsEditorComponent actionsManager)
override void	RemoveShortcut ()
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	CachePosition ()
void	OnLMB ()
vector	GetMousePosVector ()
bool	DidCursorMoveDuringDoubleClick ()
Protected Member Functions inherited from SCR_BaseEditorAction
void	OnShortcut ()
void	ActivateCooldown ()
void	UpdateCooldown ()
void	OnCooldownDone ()

Protected Attributes
bool	m_bIsDoubleClick
vector	m_vMouseLeftPos
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

Static Protected Attributes
const string	LMB_ACTION = "MouseLeft"
const int	MAX_CURSOR_DIST_SQ = 100

Member Function Documentation

AddShortcut()

override void SCR_DoubleClickAction.AddShortcut

(

SCR_BaseActionsEditorComponent

actionsManager

)

Implements SCR_BaseEditorAction.

CachePosition()

void SCR_DoubleClickAction.CachePosition ( )

protected

DidCursorMoveDuringDoubleClick()

bool SCR_DoubleClickAction.DidCursorMoveDuringDoubleClick ( )

protected

GetMousePosVector()

vector SCR_DoubleClickAction.GetMousePosVector ( )

protected

OnLMB()

void SCR_DoubleClickAction.OnLMB ( )

protected

RemoveShortcut()

override void SCR_DoubleClickAction.RemoveShortcut

(

)

Implements SCR_BaseEditorAction.

Member Data Documentation

LMB_ACTION

const string SCR_DoubleClickAction.LMB_ACTION = "MouseLeft"

staticprotected

m_bIsDoubleClick

bool SCR_DoubleClickAction.m_bIsDoubleClick

protected

m_vMouseLeftPos

vector SCR_DoubleClickAction.m_vMouseLeftPos

protected

MAX_CURSOR_DIST_SQ

const int SCR_DoubleClickAction.MAX_CURSOR_DIST_SQ = 100

staticprotected

---

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

• Game/Editor/Containers/Actions/ContextActions/SCR_DoubleClickAction.c