Open 3D Engine ScriptCanvasDeveloper Gem 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.
Public Types | Public Member Functions | Protected Member Functions | List of all members
ScriptCanvas::Developer::CreateGroupAction Class Reference

#include <CreateElementsActions.h>

Inherits ScriptCanvas::Developer::CompoundAction, and GraphCanvas::SceneNotificationBus::Handler.

Public Types

enum class  CreationType { Toolbar , Hotkey }
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (CreateGroupAction, AZ::SystemAllocator)
 
 AZ_RTTI (CreateGroupAction, "{853F34EB-F8AB-47E3-A601-35091DC23E11}", CompoundAction)
 
 CreateGroupAction (GraphCanvas::EditorId editorGraph, GraphCanvas::GraphId graphId, CreationType creationType=CreationType::Hotkey)
 
void SetupAction () override
 
void OnNodeAdded (const AZ::EntityId &groupId, bool isPaste=false) override
 
AZ::EntityId GetCreatedGroupId () const
 
ActionReport GenerateReport () const override
 
- Public Member Functions inherited from ScriptCanvas::Developer::CompoundAction
 AZ_CLASS_ALLOCATOR (CompoundAction, AZ::SystemAllocator)
 
 AZ_RTTI (CompoundAction, "{3F9A5736-111C-4D49-A3D5-BA3484D74F4D}", EditorAutomationAction)
 
void SetupAction () override
 
bool Tick () override
 
void AddAction (EditorAutomationAction *action)
 
ActionReport GenerateReport () const override
 
- Public Member Functions inherited from ScriptCanvas::Developer::EditorAutomationAction
 AZ_CLASS_ALLOCATOR (EditorAutomationAction, AZ::SystemAllocator)
 
bool IsAtPreconditionLimit () const
 
virtual bool IsMissingPrecondition ()
 
void ResetPreconditionAttempts ()
 
EditorAutomationAction * GenerationPreconditionActions ()
 
void SignalActionBegin ()
 
virtual bool Tick ()=0
 
virtual ActionReport GenerateReport () const
 

Protected Member Functions

void SetupToolbarAction ()
 
void SetupHotkeyAction ()
 
void OnActionsComplete () override
 
- Protected Member Functions inherited from ScriptCanvas::Developer::CompoundAction
void ClearActionQueue ()
 
virtual void OnActionsComplete ()
 
- Protected Member Functions inherited from ScriptCanvas::Developer::EditorAutomationAction
virtual EditorAutomationAction * GenerateMissingPreconditionAction ()
 
virtual void SetupAction ()
 

Detailed Description

EditorAutomationAction that will create a group using the specified creation type[Hotkey action or toolbar click]

Member Function Documentation

◆ GenerateReport()

ActionReport ScriptCanvas::Developer::CreateGroupAction::GenerateReport ( ) const
overridevirtual

Reimplemented from ScriptCanvas::Developer::CompoundAction.

◆ OnActionsComplete()

void ScriptCanvas::Developer::CreateGroupAction::OnActionsComplete ( )
overrideprotectedvirtual

Reimplemented from ScriptCanvas::Developer::CompoundAction.

◆ SetupAction()

void ScriptCanvas::Developer::CreateGroupAction::SetupAction ( )
overridevirtual

Reimplemented from ScriptCanvas::Developer::CompoundAction.

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