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