Highroad Engine v1.3
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.Tools.MMDebugMenu Class Reference

A debug menu helper, meant to help create quick mobile friendly debug menus More...

Inheritance diagram for MoreMountains.Tools.MMDebugMenu:

Public Types

enum  ToggleDirections { TopToBottom , LeftToRight , RightToLeft , BottomToTop }
 the possible directions for the menu to appear More...
 

Public Member Functions

virtual void FillMenu (bool triggerEvents=false)
 Fills the menu based on the data's contents More...
 
virtual void OpenMenu ()
 Makes the menu appear More...
 
virtual void CloseMenu ()
 Makes the menu disappear More...
 
virtual void ToggleMenu ()
 Closes or opens the menu depending on its current state More...
 

Public Attributes

MMDebugMenuData Data
 the scriptable object containing the menu's data More...
 
CanvasGroup MenuContainer
 the container of the whole menu More...
 
RectTransform Contents
 the scrolling contents More...
 
Image MenuBackground
 the menu's background image More...
 
Image CloseIcon
 the icon used to close the menu More...
 
RectTransform TabBar
 the tab bar (where the tab buttons go) More...
 
RectTransform TabContainer
 the tab contents container (where the contents of the page will go) More...
 
MMDebugMenuTabManager TabManager
 the tab manager More...
 
Image MMLogo
 the MoreMountains logo More...
 
UnityEvent OnOpenEvent
 an event to call when the menu opens More...
 
UnityEvent OnCloseEvent
 an event to call when the menu closes More...
 
bool Active = false
 whether or not this menu is active at this moment More...
 
bool ToggleButton
 a test button to toggle the menu More...
 

Protected Member Functions

virtual void Start ()
 On Start we init our menu More...
 
virtual void Initialization ()
 Prepares transitions and grabs components More...
 
virtual void FillTab (MMDebugMenuTabContents tab, int index, bool triggerEvents=false)
 
virtual IEnumerator ToggleCo (bool active)
 A coroutine used to toggle the menu More...
 
virtual void Update ()
 On update we handle our input More...
 
virtual void HandleInput ()
 Looks for shortcut input More...
 

Protected Attributes

RectTransform _containerRect
 
Vector3 _initialContainerPosition
 
Vector3 _offPosition
 
Vector3 _newPosition
 
bool _toggling = false
 

Detailed Description

A debug menu helper, meant to help create quick mobile friendly debug menus

Member Enumeration Documentation

◆ ToggleDirections

enum MoreMountains.Tools.MMDebugMenu.ToggleDirections

the possible directions for the menu to appear

Enumerator
TopToBottom 
LeftToRight 
RightToLeft 
BottomToTop 

Member Function Documentation

◆ CloseMenu()

virtual void MoreMountains.Tools.MMDebugMenu.CloseMenu ( )
virtual

Makes the menu disappear

◆ FillMenu()

virtual void MoreMountains.Tools.MMDebugMenu.FillMenu ( bool  triggerEvents = false)
virtual

Fills the menu based on the data's contents

◆ FillTab()

virtual void MoreMountains.Tools.MMDebugMenu.FillTab ( MMDebugMenuTabContents  tab,
int  index,
bool  triggerEvents = false 
)
protectedvirtual

◆ HandleInput()

virtual void MoreMountains.Tools.MMDebugMenu.HandleInput ( )
protectedvirtual

Looks for shortcut input

◆ Initialization()

virtual void MoreMountains.Tools.MMDebugMenu.Initialization ( )
protectedvirtual

Prepares transitions and grabs components

◆ OpenMenu()

virtual void MoreMountains.Tools.MMDebugMenu.OpenMenu ( )
virtual

Makes the menu appear

◆ Start()

virtual void MoreMountains.Tools.MMDebugMenu.Start ( )
protectedvirtual

On Start we init our menu

◆ ToggleCo()

virtual IEnumerator MoreMountains.Tools.MMDebugMenu.ToggleCo ( bool  active)
protectedvirtual

A coroutine used to toggle the menu

Parameters
active
Returns

◆ ToggleMenu()

virtual void MoreMountains.Tools.MMDebugMenu.ToggleMenu ( )
virtual

Closes or opens the menu depending on its current state

◆ Update()

virtual void MoreMountains.Tools.MMDebugMenu.Update ( )
protectedvirtual

On update we handle our input

Member Data Documentation

◆ _containerRect

RectTransform MoreMountains.Tools.MMDebugMenu._containerRect
protected

◆ _initialContainerPosition

Vector3 MoreMountains.Tools.MMDebugMenu._initialContainerPosition
protected

◆ _newPosition

Vector3 MoreMountains.Tools.MMDebugMenu._newPosition
protected

◆ _offPosition

Vector3 MoreMountains.Tools.MMDebugMenu._offPosition
protected

◆ _toggling

bool MoreMountains.Tools.MMDebugMenu._toggling = false
protected

◆ Active

bool MoreMountains.Tools.MMDebugMenu.Active = false

whether or not this menu is active at this moment

◆ CloseIcon

Image MoreMountains.Tools.MMDebugMenu.CloseIcon

the icon used to close the menu

◆ Contents

RectTransform MoreMountains.Tools.MMDebugMenu.Contents

the scrolling contents

◆ Data

MMDebugMenuData MoreMountains.Tools.MMDebugMenu.Data

the scriptable object containing the menu's data

◆ MenuBackground

Image MoreMountains.Tools.MMDebugMenu.MenuBackground

the menu's background image

◆ MenuContainer

CanvasGroup MoreMountains.Tools.MMDebugMenu.MenuContainer

the container of the whole menu

◆ MMLogo

Image MoreMountains.Tools.MMDebugMenu.MMLogo

the MoreMountains logo

◆ OnCloseEvent

UnityEvent MoreMountains.Tools.MMDebugMenu.OnCloseEvent

an event to call when the menu closes

◆ OnOpenEvent

UnityEvent MoreMountains.Tools.MMDebugMenu.OnOpenEvent

an event to call when the menu opens

◆ TabBar

RectTransform MoreMountains.Tools.MMDebugMenu.TabBar

the tab bar (where the tab buttons go)

◆ TabContainer

RectTransform MoreMountains.Tools.MMDebugMenu.TabContainer

the tab contents container (where the contents of the page will go)

◆ TabManager

MMDebugMenuTabManager MoreMountains.Tools.MMDebugMenu.TabManager

the tab manager

◆ ToggleButton

bool MoreMountains.Tools.MMDebugMenu.ToggleButton

a test button to toggle the menu

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.2