Specifies keyboard and/or controller navigation settings.
More...
|
void | FocusFirstControl () |
| Focuses the first control.
|
|
void | CheckNavigationInput (Vector2 relativeMousePosition) |
| Checks the navigation input and updates the current control if necessary.
|
|
void | Navigate (int direction) |
| Navigates in a specified direction.
|
|
|
bool | enabled = false |
| Set true to enable keyboard/controller navigation of GUI controls.
|
|
bool | focusFirstControlOnEnable = true |
| Set true to always focus the first control when the parent is enabled.
|
|
bool | jumpToMousePosition = true |
| If the mouse hovers over a control to focus it, set this true<c/c> to jump the current focus to that control.
|
|
GUIControl[] | order |
| The list of child controls that can be navigated.
|
|
string | clickButton = "Fire1" |
| The button used to click the current control.
|
|
KeyCode | click = KeyCode.Space |
| The key used to click the current control.
|
|
KeyCode | previous = KeyCode.UpArrow |
| The key used to navigate to the previous control.
|
|
KeyCode | next = KeyCode.DownArrow |
| The key used to navigate to the next control.
|
|
string | axis = "Vertical" |
| The controller axis that controls navigation.
|
|
bool | invertAxis = true |
|
float | axisRepeatDelay = 1f |
| When holding the axis in a direction, the amount of time between navigating to the next/previous control.
|
|
float | mouseWheelSensitivity = 5f |
|
Specifies keyboard and/or controller navigation settings.
◆ CheckNavigationInput()
void PixelCrushers.DialogueSystem.UnityGUI.Navigation.CheckNavigationInput |
( |
Vector2 |
relativeMousePosition | ) |
|
|
inline |
Checks the navigation input and updates the current control if necessary.
◆ FocusFirstControl()
void PixelCrushers.DialogueSystem.UnityGUI.Navigation.FocusFirstControl |
( |
| ) |
|
|
inline |
Focuses the first control.
◆ Navigate()
void PixelCrushers.DialogueSystem.UnityGUI.Navigation.Navigate |
( |
int |
direction | ) |
|
|
inline |
Navigates in a specified direction.
- Parameters
-
direction | Direction (-1/+1). |
◆ axis
string PixelCrushers.DialogueSystem.UnityGUI.Navigation.axis = "Vertical" |
The controller axis that controls navigation.
◆ axisRepeatDelay
float PixelCrushers.DialogueSystem.UnityGUI.Navigation.axisRepeatDelay = 1f |
When holding the axis in a direction, the amount of time between navigating to the next/previous control.
◆ click
KeyCode PixelCrushers.DialogueSystem.UnityGUI.Navigation.click = KeyCode.Space |
The key used to click the current control.
◆ clickButton
string PixelCrushers.DialogueSystem.UnityGUI.Navigation.clickButton = "Fire1" |
The button used to click the current control.
◆ enabled
bool PixelCrushers.DialogueSystem.UnityGUI.Navigation.enabled = false |
Set true
to enable keyboard/controller navigation of GUI controls.
◆ focusFirstControlOnEnable
bool PixelCrushers.DialogueSystem.UnityGUI.Navigation.focusFirstControlOnEnable = true |
Set true
to always focus the first control when the parent is enabled.
◆ invertAxis
bool PixelCrushers.DialogueSystem.UnityGUI.Navigation.invertAxis = true |
◆ jumpToMousePosition
bool PixelCrushers.DialogueSystem.UnityGUI.Navigation.jumpToMousePosition = true |
If the mouse hovers over a control to focus it, set this true<c/c> to jump the current focus to that control.
◆ mouseWheelSensitivity
float PixelCrushers.DialogueSystem.UnityGUI.Navigation.mouseWheelSensitivity = 5f |
◆ next
KeyCode PixelCrushers.DialogueSystem.UnityGUI.Navigation.next = KeyCode.DownArrow |
The key used to navigate to the next control.
◆ order
GUIControl [] PixelCrushers.DialogueSystem.UnityGUI.Navigation.order |
The list of child controls that can be navigated.
You must set populate this list or navigation won't work.
◆ previous
KeyCode PixelCrushers.DialogueSystem.UnityGUI.Navigation.previous = KeyCode.UpArrow |
The key used to navigate to the previous control.
◆ FocusedControlName
string PixelCrushers.DialogueSystem.UnityGUI.Navigation.FocusedControlName |
|
get |
Gets the name of the control that should currently have focus.
The name of the focused control.
◆ IsClicked
bool PixelCrushers.DialogueSystem.UnityGUI.Navigation.IsClicked |
|
get |
The documentation for this class was generated from the following file:
- C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Legacy/GUI Controls/Tools/Navigation.cs