Open 3D Engine ScriptCanvas Gem API Reference  22.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Typedefs | Enumerations | Functions
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  AutomationRequests
 
struct  CreateNodeResult
 
class  DynamicSlotRequests
 
class  EBusHandlerEventNodeDescriptorRequests
 
class  EBusHandlerNodeDescriptorRequests
 
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  GeneralAssetNotifications
 
class  GeneralEditorNotifications
 
class  GeneralGraphEvents
 
class  GeneralRequests
 
class  GraphStatisticsHelper
 
struct  HandlerEventConfiguration
 
class  IconRequests
 
class  IState
 State interface, provides the framework for any given state that may run through the state machine. More...
 
class  NodeCreationNotifications
 
class  NodeDescriptorRequests
 
class  NodeIdentifierFactory
 
struct  NodeIdPair
 
class  SceneCounterRequests
 
class  SceneMemberMappingConfigurationRequests
 
class  SceneMemberMappingRequests
 
class  ScriptCanvasExecutionRequests
 
class  ScriptCanvasWrapperNodeDescriptorRequests
 
class  ScriptEventReceiveNodeDescriptorNotifications
 
class  ScriptEventReceiverEventNodeDescriptorRequests
 
class  ScriptEventReceiverNodeDescriptorRequests
 
class  SlotMappingRequests
 
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  SystemRequests
 
class  UINotifications
 
class  UIRequests
 
struct  UndoData
 
class  UndoNotifications
 
class  UndoRequests
 
struct  UnitTestResult
 
class  UnitTestVerificationRequests
 
class  UnitTestWidgetNotifications
 
struct  UpgradeGraphConfig
 
class  UpgradeNotifications
 
class  VariableAutomationRequests
 
class  VariableNodeDescriptorRequests
 
class  VariablePaletteRequests
 

Typedefs

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 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 SourceHandle = SourceHandle
 
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 GraphPtr = EditorGraph *
 
using GraphPtrConst = const EditorGraph *
 
using SourceDescription = ScriptCanvas::SourceDescription
 

Enumerations

enum  UndoGraphCommand { ChangeItem, AddItem, RemoveItem }
 
enum  NodeDescriptorType {
  Unknown, EBusHandler, EBusHandlerEvent, EBusSender,
  _deprecated_, VariableNode, SetVariable, GetVariable,
  UserDefined, ClassMethod, FunctionNode, FunctionDefinitionNode,
  AzEventHandler, Invalid
}
 

Functions

AZStd::optional< SourceHandle > CompleteDescription (const SourceHandle &source)
 
bool CompleteDescriptionInPlace (SourceHandle &source)
 
AZStd::optional< SourceHandle > CreateFromAnyPath (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)
 

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.