Open 3D Engine ScriptCanvas 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.
ScriptCanvasEditor Namespace Reference

This file is for deprecated Editor time / source data that is none-the-less used to assist developers writing code that can load and properly update legacy source files for ScriptCanvas. More...

Classes

class  AssetGraphScene
 
class  AutomationRequests
 
class  AzEventHandlerNodeDescriptorComponent
 
struct  CategoryInformation
 
class  ClassMethodEventPaletteTreeItem
 
class  ClassMethodNodeDescriptorComponent
 
class  CommentNodePaletteTreeItem
 
class  Configuration
 Configuration provides user-facing facilities for selecting a ScriptCanvas source file, monitoring its status, and exposing its properties for configuration if possible. More...
 
class  ConnectionContextMenu
 
class  ContainerTypeLineEdit
 
class  ContainerTypeMenu
 
class  ContainerWizard
 
class  ConvertReferenceToVariableNodeAction
 
class  ConvertVariableNodeToReferenceAction
 
class  CreateAzEventHandlerSlotMenuAction
 
class  CreateClassMethodMimeEvent
 
class  CreateCommentNodeMimeEvent
 
class  CreateCustomNodeMimeEvent
 <GlobalMethod> More...
 
class  CreateEBusHandlerEventMimeEvent
 
class  CreateEBusHandlerMimeEvent
 
class  CreateEBusSenderMimeEvent
 
class  CreateFunctionMimeEvent
 
class  CreateGetVariableNodeMimeEvent
 
class  CreateGlobalMethodMimeEvent
 
class  CreateNodeGroupMimeEvent
 
class  CreateNodeMimeEvent
 
struct  CreateNodeResult
 
class  CreateScriptEventsHandlerMimeEvent
 
class  CreateScriptEventsReceiverMimeEvent
 
class  CreateScriptEventsSenderMimeEvent
 
class  CreateSendOrReceiveScriptEventsMimeEvent
 
class  CreateSetVariableNodeMimeEvent
 
class  CreateVariableChangedNodeMimeEvent
 
class  CreateVariableSpecificNodeMimeEvent
 
struct  CustomNodeModelInformation
 
class  CustomNodePaletteTreeItem
 
class  DataLogTreeItem
 
class  DataTypePaletteModel
 
class  DataTypePaletteSortFilterProxyModel
 
class  DebugLogFilter
 
class  DebugLogRootItem
 
class  DebugLogTreeItem
 
struct  DurationSpec
 
class  DynamicOrderingDynamicSlotComponent
 
class  DynamicSlotComponent
 
class  DynamicSlotRequests
 
class  EBusHandleEventPaletteTreeItem
 
class  EBusHandlerActionFilterProxyModel
 
struct  EBusHandlerActionItem
 
class  EBusHandlerActionMenu
 
class  EBusHandlerActionSourceModel
 
class  EBusHandlerEventNodeDescriptorComponent
 
class  EBusHandlerEventNodeDescriptorRequests
 
class  EBusHandlerNodeDescriptorComponent
 
class  EBusHandlerNodeDescriptorRequests
 
struct  EBusHandlerNodeModelInformation
 
class  EBusSenderNodeDescriptorComponent
 
struct  EBusSenderNodeModelInformation
 
class  EBusSendEventPaletteTreeItem
 
class  EditorAssetConversionBusTraits
 
class  EditorAssetSystemComponent
 
class  EditorGraph
 EditorGraph is the editor version of the ScriptCanvas::Graph component that is activated when executing the script canvas engine. More...
 
class  EditorGraphNotifications
 
class  EditorGraphRequests
 
class  EditorGraphUpgradeMachine
 
class  EditorGraphVariableItemModel
 
class  EditorGraphVariableManagerComponent
 
class  EditorLoggingComponentNotifications
 
class  EditorNodeNotifications
 
class  EditorSceneVariableManagerRequests
 
class  EditorScriptCanvasComponent
 
class  EditorScriptCanvasComponentLogging
 
class  EditorScriptCanvasComponentRequests
 
class  EditorScriptCanvasRequests
 
class  EndpointSelectionAction
 
class  EntityMimeDataHandler
 
class  EntityPivotTreeEntityItem
 
class  EntityPivotTreeGraphItem
 
class  EntityPivotTreeRoot
 
class  EntityPivotTreeWidget
 
struct  ExecutionIdentifier
 
class  ExecutionLogTreeItem
 
class  ExposeSlotMenuAction
 
class  FunctionDefinitionNodeDescriptorComponent
 
class  FunctionNodeDescriptorComponent
 
struct  FunctionNodeModelInformation
 FunctionNodeModelInformation refers to function graph assets, not methods. More...
 
class  FunctionPaletteTreeItem
 
class  GeneralAssetNotifications
 
class  GeneralEditorNotifications
 
class  GeneralGraphEvents
 
class  GeneralRequests
 
class  GetVariableNodeDescriptorComponent
 
class  GetVariableNodePaletteTreeItem
 
class  GlobalMethodEventPaletteTreeItem
 
struct  GlobalMethodNodeModelInformation
 
class  GraphItemAddCommand
 
class  GraphItemChangeCommand
 
class  GraphItemCommand
 
class  GraphItemCommandNotifications
 
class  GraphItemRemovalCommand
 
class  GraphPivotTreeEntityItem
 
class  GraphPivotTreeFolder
 
class  GraphPivotTreeGraphItem
 
class  GraphPivotTreeRoot
 
class  GraphPivotTreeWidget
 
class  GraphStatisticsHelper
 
class  GraphValidationDockWidget
 Displays warnings or errors related for a Script Canvas graph. More...
 
class  GraphValidationModel
 
class  GraphValidationSortFilterProxyModel
 
class  GraphValidatorDockWidgetNotifications
 
class  GraphVariablesModel
 
class  GraphVariablesModelSortFilterProxyModel
 
class  GraphVariablesTableView
 
struct  HandlerEventConfiguration
 
class  HighlightElementValidationEffect
 Highlights the border of a graph element to display its status. More...
 
class  IconComponent
 
class  IconRequests
 
class  INodeReplacementRequests
 
class  Interpreter
 
class  InterpreterWidget
 Reusable Editor Widget that provides an editable Configuration and control for an Interpreter. This allows developers to place the widget in almost any tool to provide in-place access to executing ScriptCanvas graphs. More...
 
class  IState
 State interface, provides the framework for any given state that may run through the state machine. More...
 
class  ItemButtonsDelegate
 
class  LiveLoggingDataAggregator
 
class  LiveLoggingUserSettings
 
class  LiveLoggingWindowSession
 
struct  LoadedInterpretedDependency
 
struct  LoadTestGraphResult
 
class  LocalVariableNodePaletteTreeItem
 
class  LocalVariablesListNodePaletteTreeItem
 
class  LoggingDataAggregator
 
class  LoggingDataNotifications
 
class  LoggingDataRequests
 
class  LoggingWindow
 
class  LoggingWindowFilterModel
 
class  LoggingWindowSession
 
class  MainWindow
 
class  MainWindowStatusWidget
 
struct  MethodNodeModelInformation
 
class  MultiCreateNodeMimeEvent
 
class  NodeAnnotationTreeItem
 
class  NodeCreationNotifications
 
class  NodeDescriptorComponent
 
class  NodeDescriptorRequests
 
class  NodeGroupNodePaletteTreeItem
 
class  NodeIdentifierFactory
 
struct  NodeIdPair
 
class  NodelingDescriptorComponent
 
class  NodePaletteModel
 
struct  NodePaletteModelInformation
 
class  NodePaletteModelNotifications
 
class  NodePaletteNodeUsagePaletteItem
 
class  NodePaletteNodeUsageRootItem
 
class  NodeReplacementRequests
 
class  NodeReplacementSystem
 
class  OnSaveToast
 
class  PivotTreeEntityItem
 
class  PivotTreeGraphItem
 
class  PivotTreeItem
 
class  PivotTreeRoot
 
class  PivotTreeSortProxyModel
 
class  PivotTreeWidget
 
class  PropertyGridRequests
 
class  ReflectComponent
 
class  RemoveUnusedVariablesMenuAction
 
class  RenameFunctionDefinitionNodeAction
 Context menu to rename a node. More...
 
class  Reporter
 
struct  RunGraphSpec
 
struct  RunSpec
 
class  SceneContextMenu
 
class  SceneCounterRequests
 
class  SceneMemberMappingComponent
 
class  SceneMemberMappingConfigurationRequests
 
class  SceneMemberMappingRequests
 
class  SceneUndoState
 
struct  ScopedOutputSuppression
 
class  ScopedUndoBatch
 
class  ScriptCanvasAssetBrowserModel
 
class  ScriptCanvasAssetIdDataInterface
 
class  ScriptCanvasAssetNodeUsageFilterModel
 
class  ScriptCanvasAssetNodeUsageTreeItem
 
class  ScriptCanvasAssetNodeUsageTreeItemRoot
 
class  ScriptCanvasBoolDataInterface
 
class  ScriptCanvasColorDataInterface
 
class  ScriptCanvasComboBoxPropertyDataInterface
 
class  ScriptCanvasCRCDataInterface
 
class  ScriptCanvasDataInterface
 
class  ScriptCanvasEntityIdDataInterface
 
class  ScriptCanvasEnumComboBoxPropertyDataInterface
 
class  ScriptCanvasExecutionRequests
 
class  ScriptCanvasGraphScopedVariableDataInterface
 
class  ScriptCanvasNumericDataInterface
 
class  ScriptCanvasPropertyDataInterface
 
class  ScriptCanvasQuaternionDataInterface
 
class  ScriptCanvasStringDataInterface
 
class  ScriptCanvasStringPropertyDataInterface
 
class  ScriptCanvasVariableReferenceDataInterface
 
class  ScriptCanvasVectorDataInterface
 
class  ScriptCanvasVectorizedDataInterface
 
class  ScriptCanvasWrapperNodeDescriptorRequests
 
struct  ScriptEventHandlerNodeModelInformation
 
class  ScriptEventReceiveNodeDescriptorNotifications
 
class  ScriptEventReceiverEventNodeDescriptorComponent
 
class  ScriptEventReceiverEventNodeDescriptorRequests
 
class  ScriptEventReceiverNodeDescriptorComponent
 
class  ScriptEventReceiverNodeDescriptorRequests
 
class  ScriptEventSenderNodeDescriptorComponent
 
struct  ScriptEventSenderNodeModelInformation
 
class  ScriptEventsEventNodePaletteTreeItem
 
class  ScriptEventsHandlerEventPaletteTreeItem
 
class  ScriptEventsPaletteTreeItem
 
class  ScriptEventsSenderPaletteTreeItem
 
class  SetDataSlotTypeMenuAction
 
class  Settings
 
class  SettingsDialog
 
class  SetVariableNodeDescriptorComponent
 
class  SetVariableNodePaletteTreeItem
 
class  SlotManipulationMenuAction
 
class  SlotMappingComponent
 
class  SlotMappingRequests
 
class  SourceHandlePropertyAssetCtrl
 
class  SourceHandlePropertyHandler
 
class  SpecializedCreateNodeMimeEvent
 
class  State
 Base class for all states in the system, users must provide a state ID through StateTraits. More...
 
class  StateMachine
 
struct  StateTraits
 StateTraits provides each state the ability to provide its own compile time ID. More...
 
class  StatisticsDialog
 
class  SystemComponent
 
class  SystemRequests
 
class  TargetManagerModel
 
class  TraceMessageComponent
 
class  TraceSuppressionRequests
 
class  UINotifications
 
class  UIRequests
 
class  UndoCache
 
struct  UndoData
 
class  UndoHelper
 
class  UndoNotifications
 
class  UndoRequests
 
class  UnitTestBrowserFilterModel
 
class  UnitTestComponent
 
class  UnitTestContextMenu
 
class  UnitTestDockWidget
 
struct  UnitTestResult
 
class  UnitTestTreeView
 
class  UnitTestVerificationRequests
 
class  UnitTestWidgetNotifications
 
class  UnsavedChangesDialog
 
class  UnusedNodeValidationEffect
 Effect used to show when a node is unused. More...
 
struct  UpgradeGraphConfig
 
class  UpgradeHelper
 A tool that collects and upgrades all Script Canvas graphs in the asset catalog. More...
 
class  UpgradeNotifications
 
class  UserDefinedNodeDescriptorComponent
 
class  ValidationData
 Owns the model for each currently opened graph. More...
 
class  ValidationEffect
 Visual effect interface. More...
 
class  VariableAutomationRequests
 
class  VariableCategoryNodePaletteTreeItem
 
class  VariableChangedNodePaletteTreeItem
 
class  VariableComboBoxDataModel
 
class  VariableConfigurationWidget
 
class  VariableDockWidget
 
class  VariableNodeDescriptorComponent
 
class  VariableNodeDescriptorRequests
 
class  VariablePaletteRequests
 
class  VariablePaletteTableView
 
class  VariablePanelContextMenu
 
class  VariablePropertiesComponent
 
class  VariableTypeComboBoxFilterModel
 
class  Workspace
 Manages the Save/Restore operations of the user's last opened and focused graphs. More...
 

Typedefs

using EditorAssetConversionBus = AZ::EBus< EditorAssetConversionBusTraits >
 
using SourceHandle = ScriptCanvas::SourceHandle
 
using Reporters = AZStd::vector< Reporter >
 
using TraceSuppressionBus = AZ::EBus< TraceSuppressionRequests >
 
using EditorSceneVariableManagerRequestBus = AZ::EBus< EditorSceneVariableManagerRequests >
 
using EditorScriptCanvasRequestBus = AZ::EBus< EditorScriptCanvasRequests >
 
using EditorScriptCanvasComponentRequestBus = AZ::EBus< EditorScriptCanvasComponentRequests >
 
using EditorGraphRequestBus = AZ::EBus< EditorGraphRequests >
 
using EditorGraphNotificationBus = AZ::EBus< EditorGraphNotifications >
 
using EditorNodeNotificationBus = AZ::EBus< EditorNodeNotifications >
 
using EditorScriptCanvasComponentLoggingBus = AZ::EBus< EditorScriptCanvasComponentLogging >
 
using EditorLoggingComponentNotificationBus = AZ::EBus< EditorLoggingComponentNotifications >
 
using UpgradeNotificationsBus = AZ::EBus< UpgradeNotifications >
 
using GeneralGraphEventBus = AZ::EBus< GeneralGraphEvents >
 
using IconBus = AZ::EBus< IconRequests >
 
using NodeReplacementId = AZStd::string
 
using NodeReplacementRequestBus = AZ::EBus< INodeReplacementRequests, NodeReplacementRequests >
 
using GeneralRequestBus = AZ::EBus< GeneralRequests >
 
using GeneralEditorNotificationBus = AZ::EBus< GeneralEditorNotifications >
 
using GeneralAssetNotificationBus = AZ::EBus< GeneralAssetNotifications >
 
using NodeCreationNotificationBus = AZ::EBus< NodeCreationNotifications >
 
using VariablePaletteRequestBus = AZ::EBus< VariablePaletteRequests >
 
using VariableAutomationRequestBus = AZ::EBus< VariableAutomationRequests >
 
using AutomationRequestBus = AZ::EBus< AutomationRequests >
 
using SystemRequestBus = AZ::EBus< SystemRequests >
 
using UIRequestBus = AZ::EBus< UIRequests >
 
using UINotificationBus = AZ::EBus< UINotifications >
 
using ScriptCanvasExecutionBus = AZ::EBus< ScriptCanvasExecutionRequests >
 
using UndoRequestBus = AZ::EBus< UndoRequests >
 
using UndoNotificationBus = AZ::EBus< UndoNotifications >
 
using UnitTestVerificationBus = AZ::EBus< UnitTestVerificationRequests >
 
using UnitTestWidgetNotificationBus = AZ::EBus< UnitTestWidgetNotifications >
 
using DynamicSlotRequestBus = AZ::EBus< DynamicSlotRequests >
 
using SlotMappingRequestBus = AZ::EBus< SlotMappingRequests >
 
using SceneMemberMappingConfigurationRequestBus = AZ::EBus< SceneMemberMappingConfigurationRequests >
 
using SceneMemberMappingRequestBus = AZ::EBus< SceneMemberMappingRequests >
 
using NodeDescriptorRequestBus = AZ::EBus< NodeDescriptorRequests >
 
using EBusHandlerNodeDescriptorRequestBus = AZ::EBus< EBusHandlerNodeDescriptorRequests >
 
using EBusHandlerEventNodeDescriptorRequestBus = AZ::EBus< EBusHandlerEventNodeDescriptorRequests >
 
using VariableNodeDescriptorRequestBus = AZ::EBus< VariableNodeDescriptorRequests >
 
using SceneCounterRequestBus = AZ::EBus< SceneCounterRequests >
 
using ScriptCanvasWrapperNodeDescriptorRequestBus = AZ::EBus< ScriptCanvasWrapperNodeDescriptorRequests >
 
using ScriptEventReceiverNodeDescriptorRequestBus = AZ::EBus< ScriptEventReceiverNodeDescriptorRequests >
 
using ScriptEventReceiveNodeDescriptorNotificationBus = AZ::EBus< ScriptEventReceiveNodeDescriptorNotifications >
 
using ScriptEventReceiverEventNodeDescriptorBus = AZ::EBus< ScriptEventReceiverEventNodeDescriptorRequests >
 
using GraphItemCommandNotificationBus = AZ::EBus< GraphItemCommandNotifications >
 
using AssetGraphSceneBus = AZ::EBus< AssetGraphScene >
 
using LoggingDataRequestBus = AZ::EBus< LoggingDataRequests >
 
using LoggingDataNotificationBus = AZ::EBus< LoggingDataNotifications >
 
typedef AZStd::unordered_multimap< AZ::NamedEntityId, ScriptCanvas::GraphIdentifierEntityGraphRegistrationMap
 
typedef AZStd::unordered_multimap< AZ::NamedEntityId, ScriptCanvas::GraphIdentifierLoggingEntityMap
 
typedef AZStd::unordered_set< ScriptCanvas::GraphIdentifierLoggingAssetSet
 
typedef AZ::EntityId LoggingDataId
 
using NodePaletteId = AZ::EntityId
 
using NodePaletteModelNotificationBus = AZ::EBus< NodePaletteModelNotifications >
 
using PropertyGridRequestBus = AZ::EBus< PropertyGridRequests >
 
using GraphValidatorDockWidgetNotificationBus = AZ::EBus< GraphValidatorDockWidgetNotifications >
 
using GraphPtr = EditorGraph *
 
using GraphPtrConst = const EditorGraph *
 
using SourceDescription = ScriptCanvas::SourceDescription
 

Enumerations

enum class  eDuration { InitialActivation = 0 , Seconds , Ticks }
 
enum class  UndoGraphCommand { ChangeItem , AddItem , RemoveItem }
 
enum class  NodeDescriptorType {
  Unknown , EBusHandler , EBusHandlerEvent , EBusSender ,
  _deprecated_ , VariableNode , SetVariable , GetVariable ,
  UserDefined , ClassMethod , FunctionNode , FunctionDefinitionNode ,
  AzEventHandler , Invalid
}
 
enum class  SettingsType { None , All , General , Graph }
 
enum class  UnsavedChangesOptions { SAVE , CONTINUE_WITHOUT_SAVING , CANCEL_WITHOUT_SAVING , INVALID }
 

Functions

 AZ_ENUM_CLASS_WITH_UNDERLYING_TYPE (InterpreterStatus, AZ::u8, Waiting, Misconfigured, Incompatible, Configured, Pending, Ready, Running, Stopped)
 
AZ_INLINE AZStd::vector< LoadedInterpretedDependencyLoadInterpretedDepencies (const ScriptCanvas::DependencySet &dependencySet)
 
AZ_INLINE LoadTestGraphResult LoadTestGraph (AZStd::string_view path)
 
AZ_INLINE Reporters RunGraph (const RunGraphSpec &runGraphSpec)
 
AZ_INLINE void RunEditorAsset (AZ::Data::Asset< AZ::Data::AssetData > asset, Reporter &reporter, ScriptCanvas::ExecutionMode mode)
 
AZ_INLINE void RunGraphImplementation (const RunGraphSpec &runGraphSpec, Reporter &reporter)
 
AZ_INLINE void RunGraphImplementation (const RunGraphSpec &runGraphSpec, LoadTestGraphResult &loadGraphResult, Reporter &reporter)
 
AZ_INLINE void RunGraphImplementation (const RunGraphSpec &runGraphSpec, Reporters &reporters)
 
AZ_INLINE void Simulate (const DurationSpec &duration)
 
AZ_INLINE void SimulateDuration (const DurationSpec &duration)
 
AZ_INLINE void SimulateSeconds (const DurationSpec &duration)
 
AZ_INLINE void SimulateTicks (const DurationSpec &duration)
 
AZ_INLINE void CopyAssetEntityIdsToOverrides (RuntimeDataOverrides &runtimeDataOverrides)
 
AZ_INLINE void RunEditorAsset (SourceHandle asset, Reporter &reporter, ScriptCanvas::ExecutionMode mode)
 
AZStd::optional< SourceHandleCompleteDescription (const SourceHandle &source)
 
bool CompleteDescriptionInPlace (SourceHandle &source)
 
AZStd::optional< SourceHandleCreateFromAnyPath (const SourceHandle &source, const AZ::IO::Path &path)
 
 DefineState (ReplaceDeprecatedConnections)
 
 DefineState (ReplaceDeprecatedNodes)
 
 DefineState (CollectData)
 
 DefineState (PreRequisites)
 
 DefineState (PreventUndo)
 
 DefineState (Start)
 
 DefineState (DisplayReport)
 
 DefineState (Finalize)
 
 DefineState (VerifySaveDataVersion)
 
 DefineState (SanityChecks)
 
 DefineState (UpgradeScriptEvents)
 
 DefineState (FixLeakedData)
 
 DefineState (UpgradeConnections)
 
 DefineState (UpdateOutOfDateNodes)
 
 DefineState (BuildGraphCanvasMapping)
 
 DefineState (RestoreUndo)
 
 DefineState (Skip)
 
 DefineState (ParseGraph)
 
AZStd::string GetEditingGameDataFolder ()
 
void SetRecentAssetId (SourceHandle assetId)
 
void ClearRecentAssetId ()
 
QStringList ReadRecentFiles ()
 
void WriteRecentFiles (const QStringList &filenames)
 
void AddRecentFile (const QString &filename)
 
void ClearRecentFile ()
 

Variables

constexpr const char * k_unitTestDirPathRelative = "@gemroot:ScriptCanvasTesting@/Assets/ScriptCanvas/UnitTests"
 
static const GraphCanvas::EditorId AssetEditorId = AZ_CRC("ScriptCanvasEditor", 0xa6d1a85a)
 
constexpr AZ::ComponentId k_dynamicallySpawnedControllerId = static_cast<AZ::ComponentId>(-1)
 

Detailed Description

This file is for deprecated Editor time / source data that is none-the-less used to assist developers writing code that can load and properly update legacy source files for ScriptCanvas.

Note
Runtime data should never be versioned. The serialized Assets should always be reflect the latest version of the serialized C++ definitions, and when an update is required, the appropriate builder is bumped to trigger teh AP to regenerate all files from their sources.