Game state that is active while displaying the game's options menu. More...

#include <GameStateOptionsMenu.h>

Inherits IGameState.

Public Member Functions
	AZ_CLASS_ALLOCATOR (GameStateOptionsMenu, AZ::SystemAllocator)

	AZ_RTTI (GameStateOptionsMenu,"{2441BA71-8AD2-47A1-92BB-478ED74ACE63}", IGameState)

	GameStateOptionsMenu ()=default
	Default constructor.

	~GameStateOptionsMenu () override=default
	Default destructor.

Protected Member Functions
void	OnPushed () override
	GameState::GameState::OnPushed

void	OnPopped () override
	GameState::GameState::OnPopped

void	OnEnter () override
	GameState::GameState::OnEnter

void	OnExit () override
	GameState::GameState::OnExit

virtual void	SaveGameOptionsToPersistentStorage ()
	Save game options to persistent storage, which is done upon exiting the options menu.


virtual void	LoadOptionsMenuCanvas ()

virtual void	UnloadOptionsMenuCanvas ()

virtual void	RefreshOptionsMenuCanvas ()

virtual void	SetOptionsMenuCanvasDrawOrder ()

virtual const char *	GetOptionsMenuCanvasAssetPath ()

Protected Attributes
AZStd::shared_ptr< GameOptions >	m_gameOptions
	The game options object.

AZ::EntityId	m_optionsMenuCanvasEntityId
	Id of the UI canvas being displayed.

Detailed Description

Game state that is active while displaying the game's options menu.

Member Function Documentation

void GameStateSamples::GameStateOptionsMenu::LoadOptionsMenuCanvas ( )

inlineprotectedvirtual

Convenience functions to load, unload, and refresh the options menu UI canvas.

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