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.
Public Types | Public Member Functions | Static Public Attributes | List of all members
ScriptCanvas::VariableRequests Class Referenceabstract

Bus Interface for adding, removing and finding exposed Variable datums associated with a ScriptCanvas Graph. More...

#include <VariableBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = GraphScopedVariableId
 
using AllocatorType = AZStd::allocator
 

Public Member Functions

virtual GraphVariable * GetVariable ()=0
 
virtual const GraphVariable * GetVariableConst () const =0
 
virtual Data::Type GetType () const =0
 Returns the type associated with the specified variable.
 
virtual AZStd::string_view GetName () const =0
 Looks up the variable name that the variable id is associated with in the handler of the bus.
 
virtual AZ::Outcome< void, AZStd::string > RenameVariable (AZStd::string_view newVarName)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

Bus Interface for adding, removing and finding exposed Variable datums associated with a ScriptCanvas Graph.

Member Function Documentation

◆ RenameVariable()

virtual AZ::Outcome< void, AZStd::string > ScriptCanvas::VariableRequests::RenameVariable ( AZStd::string_view  newVarName)
pure virtual

Changes the name of the variable with the specified @variableId within the handler returns an AZ::Outcome to indicate if the variable was able to be succesfully or an error message to indicate why the rename failed

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