top of page

ProMenuStateController

This manages specific GUI objects to make sure they are revealed or hidden when menu states change.

Events

StateControllerInitialized

This is called when the ProMenuStateController finishes initializing, which includes creating all animations and setting default states.

Properties

Canvas

The canvas being used by this state controller.

CanvasParent

The parent of this gameObject when it is on the canvas.

ProSiblingIndexer

The ProSiblingIndexer attached to this gameObject.

MenuMachine

The MenuMachine assigned to this state controller.

VisibleStates

The complete list of states in which this object is visible.

Status

The status of this object can be hidden, hiding, revealing, shown, paused hiding, or paused revealing.
 

CurrentAnimation

The current animation being used.

CurrentState

The current menu state.

InitializationComplete

Returns true if initialization completed, false otherwise.

Methods

SetAnimations

Creates the animations that will be used by this object on menu changes.

PlaceObjectOnCanvas

Places the object on the canvas with its assigned location and other settings.

PlaceObjectMenuManager

Places the object under the menu manager. This is where objects go when the menu is in a state not assigned to them.

ChangeState

Changes the menu state assigned to this state controller.

Skip

Skips the current animation.

Show

Calls for the gameObject to animate into the canvas.

Hide

Calls for the gameObject to animate out of the canvas.

ReturnEntryAnimation

Returns the entry animation used by a state.

ReturnExitAnimation

Returns the exit animation used by a state.

IsVisible

Returns true if the gameObject is currently on the canvas, and false if it is hidden away on the menu manager.

bottom of page