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::EditorEntityActionComponent Class Reference

#include <EditorEntityActionComponent.h>

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

Public Member Functions

 AZ_COMPONENT (EditorEntityActionComponent, "{2E26C7DF-544E-4A2A-8D0D-D7A6595C8BBD}")
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
AddComponentsOutcome AddComponentsToEntities (const EntityIdList &entityIds, const AZ::ComponentTypeList &componentsToAdd) override
 
AddExistingComponentsOutcome AddExistingComponentsToEntityById (const AZ::EntityId &entityId, const AZStd::vector< AZ::Component * > &componentsToAdd) override
 
RemoveComponentsOutcome RemoveComponents (const AZStd::vector< AZ::Component * > &componentsToRemove) override
 
ScrubEntitiesOutcome ScrubEntities (const EntityList &entities) override
 
void CutComponents (const AZStd::vector< AZ::Component * > &components) override
 
void CopyComponents (const AZStd::vector< AZ::Component * > &components) override
 
void PasteComponentsToEntity (AZ::EntityId entityId) override
 
bool HasComponentsToPaste () override
 
void EnableComponents (const AZStd::vector< AZ::Component * > &components) override
 
void DisableComponents (const AZStd::vector< AZ::Component * > &components) override
 
PendingComponentInfo GetPendingComponentInfo (const AZ::Component *component) override
 
AZStd::string GetComponentName (const AZ::Component *component) override
 

Detailed Description

A system component for handling component-related actions on entities

Used to perform things such as add/remove components, cut/copy/paste, etc.


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