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

Inherits AZ::EBusTraits.

Public Types

using BusIdType = ID
 

Public Member Functions

virtual Slot * GetSlot (const SlotId &slotId) const =0
 
virtual size_t GetSlotIndex (const SlotId &slotId) const =0
 
virtual AZStd::vector< const Slot * > GetAllSlots () const
 
virtual AZStd::vector< Slot * > ModAllSlots ()
 
virtual SlotId GetSlotId (AZStd::string_view slotName) const =0
 
virtual SlotId FindSlotIdForDescriptor (AZStd::string_view slotName, const SlotDescriptor &descriptor) const =0
 
virtual SlotId GetSlotIdByType (AZStd::string_view slotName, CombinedSlotType slotType) const
 Retrieves a slot id that matches the supplied name and the supplied slot type.
 
virtual AZStd::vector< SlotId > GetSlotIds (AZStd::string_view slotName) const =0
 Retrieves all slot ids for slots with the specific name.
 
virtual const ScriptCanvasId & GetOwningScriptCanvasId () const =0
 
virtual const Datum * FindDatum (const SlotId &slotId) const =0
 Get the Datum for the specified slot.
 
const Datum * GetInput (const SlotId &slotId) const
 
virtual bool FindModifiableDatumView (const SlotId &slotId, ModifiableDatumView &datumView)=0
 
virtual AZ::Outcome< void, AZStd::string > SlotAcceptsType (const SlotId &, const Data::Type &) const =0
 Determines whether the slot on this node with the specified slot id can accept values of the specified type.
 
virtual Data::Type GetSlotDataType (const SlotId &slotId) const =0
 Gets the input for the given SlotId.
 
virtual VariableId GetSlotVariableId (const SlotId &slotId) const =0
 
virtual void SetSlotVariableId (const SlotId &slotId, const VariableId &variableId)=0
 
virtual void ClearSlotVariableId (const SlotId &slotId)=0
 
virtual int FindSlotIndex (const SlotId &slotId) const =0
 
virtual bool IsOnPureDataThread (const SlotId &slotId) const =0
 
virtual AZ::Outcome< void, AZStd::string > IsValidTypeForSlot (const SlotId &slotId, const Data::Type &dataType) const =0
 
virtual AZ::Outcome< void, AZStd::string > IsValidTypeForGroup (const AZ::Crc32 &dynamicGroup, const Data::Type &dataType) const =0
 
virtual void SignalBatchedConnectionManipulationBegin ()=0
 
virtual void SignalBatchedConnectionManipulationEnd ()=0
 
virtual void AddNodeDisabledFlag (NodeDisabledFlag disabledFlag)=0
 
virtual void RemoveNodeDisabledFlag (NodeDisabledFlag disabledFlag)=0
 
virtual bool IsNodeEnabled () const =0
 
virtual bool HasNodeDisabledFlag (NodeDisabledFlag disabledFlag) const =0
 
virtual bool RemoveVariableReferences (const AZStd::unordered_set< ScriptCanvas::VariableId > &variableIds)=0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Member Function Documentation

◆ GetAllSlots()

virtual AZStd::vector<const Slot*> ScriptCanvas::NodeRequests::GetAllSlots ( ) const
inlinevirtual

Gets all of the slots on the node. Name is funky to avoid a mismatch with typing with another function that returns a better version of this information that cannot be used with EBuses because of references.

◆ GetSlotId()

virtual SlotId ScriptCanvas::NodeRequests::GetSlotId ( AZStd::string_view  slotName) const
pure virtual

Retrieves a slot id that matches the supplied name There can be multiple slots with the same name on a node Therefore this should only be used when a slot's name is unique within the node

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