Controller that handles the transition in and out of the main menu. A better name for this class probably should have been UIMainMenuController. More...

Inheritance diagram for UIMenuController:

[legend]

Collaboration diagram for UIMenuController:

[legend]

Public Member Functions
void	Awake ()
	Initialize references needed. More...

void	RemoveMenu (UITransition.AnimationFinishedCallback callback)
	Start to transition out the menu items. More...

Public Attributes
EventManager.EventType []	eventsToDeactivateOn

UIKeyboardController	keyboardController

EventManager.EventType	eventToShowOn

bool	defaultActive

float	transitionTime

float []	transitionWaitTimes

UITransition []	childTransitions

UIKeyboardControllerContextManager.UIKeyboardControllerContextName	contextName

Detailed Description

Controller that handles the transition in and out of the main menu. A better name for this class probably should have been UIMainMenuController.

Member Function Documentation

◆ Awake()

void UIMenuController.Awake ( )

Initialize references needed.

◆ RemoveMenu()

void UIMenuController.RemoveMenu ( UITransition.AnimationFinishedCallback callback )

Start to transition out the menu items.

Parameters

callback Method to call when all childReansitions are finished their animations.

Member Data Documentation

◆ childTransitions

UITransition [] UIMenuController.childTransitions

All the children that need should be tranisitioned. There should be a UITransition object for every wait time in the transitionWaitTimes array.

◆ contextName

UIKeyboardControllerContextManager.UIKeyboardControllerContextName UIMenuController.contextName

The context name of the menu.

◆ defaultActive

bool UIMenuController.defaultActive

At the start of the game all UI elements start active and then turn off if they are not needed. This is true if it should stay active the first frame of the game.

◆ eventsToDeactivateOn

EventManager.EventType [] UIMenuController.eventsToDeactivateOn

The list of events to remove the menu.

◆ eventToShowOn

EventManager.EventType UIMenuController.eventToShowOn

The list of events to show the menu.

◆ keyboardController

UIKeyboardController UIMenuController.keyboardController

The keyboard controller used when the main menu is active.

◆ transitionTime

float UIMenuController.transitionTime

The amount of time it should take for the menu item to swing into action.

◆ transitionWaitTimes

float [] UIMenuController.transitionWaitTimes

The cascading offset to wait before the text object should transition.

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

Assets/Scripts/UI/UIMenuController.cs

Public Member Functions

Public Attributes