Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_SelectionEditorUIComponent Interface Reference
Inheritance diagram for SCR_SelectionEditorUIComponent:
[legend]

Public Member Functions

void DisableMultiSelection ()
 Disable gamepad multi-selection.
 
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 EditorToggleSelection (float value=1, EActionTrigger reason=EActionTrigger.DOWN)
 
void EditorSetSelection (float value=1, EActionTrigger reason=EActionTrigger.DOWN)
 
void EditorAddSelection (float value=1, EActionTrigger reason=EActionTrigger.DOWN)
 
void EditorClearSelection (float value=1, EActionTrigger reason=EActionTrigger.DOWN)
 
void EditorSelectAll (float value=1, EActionTrigger reason=EActionTrigger.DOWN)
 
void EditorDrawSetSelectionDown (float value, EActionTrigger reason)
 
void EditorDrawSetSelectionPressed (float value, EActionTrigger reason)
 
void EditorDrawSetSelectionUp (float value, EActionTrigger reason)
 
void EditorDrawToggleSelectionDown (float value, EActionTrigger reason)
 
void EditorDrawToggleSelectionPressed (float value, EActionTrigger reason)
 
void EditorDrawToggleSelectionUp (float value, EActionTrigger reason)
 
void EditorDrawSelectionCancel (float value, EActionTrigger reason)
 
void DrawFrameDown (bool isToggle)
 
void DrawFrameUp (bool isToggle)
 
void DrawFramePressed (bool isToggle)
 
bool DrawFrameMouseAndKeyboard (set< SCR_EditableEntityComponent > entities, out set< SCR_EditableEntityComponent > entitiesInside)
 
bool DrawFrameController (set< SCR_EditableEntityComponent > entities, out set< SCR_EditableEntityComponent > entitiesInside)
 
void ConfirmFrame (bool isToggle)
 
void CancelFrame ()
 
void ResetFrame ()
 
void OnCurrentLayerChange (SCR_EditableEntityComponent currentLayer, SCR_EditableEntityComponent prevLayer)
 
void EnableSelection (bool enable)
 
bool IsMapOpened ()
 
void OnMenuUpdate (float tDelta)
 
void OnMenuFocusLost ()
 
Widget GetFrameWidget (Widget root, string name)
 
void EditorSaveSelection (int index)
 
void EditorSaveSelection1 ()
 
void EditorSaveSelection2 ()
 
void EditorSaveSelection3 ()
 
void EditorSaveSelection4 ()
 
void EditorSaveSelection5 ()
 
void EditorSaveSelection6 ()
 
void EditorSaveSelection7 ()
 
void EditorSaveSelection8 ()
 
void EditorSaveSelection9 ()
 
void EditorSaveSelection0 ()
 
void EditorLoadSelection (int index)
 
void EditorLoadSelection1 ()
 
void EditorLoadSelection2 ()
 
void EditorLoadSelection3 ()
 
void EditorLoadSelection4 ()
 
void EditorLoadSelection5 ()
 
void EditorLoadSelection6 ()
 
void EditorLoadSelection7 ()
 
void EditorLoadSelection8 ()
 
void EditorLoadSelection9 ()
 
void EditorLoadSelection0 ()
 
void EditorTeleportSelection (int index)
 
void EditorTeleportSelection1 ()
 
void EditorTeleportSelection2 ()
 
void EditorTeleportSelection3 ()
 
void EditorTeleportSelection4 ()
 
void EditorTeleportSelection5 ()
 
void EditorTeleportSelection6 ()
 
void EditorTeleportSelection7 ()
 
void EditorTeleportSelection8 ()
 
void EditorTeleportSelection9 ()
 
void EditorTeleportSelection0 ()
 
bool IsInputDisabled ()
 
void ShowGUI ()
 
- 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

EEditableEntityState m_UnselectedState
 State in which entities are unselected.
 
EEditableEntityState m_MultiSelectStates
 
bool m_bEnableMultiSelection
 
string m_sSetSelectionWidgetName
 
string m_sToggleSelectionWidgetName
 
string m_sGamepadSetSelectionWidgetName
 
string m_sGamepadToggleSelectionWidgetName
 
float m_fGamepadSelectionWidgetStartSize
 
float m_fGamepadSelectionDuration
 
ref Curve m_GamepadSelectionCurve
 
string m_sSfxStartDrawingSelectionFrame_Keyboard
 
string m_sSfxStartDrawingSelectionFrame_Gamepad
 
string m_sSfxSelectionFrameClose_NothingSelected
 
string m_sSfxSelectionFrameClose_Cancel
 
string m_sSfxSelectEntities
 
string m_sSfxToggleEntities
 
string m_sSfxToggleSingleEntity_On
 
string m_sSfxToggleSingleEntity_Off
 
string m_sSfxClearSelection
 
Widget m_SetSelectionWidget
 
Widget m_ToggleSelectionWidget
 
Widget m_GamepadSetSelectionWidget
 
Widget m_GamepadToggleSelectionWidget
 
InputManager m_InputManager
 
WorkspaceWidget m_Workspace
 
SCR_MenuEditorComponent m_EditorMenuManager
 
SCR_StatesEditorComponent m_StatesManager
 
SCR_EntitiesManagerEditorComponent m_EntitiesManager
 
SCR_LayersEditorComponent m_LayersManager
 
SCR_BaseEditableEntityFilter m_UnselectedManager
 
SCR_BaseEditableEntityFilter m_FocusedManager
 
SCR_HoverEditableEntityFilter m_HoverManager
 
SCR_SelectedEditableEntityFilter m_SelectedManager
 
SCR_CursorEditorUIComponent m_CursorComponent
 
SCR_MouseAreaEditorUIComponent m_MouseArea
 
vector m_vCursorPosClick
 
float m_fSelectionFrameDuration
 
bool m_bEnableSelection = true
 
bool m_bIsDrawingFrame
 
bool m_bIsDrawingFrameIsToggle
 
bool m_bIsDrawingFrameConfirmed
 
bool m_bIsDrawingFrameCancelled
 
bool m_bIsDrawingFrameDisabled
 
bool m_bIsAnimatingFrame
 
bool m_bHideCursor
 
int m_iGamepadSelectionHeight
 
BaseWorld m_World
 
- Protected Attributes inherited from SCR_BaseEditorUIComponent
vector m_vClickPosCancel
 

Static Protected Attributes

static const float FRAME_SIZE_MIN = 10
 How many ref pixels must cursor move for frame selection to begin (mouse & keyboard)
 
static const float FRAME_DURATION_MIN = 0.15
 How long must the button bepressed for frame selection to behin (controller)
 

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

◆ CancelFrame()

void SCR_SelectionEditorUIComponent.CancelFrame ( )
protected

◆ ConfirmFrame()

void SCR_SelectionEditorUIComponent.ConfirmFrame ( bool  isToggle)
protected

◆ DisableMultiSelection()

void SCR_SelectionEditorUIComponent.DisableMultiSelection ( )

Disable gamepad multi-selection.

On gamepad, multi-selection is mapped to holding a button. Use when you have the same input on an action, but don't want multi-selection to start right after the action is activated.

◆ DrawFrameController()

bool SCR_SelectionEditorUIComponent.DrawFrameController ( set< SCR_EditableEntityComponent entities,
out set< SCR_EditableEntityComponent entitiesInside 
)
protected

◆ DrawFrameDown()

void SCR_SelectionEditorUIComponent.DrawFrameDown ( bool  isToggle)
protected

◆ DrawFrameMouseAndKeyboard()

bool SCR_SelectionEditorUIComponent.DrawFrameMouseAndKeyboard ( set< SCR_EditableEntityComponent entities,
out set< SCR_EditableEntityComponent entitiesInside 
)
protected

◆ DrawFramePressed()

void SCR_SelectionEditorUIComponent.DrawFramePressed ( bool  isToggle)
protected

◆ DrawFrameUp()

void SCR_SelectionEditorUIComponent.DrawFrameUp ( bool  isToggle)
protected

◆ EditorAddSelection()

void SCR_SelectionEditorUIComponent.EditorAddSelection ( float  value = 1,
EActionTrigger  reason = EActionTrigger::DOWN 
)
protected

◆ EditorClearSelection()

void SCR_SelectionEditorUIComponent.EditorClearSelection ( float  value = 1,
EActionTrigger  reason = EActionTrigger::DOWN 
)
protected

◆ EditorDrawSelectionCancel()

void SCR_SelectionEditorUIComponent.EditorDrawSelectionCancel ( float  value,
EActionTrigger  reason 
)
protected

◆ EditorDrawSetSelectionDown()

void SCR_SelectionEditorUIComponent.EditorDrawSetSelectionDown ( float  value,
EActionTrigger  reason 
)
protected

◆ EditorDrawSetSelectionPressed()

void SCR_SelectionEditorUIComponent.EditorDrawSetSelectionPressed ( float  value,
EActionTrigger  reason 
)
protected

◆ EditorDrawSetSelectionUp()

void SCR_SelectionEditorUIComponent.EditorDrawSetSelectionUp ( float  value,
EActionTrigger  reason 
)
protected

◆ EditorDrawToggleSelectionDown()

void SCR_SelectionEditorUIComponent.EditorDrawToggleSelectionDown ( float  value,
EActionTrigger  reason 
)
protected

◆ EditorDrawToggleSelectionPressed()

void SCR_SelectionEditorUIComponent.EditorDrawToggleSelectionPressed ( float  value,
EActionTrigger  reason 
)
protected

◆ EditorDrawToggleSelectionUp()

void SCR_SelectionEditorUIComponent.EditorDrawToggleSelectionUp ( float  value,
EActionTrigger  reason 
)
protected

◆ EditorLoadSelection()

void SCR_SelectionEditorUIComponent.EditorLoadSelection ( int  index)
protected

◆ EditorLoadSelection0()

void SCR_SelectionEditorUIComponent.EditorLoadSelection0 ( )
protected

◆ EditorLoadSelection1()

void SCR_SelectionEditorUIComponent.EditorLoadSelection1 ( )
protected

◆ EditorLoadSelection2()

void SCR_SelectionEditorUIComponent.EditorLoadSelection2 ( )
protected

◆ EditorLoadSelection3()

void SCR_SelectionEditorUIComponent.EditorLoadSelection3 ( )
protected

◆ EditorLoadSelection4()

void SCR_SelectionEditorUIComponent.EditorLoadSelection4 ( )
protected

◆ EditorLoadSelection5()

void SCR_SelectionEditorUIComponent.EditorLoadSelection5 ( )
protected

◆ EditorLoadSelection6()

void SCR_SelectionEditorUIComponent.EditorLoadSelection6 ( )
protected

◆ EditorLoadSelection7()

void SCR_SelectionEditorUIComponent.EditorLoadSelection7 ( )
protected

◆ EditorLoadSelection8()

void SCR_SelectionEditorUIComponent.EditorLoadSelection8 ( )
protected

◆ EditorLoadSelection9()

void SCR_SelectionEditorUIComponent.EditorLoadSelection9 ( )
protected

◆ EditorSaveSelection()

void SCR_SelectionEditorUIComponent.EditorSaveSelection ( int  index)
protected

◆ EditorSaveSelection0()

void SCR_SelectionEditorUIComponent.EditorSaveSelection0 ( )
protected

◆ EditorSaveSelection1()

void SCR_SelectionEditorUIComponent.EditorSaveSelection1 ( )
protected

◆ EditorSaveSelection2()

void SCR_SelectionEditorUIComponent.EditorSaveSelection2 ( )
protected

◆ EditorSaveSelection3()

void SCR_SelectionEditorUIComponent.EditorSaveSelection3 ( )
protected

◆ EditorSaveSelection4()

void SCR_SelectionEditorUIComponent.EditorSaveSelection4 ( )
protected

◆ EditorSaveSelection5()

void SCR_SelectionEditorUIComponent.EditorSaveSelection5 ( )
protected

◆ EditorSaveSelection6()

void SCR_SelectionEditorUIComponent.EditorSaveSelection6 ( )
protected

◆ EditorSaveSelection7()

void SCR_SelectionEditorUIComponent.EditorSaveSelection7 ( )
protected

◆ EditorSaveSelection8()

void SCR_SelectionEditorUIComponent.EditorSaveSelection8 ( )
protected

◆ EditorSaveSelection9()

void SCR_SelectionEditorUIComponent.EditorSaveSelection9 ( )
protected

◆ EditorSelectAll()

void SCR_SelectionEditorUIComponent.EditorSelectAll ( float  value = 1,
EActionTrigger  reason = EActionTrigger::DOWN 
)
protected

◆ EditorSetSelection()

void SCR_SelectionEditorUIComponent.EditorSetSelection ( float  value = 1,
EActionTrigger  reason = EActionTrigger::DOWN 
)
protected

◆ EditorTeleportSelection()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection ( int  index)
protected

◆ EditorTeleportSelection0()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection0 ( )
protected

◆ EditorTeleportSelection1()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection1 ( )
protected

◆ EditorTeleportSelection2()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection2 ( )
protected

◆ EditorTeleportSelection3()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection3 ( )
protected

◆ EditorTeleportSelection4()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection4 ( )
protected

◆ EditorTeleportSelection5()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection5 ( )
protected

◆ EditorTeleportSelection6()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection6 ( )
protected

◆ EditorTeleportSelection7()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection7 ( )
protected

◆ EditorTeleportSelection8()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection8 ( )
protected

◆ EditorTeleportSelection9()

void SCR_SelectionEditorUIComponent.EditorTeleportSelection9 ( )
protected

◆ EditorToggleSelection()

void SCR_SelectionEditorUIComponent.EditorToggleSelection ( float  value = 1,
EActionTrigger  reason = EActionTrigger::DOWN 
)
protected

◆ EnableSelection()

void SCR_SelectionEditorUIComponent.EnableSelection ( bool  enable)
protected

◆ GetFrameWidget()

Widget SCR_SelectionEditorUIComponent.GetFrameWidget ( Widget  root,
string  name 
)
protected

◆ HandlerAttachedScripted()

override void SCR_SelectionEditorUIComponent.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 MenuRootSubComponent.

◆ HandlerDeattached()

override void SCR_SelectionEditorUIComponent.HandlerDeattached ( Widget  w)

Implements MenuRootSubComponent.

◆ IsInputDisabled()

bool SCR_SelectionEditorUIComponent.IsInputDisabled ( )
protected

◆ IsMapOpened()

bool SCR_SelectionEditorUIComponent.IsMapOpened ( )
protected

◆ OnCurrentLayerChange()

void SCR_SelectionEditorUIComponent.OnCurrentLayerChange ( SCR_EditableEntityComponent  currentLayer,
SCR_EditableEntityComponent  prevLayer 
)
protected

◆ OnMenuFocusLost()

void SCR_SelectionEditorUIComponent.OnMenuFocusLost ( )
protected

◆ OnMenuUpdate()

void SCR_SelectionEditorUIComponent.OnMenuUpdate ( float  tDelta)
protected

◆ ResetFrame()

void SCR_SelectionEditorUIComponent.ResetFrame ( )
protected

◆ ShowGUI()

void SCR_SelectionEditorUIComponent.ShowGUI ( )
protected

Member Data Documentation

◆ FRAME_DURATION_MIN

const float SCR_SelectionEditorUIComponent.FRAME_DURATION_MIN = 0.15
staticprotected

How long must the button bepressed for frame selection to behin (controller)

◆ FRAME_SIZE_MIN

const float SCR_SelectionEditorUIComponent.FRAME_SIZE_MIN = 10
staticprotected

How many ref pixels must cursor move for frame selection to begin (mouse & keyboard)

◆ m_bEnableMultiSelection

bool SCR_SelectionEditorUIComponent.m_bEnableMultiSelection
protected

◆ m_bEnableSelection

bool SCR_SelectionEditorUIComponent.m_bEnableSelection = true
protected

◆ m_bHideCursor

bool SCR_SelectionEditorUIComponent.m_bHideCursor
protected

◆ m_bIsAnimatingFrame

bool SCR_SelectionEditorUIComponent.m_bIsAnimatingFrame
protected

◆ m_bIsDrawingFrame

bool SCR_SelectionEditorUIComponent.m_bIsDrawingFrame
protected

◆ m_bIsDrawingFrameCancelled

bool SCR_SelectionEditorUIComponent.m_bIsDrawingFrameCancelled
protected

◆ m_bIsDrawingFrameConfirmed

bool SCR_SelectionEditorUIComponent.m_bIsDrawingFrameConfirmed
protected

◆ m_bIsDrawingFrameDisabled

bool SCR_SelectionEditorUIComponent.m_bIsDrawingFrameDisabled
protected

◆ m_bIsDrawingFrameIsToggle

bool SCR_SelectionEditorUIComponent.m_bIsDrawingFrameIsToggle
protected

◆ m_CursorComponent

SCR_CursorEditorUIComponent SCR_SelectionEditorUIComponent.m_CursorComponent
protected

◆ m_EditorMenuManager

SCR_MenuEditorComponent SCR_SelectionEditorUIComponent.m_EditorMenuManager
protected

◆ m_EntitiesManager

SCR_EntitiesManagerEditorComponent SCR_SelectionEditorUIComponent.m_EntitiesManager
protected

◆ m_fGamepadSelectionDuration

float SCR_SelectionEditorUIComponent.m_fGamepadSelectionDuration
protected

◆ m_fGamepadSelectionWidgetStartSize

float SCR_SelectionEditorUIComponent.m_fGamepadSelectionWidgetStartSize
protected

◆ m_FocusedManager

SCR_BaseEditableEntityFilter SCR_SelectionEditorUIComponent.m_FocusedManager
protected

◆ m_fSelectionFrameDuration

float SCR_SelectionEditorUIComponent.m_fSelectionFrameDuration
protected

◆ m_GamepadSelectionCurve

ref Curve SCR_SelectionEditorUIComponent.m_GamepadSelectionCurve
protected

◆ m_GamepadSetSelectionWidget

Widget SCR_SelectionEditorUIComponent.m_GamepadSetSelectionWidget
protected

◆ m_GamepadToggleSelectionWidget

Widget SCR_SelectionEditorUIComponent.m_GamepadToggleSelectionWidget
protected

◆ m_HoverManager

SCR_HoverEditableEntityFilter SCR_SelectionEditorUIComponent.m_HoverManager
protected

◆ m_iGamepadSelectionHeight

int SCR_SelectionEditorUIComponent.m_iGamepadSelectionHeight
protected

◆ m_InputManager

InputManager SCR_SelectionEditorUIComponent.m_InputManager
protected

◆ m_LayersManager

SCR_LayersEditorComponent SCR_SelectionEditorUIComponent.m_LayersManager
protected

◆ m_MouseArea

SCR_MouseAreaEditorUIComponent SCR_SelectionEditorUIComponent.m_MouseArea
protected

◆ m_MultiSelectStates

EEditableEntityState SCR_SelectionEditorUIComponent.m_MultiSelectStates
protected

◆ m_SelectedManager

SCR_SelectedEditableEntityFilter SCR_SelectionEditorUIComponent.m_SelectedManager
protected

◆ m_SetSelectionWidget

Widget SCR_SelectionEditorUIComponent.m_SetSelectionWidget
protected

◆ m_sGamepadSetSelectionWidgetName

string SCR_SelectionEditorUIComponent.m_sGamepadSetSelectionWidgetName
protected

◆ m_sGamepadToggleSelectionWidgetName

string SCR_SelectionEditorUIComponent.m_sGamepadToggleSelectionWidgetName
protected

◆ m_sSetSelectionWidgetName

string SCR_SelectionEditorUIComponent.m_sSetSelectionWidgetName
protected

◆ m_sSfxClearSelection

string SCR_SelectionEditorUIComponent.m_sSfxClearSelection
protected

◆ m_sSfxSelectEntities

string SCR_SelectionEditorUIComponent.m_sSfxSelectEntities
protected

◆ m_sSfxSelectionFrameClose_Cancel

string SCR_SelectionEditorUIComponent.m_sSfxSelectionFrameClose_Cancel
protected

◆ m_sSfxSelectionFrameClose_NothingSelected

string SCR_SelectionEditorUIComponent.m_sSfxSelectionFrameClose_NothingSelected
protected

◆ m_sSfxStartDrawingSelectionFrame_Gamepad

string SCR_SelectionEditorUIComponent.m_sSfxStartDrawingSelectionFrame_Gamepad
protected

◆ m_sSfxStartDrawingSelectionFrame_Keyboard

string SCR_SelectionEditorUIComponent.m_sSfxStartDrawingSelectionFrame_Keyboard
protected

◆ m_sSfxToggleEntities

string SCR_SelectionEditorUIComponent.m_sSfxToggleEntities
protected

◆ m_sSfxToggleSingleEntity_Off

string SCR_SelectionEditorUIComponent.m_sSfxToggleSingleEntity_Off
protected

◆ m_sSfxToggleSingleEntity_On

string SCR_SelectionEditorUIComponent.m_sSfxToggleSingleEntity_On
protected

◆ m_StatesManager

SCR_StatesEditorComponent SCR_SelectionEditorUIComponent.m_StatesManager
protected

◆ m_sToggleSelectionWidgetName

string SCR_SelectionEditorUIComponent.m_sToggleSelectionWidgetName
protected

◆ m_ToggleSelectionWidget

Widget SCR_SelectionEditorUIComponent.m_ToggleSelectionWidget
protected

◆ m_UnselectedManager

SCR_BaseEditableEntityFilter SCR_SelectionEditorUIComponent.m_UnselectedManager
protected

◆ m_UnselectedState

EEditableEntityState SCR_SelectionEditorUIComponent.m_UnselectedState
protected

State in which entities are unselected.

◆ m_vCursorPosClick

vector SCR_SelectionEditorUIComponent.m_vCursorPosClick
protected

◆ m_Workspace

WorkspaceWidget SCR_SelectionEditorUIComponent.m_Workspace
protected

◆ m_World

BaseWorld SCR_SelectionEditorUIComponent.m_World
protected

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