Open 3D Engine GameStateSamples Gem API Reference  24.09
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::GameStateLevelRunning Class Reference

Game state that is active while the game is running. More...

#include <GameStateLevelRunning.h>

Inherits GameState::IGameState, AzFramework::InputChannelEventListener, AzFramework::ApplicationLifecycleEvents::Bus::Handler, and ISystemEventListener.

Public Member Functions

 AZ_CLASS_ALLOCATOR (GameStateLevelRunning, AZ::SystemAllocator)
 
 AZ_RTTI (GameStateLevelRunning, "{93501205-D39D-4E91-B93C-1E16EFAEEB43}", IGameState)
 
 GameStateLevelRunning ()=default
 Default constructor.
 
 ~GameStateLevelRunning () 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
 
void OnApplicationConstrained (AzFramework::ApplicationLifecycleEvents::Event) override
 AzFramework::ApplicationLifecycleEvents::OnApplicationConstrained
 
void OnSystemEvent (ESystemEvent event, UINT_PTR wparam, UINT_PTR lparam) override
 ISystemEventListener::OnSystemEvent
 
virtual void PushLevelPausedGameState ()
 
virtual void LoadPauseButtonCanvas ()
 
virtual void UnloadPauseButtonCanvas ()
 
virtual const char * GetPauseButtonCanvasAssetPath ()
 

Protected Attributes

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

Detailed Description

Game state that is active while the game is running.

Member Function Documentation

◆ LoadPauseButtonCanvas()

void GameStateSamples::GameStateLevelRunning::LoadPauseButtonCanvas ( )
inlineprotectedvirtual

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

◆ PushLevelPausedGameState()

void GameStateSamples::GameStateLevelRunning::PushLevelPausedGameState ( )
inlineprotectedvirtual

Convenience function to push the default level paused game state. Override if you wish to push a different level paused game state.

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