Open 3D Engine ScriptCanvas Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
ScriptCanvasEditor::GeneralRequests Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual AZ::Outcome< int, AZStd::string > OpenScriptCanvasAsset (SourceHandle scriptCanvasAssetId, Tracker::ScriptCanvasFileState fileState, int tabIndex=-1)=0
 
virtual AZ::Outcome< int, AZStd::string > OpenScriptCanvasAssetId (const SourceHandle &scriptCanvasAsset, Tracker::ScriptCanvasFileState fileState)=0
 
virtual int CloseScriptCanvasAsset (const SourceHandle &)=0
 
virtual bool CreateScriptCanvasAssetFor (const TypeDefs::EntityComponentId &requestingComponent)=0
 
virtual bool IsScriptCanvasAssetOpen (const SourceHandle &assetId) const =0
 
virtual void OnChangeActiveGraphTab (SourceHandle)
 
virtual void CreateNewRuntimeAsset ()=0
 
virtual ScriptCanvas::ScriptCanvasId GetActiveScriptCanvasId () const
 
virtual GraphCanvas::GraphId GetActiveGraphCanvasGraphId () const
 
virtual GraphCanvas::GraphId GetGraphCanvasGraphId ([[maybe_unused]] const ScriptCanvas::ScriptCanvasId &scriptCanvasEntityId) const
 
virtual ScriptCanvas::ScriptCanvasId GetScriptCanvasId ([[maybe_unused]] const GraphCanvas::GraphId &graphCanvasSceneId) const
 
virtual GraphCanvas::GraphId FindGraphCanvasGraphIdByAssetId ([[maybe_unused]] const SourceHandle &assetId) const
 
virtual ScriptCanvas::ScriptCanvasId FindScriptCanvasIdByAssetId ([[maybe_unused]] const SourceHandle &assetId) const
 
virtual bool IsInUndoRedo (const AZ::EntityId &graphCanvasGraphId) const =0
 
virtual bool IsScriptCanvasInUndoRedo (const ScriptCanvas::ScriptCanvasId &scriptCanvasId) const =0
 
virtual bool IsActiveGraphInUndoRedo () const =0
 
virtual void UpdateName (const AZ::EntityId &, const AZStd::string &)
 
virtual void DeleteNodes (const AZ::EntityId &, const AZStd::vector< AZ::EntityId > &)
 
virtual void DeleteConnections (const AZ::EntityId &, const AZStd::vector< AZ::EntityId > &)
 
virtual void DisconnectEndpoints (const AZ::EntityId &, const AZStd::vector< GraphCanvas::Endpoint > &)
 
virtual void PostUndoPoint (ScriptCanvas::ScriptCanvasId)=0
 
virtual void SignalSceneDirty (SourceHandle)=0
 
virtual void PushPreventUndoStateUpdate ()=0
 
virtual void PopPreventUndoStateUpdate ()=0
 
virtual void ClearPreventUndoStateUpdate ()=0
 
virtual void TriggerUndo ()=0
 
virtual void TriggerRedo ()=0
 
virtual const CategoryInformation * FindNodePaletteCategoryInformation (AZStd::string_view categoryPath) const =0
 
virtual const NodePaletteModelInformation * FindNodePaletteModelInformation (const ScriptCanvas::NodeTypeIdentifier &nodeType) const =0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ OpenScriptCanvasAsset()

virtual AZ::Outcome<int, AZStd::string> ScriptCanvasEditor::GeneralRequests::OpenScriptCanvasAsset ( SourceHandle  scriptCanvasAssetId,
Tracker::ScriptCanvasFileState  fileState,
int  tabIndex = -1 
)
pure virtual

Opens an existing graph and returns the tab index in which it was open in.

Parameters
FileAssetId
Returns
index of open tab if the asset was able to be open successfully or error message of why the open failed
The documentation for this class was generated from the following file: