Menu
Lumberyard
C++ API Reference (Version 1.10)

Entity API Reference

An entity is an addressable container for a group of components. This page links to Lumberyard C++ API documentation that is useful when working with entities.

Header Files

Entity.h
Header file for the Entity class.
EntityBus.h
Header file for buses that dispatch notification events concerning the AZ::Entity class.
EntityContextBus.h
Header file for buses that dispatch and receive events from an entity context.
EntityId.h
Header file for the entity ID type.
GameEntityContextBus.h
Header file for buses that dispatch and receive events from the game entity context.
TransformBus.h
Header file for buses that dispatch and receive events related to positioning, rotating, scaling, and parenting an entity.

Classes/Structs

Entity
An addressable container for a group of components.
EntityContextEvents
Interface for the AzFramework::EntityContextEventBus, which is the EBus that dispatches notification events from the global entity context.
EntityContextRequests
Interface for AzFramework::EntityContextRequestBus, which is the EBus that makes requests to a given entity context.
EntityEvents
Interface for the AZ::EntityBus, which is the EBus for notification events dispatched by a specific entity.
EntityId
Entity ID type.
EntityIdContextQueries
Interface for AzFramework::EntityIdContextQueryBus, which is the EBus that queries an entity about its context.
EntitySystemEvents
Interface for the AZ::EntitySystemBus, which is the EBus that dispatches notification events about every entity in the system.
GameEntityContextEvents
Interface for the AzFramework::GameEntityContextEventBus, which is the EBus that dispatches notification events from the game entity context.
GameEntityContextRequests
Interface for AzFramework::GameEntityContextRequestBus, which is the EBus that makes requests to the game entity context.
SliceInstantiationResults
Interface for AzFramework::SliceInstantiationResultBus, which enables you to receive results regarding your slice instantiation requests.
SliceInstantiationTicket
Identifies an asynchronous slice instantiation request.
TransformInterface
Interface for AZ::TransformBus, which is an EBus that receives requests to translate (position), rotate, and scale an entity in 3D space.
TransformNotification
Interface for AZ::TransformNotificationBus, which is the EBus that dispatches transform changes to listeners.

Macros

ToolsTransformComponentTypeId
The type ID of AzToolsFramework::Components::TransformComponent, which is the TransformComponent used by the editor.