unity-menustack  0.1.0
A way to track unity menu navigation that doesn't suck too much
Public Member Functions | Public Attributes | List of all members
MenuStack.Animation.MenuAnimator Class Reference

Allows configuration of menu animations More...

Inheritance diagram for MenuStack.Animation.MenuAnimator:

Public Member Functions

IEnumerator OpenAsync ()
 Opens the menu, using the underlying animator More...
 
IEnumerator CloseAsync ()
 Closes the menu, using the underlying animator More...
 

Public Attributes

string OpenStateName = "Open"
 The menu open animator state name, in the underlying animator More...
 
string CloseStateName = "Close"
 The menu close animator state name, in the underlying animator More...
 
int AnimationLayer = 0
 The layer in which menu animation is defined, in the underlying animator More...
 
string DefaultStateName = null
 The default state to use in the underlying animator More...
 

Detailed Description

Allows configuration of menu animations

Member Function Documentation

◆ CloseAsync()

IEnumerator MenuStack.Animation.MenuAnimator.CloseAsync ( )

Closes the menu, using the underlying animator

This method doesn't async complete until the animation (and motion) is complete

Returns
async operation result

◆ OpenAsync()

IEnumerator MenuStack.Animation.MenuAnimator.OpenAsync ( )

Opens the menu, using the underlying animator

This method doesn't async complete until the animation (and motion) is complete

Returns
async operation result

Member Data Documentation

◆ AnimationLayer

int MenuStack.Animation.MenuAnimator.AnimationLayer = 0

The layer in which menu animation is defined, in the underlying animator

◆ CloseStateName

string MenuStack.Animation.MenuAnimator.CloseStateName = "Close"

The menu close animator state name, in the underlying animator

◆ DefaultStateName

string MenuStack.Animation.MenuAnimator.DefaultStateName = null

The default state to use in the underlying animator

If this is left unset, we'll determine at runtime if we should start in OpenStateName or CloseStateName

◆ OpenStateName

string MenuStack.Animation.MenuAnimator.OpenStateName = "Open"

The menu open animator state name, in the underlying animator


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