Open 3D Engine AzToolsFramework 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.
AzToolsFramework::EditorLevelComponentAPIRequests Class Referenceabstract

#include <EditorLevelComponentAPIBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual EditorComponentAPIRequests::AddComponentsOutcome AddComponentsOfType (const AZ::ComponentTypeList &componentTypeIds)=0
 Add Components of the given types to an Entity.
 
virtual bool HasComponentOfType (AZ::Uuid componentTypeId)=0
 Returns true if a Component of type provided can be found on the Level Entity, false otherwise.
 
virtual size_t CountComponentsOfType (AZ::Uuid componentTypeId)=0
 Count Components of type provided on the Level Entity.
 
virtual EditorComponentAPIRequests::GetComponentOutcome GetComponentOfType (AZ::Uuid componentTypeId)=0
 Gets the first Component of type that is attached to the Level Entity.
 
virtual EditorComponentAPIRequests::GetComponentsOutcome GetComponentsOfType (AZ::Uuid componentTypeId)=0
 Get all Components of type that are attached to the Level Entity.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Detailed Description

Exposes the Editor Component CRUD API for the singleton Entity of the current level; it is exposed to Behavior Context for Editor Scripting. Use EditorComponentAPIBus For methods that require AZ::EntityComponentIDPairs as input.


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