Game state that is active while displaying the main game menu (or another front-end menu). More...

#include <GameStateMainMenu.h>

Inherits GameState::IGameState, and ISystemEventListener.

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

	AZ_RTTI (GameStateMainMenu, "{53EB59EC-77F1-4C8E-AC5F-B2A94F15AF31}", IGameState)

	GameStateMainMenu ()=default
	Default constructor.

	~GameStateMainMenu () 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

void	OnUpdate () override
	GameState::GameState::OnUpdate

void	OnSystemEvent (ESystemEvent event, UINT_PTR wparam, UINT_PTR lparam) override
	ISystemEventListener::OnSystemEvent

virtual void	RefreshLevelListDisplay ()
	Refresh the list of levels displayed in the main menu.

virtual void	LoadGameOptionsFromPersistentStorage ()
	Load options from persistent storage, which is done upon first entry into the main menu.


virtual void	LoadMainMenuCanvas ()

virtual void	UnloadMainMenuCanvas ()

virtual const char *	GetMainMenuCanvasAssetPath ()

Protected Attributes
AZStd::unique_ptr< GameStateLocalUserLobby >	m_localUserLobbySubState

AZ::EntityId	m_mainMenuCanvasEntityId

bool	m_shouldRefreshLevelListDisplay = false

Detailed Description

Game state that is active while displaying the main game menu (or another front-end menu).

Member Function Documentation

void GameStateSamples::GameStateMainMenu::LoadMainMenuCanvas ( )

inlineprotectedvirtual

Convenience functions to load and unload the main game menu UI canvas.

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