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.
ScriptCanvas::Nodes::Core::SendScriptEvent Class Reference

Provides a node to send a Script Event. More...

#include <SendScriptEvent.h>

Inherits ScriptCanvas::Nodes::Core::Internal::ScriptEventBase, and ScriptEvents::ScriptEventNotificationBus::Handler.

Public Member Functions

 SCRIPTCANVAS_NODE (SendScriptEvent)
 
const AZStd::string & GetEventName () const
 
bool HasBusID () const
 
bool HasResult () const
 
ScriptCanvas::EBusBusId GetBusId () const
 
ScriptCanvas::EBusEventId GetEventId () const
 
SlotId GetBusSlotId () const
 
void ConfigureNode (const AZ::Data::AssetId &assetId, const ScriptCanvas::EBusEventId &eventId)
 
bool IsOutOfDate (const VersionData &graphVersion) const override
 
UpdateResult OnUpdateNode () override
 
AZStd::string GetUpdateString () const override
 
AZ::Outcome< Grammar::LexicalScope, void > GetFunctionCallLexicalScope (const Slot *) const override
 
AZ::Outcome< AZStd::string, void > GetFunctionCallName (const Slot *) const override
 
EventType GetFunctionEventType (const Slot *) const override
 

Public Attributes

NamespacePath m_namespaces
 
ScriptCanvas::EBusBusId m_busId
 
ScriptCanvas::EBusEventId m_eventId
 

Protected Member Functions

bool FindEvent (AZ::BehaviorMethod *&outMethod, const NamespacePath &namespaces, AZStd::string_view eventName)
 
void BuildNode (const AZ::Data::AssetId &assetId, const ScriptCanvas::EBusEventId &eventId, SlotIdMapping &populationMapping)
 
void InitializeResultSlotId ()
 
void OnScriptEventReady (const AZ::Data::Asset< ScriptEvents::ScriptEventsAsset > &) override
 
bool CreateSender (AZ::Data::Asset< ScriptEvents::ScriptEventsAsset >)
 
void OnDeactivate () override
 Entity level deactivation, perform any entity lifetime release here, i.e disconnect from EBuses.
 
bool IsConfigured () const
 
void ConfigureMethod (AZ::BehaviorMethod &method)
 
bool RegisterScriptEvent (AZ::Data::Asset< ScriptEvents::ScriptEventsAsset > asset)
 
void AddInputSlot (size_t slotIndex, size_t argIndex, const AZStd::string_view argName, const AZStd::string_view tooltip, AZ::BehaviorMethod *method, const AZ::BehaviorParameter *argument, AZ::Uuid slotKey, SlotIdMapping &populationMapping)
 
void OnRegistered (const ScriptEvents::ScriptEvent &) override
 

Protected Attributes

SlotId m_resultSlotID
 
AZ::BehaviorMethod * m_method = nullptr
 
AZStd::recursive_mutex m_mutex
 
AZStd::string m_eventName
 
AZStd::string m_busName
 
bool m_ignoreReadyEvent = false
 

Detailed Description

Provides a node to send a Script Event.

Member Function Documentation

◆ GetFunctionCallLexicalScope()

AZ::Outcome< Grammar::LexicalScope, void > ScriptCanvas::Nodes::Core::SendScriptEvent::GetFunctionCallLexicalScope ( const Slot ) const
overridevirtual

Reimplemented from ScriptCanvas::Node.

◆ GetFunctionCallName()

AZ::Outcome< AZStd::string, void > ScriptCanvas::Nodes::Core::SendScriptEvent::GetFunctionCallName ( const Slot ) const
overridevirtual

Reimplemented from ScriptCanvas::Node.

◆ GetFunctionEventType()

EventType ScriptCanvas::Nodes::Core::SendScriptEvent::GetFunctionEventType ( const Slot ) const
overridevirtual

Reimplemented from ScriptCanvas::Node.

◆ GetUpdateString()

AZStd::string ScriptCanvas::Nodes::Core::SendScriptEvent::GetUpdateString ( ) const
overridevirtual

Reimplemented from ScriptCanvas::Node.

◆ IsOutOfDate()

bool ScriptCanvas::Nodes::Core::SendScriptEvent::IsOutOfDate ( const VersionData graphVersion) const
overridevirtual

Reimplemented from ScriptCanvas::Node.

◆ OnDeactivate()

void ScriptCanvas::Nodes::Core::SendScriptEvent::OnDeactivate ( )
overrideprotectedvirtual

Entity level deactivation, perform any entity lifetime release here, i.e disconnect from EBuses.

Reimplemented from ScriptCanvas::Node.

◆ OnUpdateNode()

UpdateResult ScriptCanvas::Nodes::Core::SendScriptEvent::OnUpdateNode ( )
overridevirtual

Reimplemented from ScriptCanvas::Node.


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