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::Components::EditorComponentAPIComponent Class Reference

A System Component to reflect Editor operations on Components to Behavior Context. More...

#include <EditorComponentAPIComponent.h>

Inherits AZ::Component, and EditorComponentAPIBus::Handler.

Public Member Functions

 AZ_COMPONENT (EditorComponentAPIComponent, "{AC1A53C9-25BE-47D8-B9B5-60199AC73C2B}")
 
void Activate () override
 
void Deactivate () override
 
AZStd::vector< AZ::Uuid > FindComponentTypeIdsByEntityType (const AZStd::vector< AZStd::string > &componentTypeNames, EditorComponentAPIRequests::EntityType entityType) override
 
AZStd::vector< AZ::Uuid > FindComponentTypeIdsByService (const AZStd::vector< AZ::ComponentServiceType > &serviceFilter, const AZStd::vector< AZ::ComponentServiceType > &incompatibleServiceFilter) override
 
AZStd::vector< AZStd::string > FindComponentTypeNames (const AZ::ComponentTypeList &componentTypeIds) override
 
AZStd::vector< AZStd::string > BuildComponentTypeNameListByEntityType (EditorComponentAPIRequests::EntityType entityType) override
 
AddComponentsOutcome AddComponentsOfType (AZ::EntityId entityId, const AZ::ComponentTypeList &componentTypeIds) override
 
AddComponentsOutcome AddComponentOfType (AZ::EntityId entityId, const AZ::Uuid &componentTypeId) override
 
bool HasComponentOfType (AZ::EntityId entityId, AZ::Uuid componentTypeId) override
 
size_t CountComponentsOfType (AZ::EntityId entityId, AZ::Uuid componentTypeId) override
 
GetComponentOutcome GetComponentOfType (AZ::EntityId entityId, AZ::Uuid componentTypeId) override
 
GetComponentsOutcome GetComponentsOfType (AZ::EntityId entityId, AZ::Uuid componentTypeId) override
 
bool IsValid (AZ::EntityComponentIdPair componentInstance) override
 
bool EnableComponents (const AZStd::vector< AZ::EntityComponentIdPair > &componentInstances) override
 
bool IsComponentEnabled (const AZ::EntityComponentIdPair &componentInstance) override
 
bool DisableComponents (const AZStd::vector< AZ::EntityComponentIdPair > &componentInstances) override
 
bool RemoveComponents (const AZStd::vector< AZ::EntityComponentIdPair > &componentInstances) override
 
PropertyTreeOutcome BuildComponentPropertyTreeEditor (const AZ::EntityComponentIdPair &componentInstance) override
 
PropertyOutcome GetComponentProperty (const AZ::EntityComponentIdPair &componentInstance, const AZStd::string_view propertyPath) override
 
PropertyOutcome SetComponentProperty (const AZ::EntityComponentIdPair &componentInstance, const AZStd::string_view propertyPath, const AZStd::any &value) override
 
bool CompareComponentProperty (const AZ::EntityComponentIdPair &componentInstance, const AZStd::string_view propertyPath, const AZStd::any &value) override
 
const AZStd::vector< AZStd::string > BuildComponentPropertyList (const AZ::EntityComponentIdPair &componentInstance) override
 
void SetVisibleEnforcement (bool enforceVisiblity) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

A System Component to reflect Editor operations on Components to Behavior Context.


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