[Serializable]
public struct Navigation : IEquatable<Navigation>
Properties defaultNavigation
Return a Navigation with sensible default values.
Declarationpublic static Navigation defaultNavigation { get; }
Property Value Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.
public class ExampleClass : MonoBehaviour
{
public Button button;
void Start()
{
//Set the navigation to the default value. ("Automatic" is the default value).
button.navigation = Navigation.defaultNavigation;
}
}
mode
Navigation mode.
Declarationpublic Navigation.Mode mode { get; set; }
Property Value selectOnDown
Specify a Selectable UI GameObject to highlight when the down arrow key is pressed.
Declarationpublic Selectable selectOnDown { get; set; }
Property Value Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
// get the Navigation data
Navigation navigation = btnLoad.navigation;
// switch mode to Explicit to allow for custom assigned behavior
navigation.mode = Navigation.Mode.Explicit;
// highlight the Save button if the down arrow key is pressed
navigation.selectOnDown = btnSave;
// reassign the struct data to the button
btnLoad.navigation = navigation;
}
}
selectOnLeft
Specify a Selectable UI GameObject to highlight when the left arrow key is pressed.
Declarationpublic Selectable selectOnLeft { get; set; }
Property Value Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
// get the Navigation data
Navigation navigation = btnLoad.navigation;
// switch mode to Explicit to allow for custom assigned behavior
navigation.mode = Navigation.Mode.Explicit;
// highlight the Save button if the left arrow key is pressed
navigation.selectOnLeft = btnSave;
// reassign the struct data to the button
btnLoad.navigation = navigation;
}
}
selectOnRight
Specify a Selectable UI GameObject to highlight when the right arrow key is pressed.
Declarationpublic Selectable selectOnRight { get; set; }
Property Value Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
// get the Navigation data
Navigation navigation = btnLoad.navigation;
// switch mode to Explicit to allow for custom assigned behavior
navigation.mode = Navigation.Mode.Explicit;
// highlight the Save button if the right arrow key is pressed
navigation.selectOnRight = btnSave;
// reassign the struct data to the button
btnLoad.navigation = navigation;
}
}
selectOnUp
Specify a Selectable UI GameObject to highlight when the Up arrow key is pressed.
Declarationpublic Selectable selectOnUp { get; set; }
Property Value Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
// get the Navigation data
Navigation navigation = btnLoad.navigation;
// switch mode to Explicit to allow for custom assigned behavior
navigation.mode = Navigation.Mode.Explicit;
// highlight the Save button if the up arrow key is pressed
navigation.selectOnUp = btnSave;
// reassign the struct data to the button
btnLoad.navigation = navigation;
}
}
wrapAround
Enables navigation to wrap around from last to first or first to last element. Will find the furthest element from the current element in the opposite direction of movement.
Declarationpublic bool wrapAround { get; set; }
Property Value Examples
Note: If you have a grid of elements and you are on the last element in a row it will not wrap over to the next row it will pick the furthest element in the opposite direction.
Methods Equals(Navigation) Declarationpublic bool Equals(Navigation other)
Parameters Returns Implements
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4