SCR_CycleWaypointEditorUIComponent Interface Reference

Inheritance diagram for SCR_CycleWaypointEditorUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_ModularButtonComponent
void	SetEnabled (bool enabled)
bool	GetEnabled ()
void	SetToggled (bool toggled, bool invokeOnToggled=true, bool instant=false)
bool	GetToggled ()
bool	GetFocused ()
bool	GetMouseOver ()
void	SetToggleable (bool toggleable)
void	SetTogglableOnlyThroughApi (bool newValue)
void	SetData (Managed data)
Managed	GetData ()
Widget	GetRootWidget ()
bool	SetVisible (bool visible)
SCR_ButtonEffectBase	FindEffect (string tag)
	Returns first effect with given tag.
array< SCR_ButtonEffectBase >	FindAllEffects (string tag)
array< SCR_ButtonEffectBase >	GetAllEffects ()
void	SetEffectsEnabled (string tag, bool enable)
	Enables or disables all effects with given tag.
void	SetEffectsWithAnyTagEnabled (notnull array< string > tags)
	Effects with at least one tag are enabled.
void	SetAllEffectsEnabled (bool enable)
	Enables ar disables all effects.
void	InvokeAllEnabledEffects (bool instant)
	Applies all enabled effects.
void	Internal_OnMasterButtonEvent (EModularButtonEventFlag eventFlag, bool instant)
	Used for passing events from master button / slave button This is called on a slave button by SCR_ButtonEffectSlaveButton.
void	Internal_OnEffectEnabled (SCR_ButtonEffectBase effect)
	Must only be called by the effect class.
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnDoubleClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
void	_print (string s)
bool	GetIsFocusOnMouseEnter ()
void	SetIsFocusOnMouseEnter (bool focus)
string	GetCurrentStateName ()

Protected Member Functions
void	OnInputDeviceIsGamepad (bool isGamepad)
void	UpdateInputVisuals ()
	Styles the widget according to the current input device.
void	OnSelectedEntitiesChange (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
	Runs when selected entities from entities manager change. Used to update visibility of toggle.
void	ToggleCycleWaypoints ()
	Toggle cycle waypoints for selected groups, based on the status of the first group.
void	EnableCycleWaypoints ()
	Enable cycle waypoints for selected groups.
void	DisableCycleWaypoints ()
	Disable cycle waypoints for selected groups.
bool	GetSelectedGroups (notnull out set< SCR_EditableGroupComponent > selectedGroups)
	Returns groups from selected entities (unique)
bool	GetHasCycleWaypointsActivated ()
	Returns if any of the selected group has cycle waypoint activated.
bool	CanShowToggleCycleWaypoint ()
	Returns if toggle cycle waypoint button can be shown.
Protected Member Functions inherited from SCR_ModularButtonComponent
void	UpdateCurrentState ()
	Checks current state, invokes state change effects if state has changed.
EModularButtonState	GetCurrentState ()
void	InvokeEffectsEvent (EModularButtonEventFlag eventFlag, bool instant=false)
	Calls _OnEvent of all enabled effects.
void	Internal_SetToggled (bool newToggled, bool invokeOnToggled=true, bool instant=false)

Protected Attributes
SCR_BaseEditableEntityFilter	m_SelectedEntitiesManager
string	m_sCycleWaypointsToggleWidgetName
string	m_sSeparatorWidgetName
string	m_sRadialActionName
float	m_fGamepadScale
float	m_fMKBottomPadding
ButtonWidget	m_wCycleWaypointsToggle
SCR_ModularButtonComponent	m_ModularButtonToggleComponent
Widget	m_wSeparator
SCR_PlacingEditorComponent	m_PlacingEditor
bool	m_bIsGamepad
Protected Attributes inherited from SCR_ModularButtonComponent
ref array< ref SCR_ButtonEffectBase >	m_aEffects
bool	m_bCanBeToggled
bool	m_bToggledOnlyThroughApi
bool	m_bToggledAtStart
EModularButtonEventHandler	m_eEventReturnValue
bool	m_bFocusOnMouseEnter
bool	m_bIgnoreStandardInputs
Widget	m_wRoot
bool	m_bFocus
bool	m_bMouseOver
bool	m_bToggled
EModularButtonState	m_eState
ref Managed	m_UserData

Additional Inherited Members
Static Public Member Functions inherited from SCR_ModularButtonComponent
static SCR_ModularButtonComponent	FindComponent (Widget w)
	Finds SCR_ModularButtonComponent on a widget.
Public Attributes inherited from SCR_ModularButtonComponent
ref ScriptInvoker	m_OnClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnDoubleClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnToggled = new ScriptInvoker()
ref ScriptInvoker	m_OnFocus = new ScriptInvoker()
ref ScriptInvoker	m_OnFocusLost = new ScriptInvoker()
ref ScriptInvoker	m_OnMouseEnter = new ScriptInvoker()
ref ScriptInvoker	m_OnMouseLeave = new ScriptInvoker()

Member Function Documentation

CanShowToggleCycleWaypoint()

bool SCR_CycleWaypointEditorUIComponent.CanShowToggleCycleWaypoint ( )

protected

Returns if toggle cycle waypoint button can be shown.

DisableCycleWaypoints()

void SCR_CycleWaypointEditorUIComponent.DisableCycleWaypoints ( )

protected

Disable cycle waypoints for selected groups.

EnableCycleWaypoints()

void SCR_CycleWaypointEditorUIComponent.EnableCycleWaypoints ( )

protected

Enable cycle waypoints for selected groups.

GetHasCycleWaypointsActivated()

bool SCR_CycleWaypointEditorUIComponent.GetHasCycleWaypointsActivated ( )

protected

Returns if any of the selected group has cycle waypoint activated.

Returns

bool to say if it contains or not

GetSelectedGroups()

bool SCR_CycleWaypointEditorUIComponent.GetSelectedGroups ( notnull out set< SCR_EditableGroupComponent >  selectedGroups )

protected

Returns groups from selected entities (unique)

Parameters

[out]

selectedGroups

set of groups, must be initialized

Returns

bool to say if it contains or not

HandlerAttached()

override void SCR_CycleWaypointEditorUIComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ModularButtonComponent.

HandlerDeattached()

override void SCR_CycleWaypointEditorUIComponent.HandlerDeattached

(

Widget

w

)

OnInputDeviceIsGamepad()

void SCR_CycleWaypointEditorUIComponent.OnInputDeviceIsGamepad ( bool  isGamepad )

protected

OnSelectedEntitiesChange()

void SCR_CycleWaypointEditorUIComponent.OnSelectedEntitiesChange ( EEditableEntityState  state, set< SCR_EditableEntityComponent >  entitiesInsert, set< SCR_EditableEntityComponent >  entitiesRemove  )

protected

Runs when selected entities from entities manager change. Used to update visibility of toggle.

ToggleCycleWaypoints()

void SCR_CycleWaypointEditorUIComponent.ToggleCycleWaypoints ( )

protected

Toggle cycle waypoints for selected groups, based on the status of the first group.

UpdateInputVisuals()

void SCR_CycleWaypointEditorUIComponent.UpdateInputVisuals ( )

protected

Styles the widget according to the current input device.

Member Data Documentation

m_bIsGamepad

bool SCR_CycleWaypointEditorUIComponent.m_bIsGamepad

protected

m_fGamepadScale

float SCR_CycleWaypointEditorUIComponent.m_fGamepadScale

protected

m_fMKBottomPadding

float SCR_CycleWaypointEditorUIComponent.m_fMKBottomPadding

protected

m_ModularButtonToggleComponent

SCR_ModularButtonComponent SCR_CycleWaypointEditorUIComponent.m_ModularButtonToggleComponent

protected

m_PlacingEditor

SCR_PlacingEditorComponent SCR_CycleWaypointEditorUIComponent.m_PlacingEditor

protected

m_sCycleWaypointsToggleWidgetName

string SCR_CycleWaypointEditorUIComponent.m_sCycleWaypointsToggleWidgetName

protected

m_SelectedEntitiesManager

SCR_BaseEditableEntityFilter SCR_CycleWaypointEditorUIComponent.m_SelectedEntitiesManager

protected

m_sRadialActionName

string SCR_CycleWaypointEditorUIComponent.m_sRadialActionName

protected

m_sSeparatorWidgetName

string SCR_CycleWaypointEditorUIComponent.m_sSeparatorWidgetName

protected

m_wCycleWaypointsToggle

ButtonWidget SCR_CycleWaypointEditorUIComponent.m_wCycleWaypointsToggle

protected

m_wSeparator

Widget SCR_CycleWaypointEditorUIComponent.m_wSeparator

protected

---

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

• Game/Editor/UI/Components/Toolbar/SCR_CycleWaypointEditorUIComponent.c