Open 3D Engine GameState 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 | Friends | List of all members
GameState::IGameState Class Reference

Base class for all game states. More...

#include <GameState.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (IGameState, AZ::SystemAllocator)
 
 AZ_RTTI (IGameState, "{AF3F218C-37E0-4351-86EC-03B9BA49C5C7}")
 
 IGameState ()=default
 Default constructor.
 
virtual ~IGameState ()=default
 Default destructor.
 

Protected Member Functions

virtual void OnPushed ()
 Called when this game state is pushed onto the stack.
 
virtual void OnPopped ()
 Called when this game state is popped from the stack.
 
virtual void OnEnter ()
 Called when this game state is set as the active game state.
 
virtual void OnExit ()
 Called when this game state is replaced as the active game state.
 
virtual void OnUpdate ()
 Called each frame while this game state is the active game state.
 

Friends

class GameStateSystemComponent
 

Detailed Description

Base class for all game states.

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