SCR_CommandActionsEditorUIComponent Interface Reference

Inheritance diagram for SCR_CommandActionsEditorUIComponent:

Public Member Functions
EEditorCommandActionFlags	GetCommandState ()
	Get state of commanding.
ScriptInvoker	GetOnCommandStateChange ()
	Get even tcalled every time the commanding state changes.
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_BaseContextMenuEditorUIComponent
void	CloseContextMenu ()
ScriptInvoker	GetOnContextMenuToggle ()
bool	IsContextMenuOpen ()
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	PerformDefaultCommand (bool isQueue)
void	OnEditorSetCommand ()
void	OnEditorAddCommand ()
void	OnEditorCommandModifier (float value, EActionTrigger reason)
void	OnSelectedChanged (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
void	UpdateState (bool clear=false)
Protected Member Functions inherited from SCR_BaseContextMenuEditorUIComponent
void	OnInputDeviceIsGamepad (bool isGamepad)
void	PopulateContextMenu (vector cursorWorldPosition)
void	OpenContextMenu ()
vector	GetCursorWorldPos ()
void	RemoveButtonWidgets ()
void	OnMouseLeftDown ()
void	OnOpenActionsMenuDown ()
void	OnContextMenuOptionClicked (Widget widget, float value, EActionTrigger reason)
void	OnEditorModeChanged ()
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

Protected Attributes
SCR_CommandActionsEditorComponent	m_CommandActionsComponent
SCR_BaseEditableEntityFilter	m_Filter
EEditorCommandActionFlags	m_State
ref ScriptInvoker	Event_OnCommandStateChange = new ScriptInvoker()
Protected Attributes inherited from SCR_BaseContextMenuEditorUIComponent
ResourceName	m_ButtonPath
string	m_VLayoutWidgetName
string	m_sBottomBarName
int	m_ButtonPrefabSizeX
int	m_ButtonPrefabSizeY
float	m_fMenuMouseOffsetX
float	m_fFadeDelayNextButton
float	m_fButtonFadeSpeed
InputManager	m_InputManager
WorkspaceWidget	m_WorkSpace
Widget	m_ContextMenu
Widget	m_VLayout
SCR_FadeUIComponent	m_BottomBarFadeUI
vector	m_MouseDownScreenPos
vector	m_MouseDownWorldPos
ref map< Widget, SCR_BaseEditorAction >	m_ButtonActions = new map<Widget, SCR_BaseEditorAction>
SCR_BaseActionsEditorComponent	m_EditorActionsComponent
SCR_EditorManagerEntity	m_EditorManager
SCR_CursorEditorUIComponent	m_CursorComponent
SCR_MouseAreaEditorUIComponent	m_MouseArea
int	m_ActionFlagsOnOpen
ref ScriptInvoker	m_OnContextMenuToggle = new ScriptInvoker()
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500

Member Function Documentation

GetCommandState()

EEditorCommandActionFlags SCR_CommandActionsEditorUIComponent.GetCommandState

(

)

Get state of commanding.

Returns

State based on selected entities

GetOnCommandStateChange()

ScriptInvoker SCR_CommandActionsEditorUIComponent.GetOnCommandStateChange

(

)

Get even tcalled every time the commanding state changes.

Returns

Script invoker

HandlerAttachedScripted()

override void SCR_CommandActionsEditorUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements SCR_BaseContextMenuEditorUIComponent.

HandlerDeattached()

override void SCR_CommandActionsEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements SCR_BaseContextMenuEditorUIComponent.

OnEditorAddCommand()

void SCR_CommandActionsEditorUIComponent.OnEditorAddCommand ( )

protected

OnEditorCommandModifier()

void SCR_CommandActionsEditorUIComponent.OnEditorCommandModifier ( float  value, EActionTrigger  reason  )

protected

OnEditorSetCommand()

void SCR_CommandActionsEditorUIComponent.OnEditorSetCommand ( )

protected

OnSelectedChanged()

void SCR_CommandActionsEditorUIComponent.OnSelectedChanged ( EEditableEntityState  state, set< SCR_EditableEntityComponent >  entitiesInsert, set< SCR_EditableEntityComponent >  entitiesRemove  )

protected

PerformDefaultCommand()

void SCR_CommandActionsEditorUIComponent.PerformDefaultCommand ( bool  isQueue )

protected

UpdateState()

void SCR_CommandActionsEditorUIComponent.UpdateState ( bool  clear = false )

protected

Member Data Documentation

Event_OnCommandStateChange

ref ScriptInvoker SCR_CommandActionsEditorUIComponent.Event_OnCommandStateChange = new ScriptInvoker()

protected

m_CommandActionsComponent

SCR_CommandActionsEditorComponent SCR_CommandActionsEditorUIComponent.m_CommandActionsComponent

protected

m_Filter

SCR_BaseEditableEntityFilter SCR_CommandActionsEditorUIComponent.m_Filter

protected

m_State

EEditorCommandActionFlags SCR_CommandActionsEditorUIComponent.m_State

protected

---

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

• Game/Editor/UI/Components/Common/SCR_CommandActionsEditorUIComponent.c