Open 3D Engine AzFramework 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.
AzFramework::GameEntityContextEvents Class Reference

#include <GameEntityContextBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual ~GameEntityContextEvents ()=default
 
virtual void OnPreGameEntitiesStarted ()
 
virtual void OnGameEntitiesStarted ()
 
virtual void OnGameEntitiesReset ()
 

Detailed Description

Interface for the AzFramework::GameEntityContextEventBus, which is the EBus that dispatches notification events from the game entity context. The game entity context holds gameplay entities, as opposed to system entities, editor entities, and so on.

Constructor & Destructor Documentation

◆ ~GameEntityContextEvents()

virtual AzFramework::GameEntityContextEvents::~GameEntityContextEvents ( )
virtualdefault

Destroys the instance of the class.

Member Function Documentation

◆ OnGameEntitiesReset()

virtual void AzFramework::GameEntityContextEvents::OnGameEntitiesReset ( )
inlinevirtual

Signals that the game entity context is shut down or reset. This is equivalent to the end of a level. This event will be valid even if the concept of levels is eradicated. In that case, its meaning will vary depending on how and if the game uses the game entity context.

◆ OnGameEntitiesStarted()

virtual void AzFramework::GameEntityContextEvents::OnGameEntitiesStarted ( )
inlinevirtual

Signals that the game entity context is loaded and activated, which happens at the
start of a level. If the concept of levels is eradicated, this event will be removed.

◆ OnPreGameEntitiesStarted()

virtual void AzFramework::GameEntityContextEvents::OnPreGameEntitiesStarted ( )
inlinevirtual

Signals that the game entity context is about to be loaded and activated, which happens at the start of a level. If the concept of levels is eradicated, this event will be removed.


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