Otter  0.9.88
2d Game Development Framework based on SFML.Net
 All Classes Namespaces Functions Variables Enumerations Properties
Otter.UI.UIGridMenu Class Reference

OTTER UI IS NOT SUPPORTED YET. ACTIVELY IN DEVELOPMENT, USE AT YOUR OWN RISK! Grid-based UIMenu designed to be navigated by a controller with button input. More...

Inherits Otter.UI.UIMenu.

Public Member Functions

 UIGridMenu (int menuWidth=1)
 
override void HandleInput (UIManager manager)
 Handle input from a manager if this element is active. More...
 
override void Triggered ()
 
override void Canceled ()
 
override void UpdateMenuPositions ()
 Update the positions of the menu items. More...
 
override void Update ()
 
- Public Member Functions inherited from Otter.UI.UIMenu
AddMenuItem< T > (T menuItem)
 Add a menu item to the menu. More...
 
List< UIElementAddMenuItems (params UIElement[] menuItems)
 Add multiple menu items to the menu. More...
 
virtual void ItemSwitched ()
 Called when the user has switched the currently selected item. More...
 
override void Canceled ()
 
override void Update ()
 
virtual void CancelAndDeactivate (UIManager manager)
 A shortcut to cancel and deactivate the menu. More...
 
virtual void TriggerAndDeactivate (UIManager manager)
 A shortcut to trigger and deactivate the menu. More...
 
override void Render ()
 
- Public Member Functions inherited from Otter.UI.UIElement
void Highlight ()
 
void Dim ()
 
void Summon ()
 
void Dismiss ()
 
void Trigger ()
 
void Cancel ()
 
Graphic AddGraphic (Graphic g)
 
List< GraphicAddGraphics (params Graphic[] graphics)
 
AddElement< T > (T uielement)
 
List< UIElementAddElements (params UIElement[] uielements)
 
RemoveElement< T > (T uielement)
 
virtual void Highlighted ()
 
virtual void Dimmed ()
 
virtual void Enabled ()
 
virtual void Disabled ()
 
virtual void Dismissed ()
 
virtual void Summoned ()
 
virtual void Activated ()
 
virtual void Deactivated ()
 
virtual void Enable ()
 
virtual void Disable ()
 

Public Attributes

GridCounter MenuGrid
 
int MenuWidth = 0
 
int XSpacing = 0
 
- Public Attributes inherited from Otter.UI.UIMenu
bool Cancelable = false
 If the UIMenu can be canceled by the UIManager or not. Default to false for the base menu. More...
 
- Public Attributes inherited from Otter.UI.UIElement
int InputStartUp = 0
 How many frames to wait before accepting input. Use this to prevent accidental double inputs. More...
 
List< UIElementElements = new List<UIElement>()
 
bool Visible = true
 
bool UseMouse = false
 
Action OnTrigger
 
int Width = 0
 
bool InheritHighlight = false
 

Properties

override UIElement CurrentMenuItem [get]
 
override UIElement LastMenuItem [get]
 
- Properties inherited from Otter.UI.UIMenu
List< UIElementMenuItems [get, set]
 
UIElement this[int index] [get]
 Get a menu item from the menu. More...
 
virtual UIElement CurrentMenuItem [get]
 The currently selected menu item. More...
 
virtual UIElement LastMenuItem [get]
 The last menu item in the list. More...
 
- Properties inherited from Otter.UI.UIElement
UIManager Manager [get, set]
 
UIElement Parent [get, set]
 
virtual float X [get, set]
 
virtual float Y [get, set]
 
int UIDepth [get, set]
 
bool IsEnabled [get, set]
 

Detailed Description

OTTER UI IS NOT SUPPORTED YET. ACTIVELY IN DEVELOPMENT, USE AT YOUR OWN RISK! Grid-based UIMenu designed to be navigated by a controller with button input.

Member Function Documentation

override void Otter.UI.UIGridMenu.HandleInput ( UIManager  manager)
virtual

Handle input from a manager if this element is active.

Parameters
manager

Reimplemented from Otter.UI.UIElement.

override void Otter.UI.UIGridMenu.UpdateMenuPositions ( )
virtual

Update the positions of the menu items.

Reimplemented from Otter.UI.UIMenu.


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