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 | Static Public Attributes | List of all members
GameState::GameStateNotifications Class Reference

EBus interface used to listen for notifications related to game state management/transitions. More...

#include <GameStateNotificationBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual void OnActiveGameStateChanged (AZStd::shared_ptr< IGameState > oldGameState, AZStd::shared_ptr< IGameState > newGameState)
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 EBus Trait: game state notifications are addressed to a single address.
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 EBus Trait: game state notifications can be handled by multiple listeners.
 

Detailed Description

EBus interface used to listen for notifications related to game state management/transitions.

Member Function Documentation

◆ OnActiveGameStateChanged()

virtual void GameState::GameStateNotifications::OnActiveGameStateChanged ( AZStd::shared_ptr< IGameState >  oldGameState,
AZStd::shared_ptr< IGameState >  newGameState 
)
inlinevirtual

Called when a game state transition occurs

Parameters
[in]oldGameStateThe old game state we are transitioning from (can be null)
[in]newGameStateThe new game state we are transitioning into (can be null)
The documentation for this class was generated from the following file: