Menu
Lumberyard
C++ API Reference (Version 1.10)

AzFramework Namespace Reference

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

Classes

class EntityContextEvents
Interface for the AzFramework::EntityContextEventBus , which is the EBus that dispatches notification events from the global entity context. More...
class EntityContextRequests
Interface for AzFramework::EntityContextRequestBus , which is the EBus that makes requests to a given entity context. More...
class EntityIdContextQueries
Interface for AzFramework::EntityIdContextQueryBus , which is the EBus that queries an entity about its context. More...
class GameEntityContextEvents
Interface for the AzFramework::GameEntityContextEventBus , which is the EBus that dispatches notification events from the game entity context. More...
class GameEntityContextRequests
Interface for AzFramework::GameEntityContextRequestBus , which is the EBus that makes requests to the game entity context. More...
class SliceInstantiationResults
Interface for AzFramework::SliceInstantiationResultBus , which enables you to receive results regarding your slice instantiation requests. More...
class SliceInstantiationTicket
Identifies an asynchronous slice instantiation request. More...

Typedefs

using EntityContextId = AZ::Uuid
Unique ID for an entity context. More...
using EntityContextRequestBus = AZ::EBus < EntityContextRequests >
The EBus for requests to the entity context. More...
using EntityContextEventBus = AZ::EBus < EntityContextEvents >
The EBus for entity context events. More...
using EntityIdContextQueryBus = AZ::EBus < EntityIdContextQueries >
The EBus for querying an entity about its context. More...
using SliceInstantiationResultBus = AZ::EBus < SliceInstantiationResults >
The EBus that notifies you about the results of your slice instantiation requests. More...
using GameEntityContextRequestBus = AZ::EBus < GameEntityContextRequests >
The EBus for requests to the game entity context. More...
using GameEntityContextEventBus = AZ::EBus < GameEntityContextEvents >
The EBus for game entity context events. More...

Typedef Documentation

EntityContextEventBus

The EBus for entity context events.

The events are defined in the AzFramework::EntityContextEvents class. If you want to receive event notifications from a specific entity context, such as the game entity context, use the bus specific to that context. If you want to receive event notifications from multiple types of entity contexts, use this bus.

EntityContextId

using AzFramework::EntityContextId = typedef AZ::Uuid

Unique ID for an entity context.

EntityContextRequestBus

The EBus for requests to the entity context.

The events are defined in the AzFramework::EntityContextRequests class. If you want to make requests to a specific entity context, such as the game entity context, use the bus specific to that context. If you want to make requests to multiple types of entity contexts, use this bus.

EntityIdContextQueryBus

The EBus for querying an entity about its context.

The events are defined in the AzFramework::EntityIdContextQueries class.

GameEntityContextEventBus

The EBus for game entity context events.

The events are defined in the AzFramework::GameEntityContextEvents class.

GameEntityContextRequestBus

The EBus for requests to the game entity context.

The events are defined in the AzFramework::GameEntityContextRequests class.

SliceInstantiationResultBus

The EBus that notifies you about the results of your slice instantiation requests.

The events are defined in the AzFramework::SliceInstantiationResults class.