Open 3D Engine GameStateSamples Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GameStateSamples::GameStateLevelPaused Class Reference

Game state that is active while gameplay is paused. More...

#include <GameStateLevelPaused.h>

Inherits GameState::IGameState, and AzFramework::InputChannelEventListener.

Public Member Functions

 AZ_CLASS_ALLOCATOR (GameStateLevelPaused, AZ::SystemAllocator)
 
 AZ_RTTI (GameStateLevelPaused, "{6CAA4810-AA67-4A96-BB23-3EFA4BCCBF12}", IGameState)
 
 GameStateLevelPaused ()=default
 Default constructor.
 
 ~GameStateLevelPaused () 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
 
AZ::s32 GetPriority () const override
 AzFramework::InputChannelEventListener::GetPriority
 
bool OnInputChannelEventFiltered (const AzFramework::InputChannel &inputChannel) override
 AzFramework::InputChannelEventListener::OnInputChannelEventFiltered
 
virtual void LoadPauseMenuCanvas ()
 
virtual void UnloadPauseMenuCanvas ()
 
virtual void SetPauseMenuCanvasDrawOrder ()
 
virtual const char * GetPauseMenuCanvasAssetPath ()
 
virtual void PauseGame ()
 
virtual void UnpauseGame ()
 

Protected Attributes

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

Detailed Description

Game state that is active while gameplay is paused.

Member Function Documentation

◆ LoadPauseMenuCanvas()

void GameStateSamples::GameStateLevelPaused::LoadPauseMenuCanvas ( )
inlineprotectedvirtual

Convenience functions to load and unload the pause menu UI canvas.

◆ PauseGame()

void GameStateSamples::GameStateLevelPaused::PauseGame ( )
inlineprotectedvirtual

Convenience functions to pause and unpause the game.

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