ScriptCanvas::Nodes::Core::ReceiveScriptEvent Class Reference

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

#include <ReceiveScriptEvent.h>

Inherits ScriptCanvas::Nodes::Core::Internal::ScriptEventBase.

Public Types
using	Events = AZStd::vector< Internal::ScriptEventEntry >

Public Member Functions
	SCRIPTCANVAS_NODE (ReceiveScriptEvent)
void	OnActivate () override
	Entity level activation, perform entity lifetime setup here, i.e. connect to EBuses.
void	OnDeactivate () override
	Entity level deactivation, perform any entity lifetime release here, i.e disconnect from EBuses.
const AZ::Data::AssetId	GetAssetId () const
ScriptCanvas::EBusBusId	GetBusId () const
const Internal::ScriptEventEntry *	FindEventWithSlot (const Slot &slot) const
const Slot *	GetEBusConnectSlot () const override
const Slot *	GetEBusDisconnectSlot () const override
AZStd::optional< size_t >	GetEventIndex (AZStd::string eventName) const override
AZStd::vector< SlotId >	GetEventSlotIds () const override
AZStd::vector< SlotId >	GetNonEventSlotIds () const override
bool	IsIDRequired () const
bool	IsEventSlotId (const SlotId &slotId) const
bool	IsOutOfDate (const VersionData &graphVersion) const override
UpdateResult	OnUpdateNode () override
AZStd::string	GetUpdateString () const override
void	SetAutoConnectToGraphOwner (bool enabled)
AZStd::string	GetEBusName () const override
bool	IsAutoConnected () const override
bool	IsEBusAddressed () const override
bool	IsEventHandler () const override
const Datum *	GetHandlerStartAddress () const override
const Slot *	GetEBusConnectAddressSlot () const override
AZ::Outcome< AZStd::string, void >	GetFunctionCallName (const Slot *) const override
AZStd::vector< const Slot * >	GetOnVariableHandlingDataSlots () const override
AZStd::vector< const Slot * >	GetOnVariableHandlingExecutionSlots () const override

Public Attributes
ScriptCanvas::EBusBusId	m_busId

Protected Member Functions
ConstSlotsOutcome	GetSlotsInExecutionThreadByTypeImpl (const Slot &executionSlot, CombinedSlotType targetSlotType, const Slot *) const override
void	OnScriptEventReady (const AZ::Data::Asset< ScriptEvents::ScriptEventsAsset > &) override

Detailed Description

Provides a node to handle a Script Event.

Member Function Documentation

GetEBusConnectAddressSlot()

const Slot * ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetEBusConnectAddressSlot ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetEBusConnectSlot()

const Slot * ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetEBusConnectSlot ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetEBusDisconnectSlot()

const Slot * ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetEBusDisconnectSlot ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetEBusName()

AZStd::string ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetEBusName ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetEventIndex()

AZStd::optional< size_t > ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetEventIndex ( AZStd::string  eventName ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetEventSlotIds()

AZStd::vector< SlotId > ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetEventSlotIds ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetFunctionCallName()

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

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetHandlerStartAddress()

const Datum * ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetHandlerStartAddress ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetNonEventSlotIds()

AZStd::vector< SlotId > ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetNonEventSlotIds ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetOnVariableHandlingDataSlots()

AZStd::vector< const Slot * > ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetOnVariableHandlingDataSlots ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetOnVariableHandlingExecutionSlots()

AZStd::vector< const Slot * > ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetOnVariableHandlingExecutionSlots ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

GetSlotsInExecutionThreadByTypeImpl()

ConstSlotsOutcome ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetSlotsInExecutionThreadByTypeImpl ( const Slot &  executionSlot, CombinedSlotType  targetSlotType, const Slot *    ) const

overrideprotectedvirtual

Reimplemented from ScriptCanvas::Node.

GetUpdateString()

AZStd::string ScriptCanvas::Nodes::Core::ReceiveScriptEvent::GetUpdateString ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

IsAutoConnected()

bool ScriptCanvas::Nodes::Core::ReceiveScriptEvent::IsAutoConnected ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

IsEBusAddressed()

bool ScriptCanvas::Nodes::Core::ReceiveScriptEvent::IsEBusAddressed ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

IsEventHandler()

bool ScriptCanvas::Nodes::Core::ReceiveScriptEvent::IsEventHandler ( ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

IsOutOfDate()

bool ScriptCanvas::Nodes::Core::ReceiveScriptEvent::IsOutOfDate ( const VersionData &  graphVersion ) const

overridevirtual

Reimplemented from ScriptCanvas::Node.

OnActivate()

void ScriptCanvas::Nodes::Core::ReceiveScriptEvent::OnActivate ( )

overridevirtual

Entity level activation, perform entity lifetime setup here, i.e. connect to EBuses.

Reimplemented from ScriptCanvas::Node.

OnDeactivate()

void ScriptCanvas::Nodes::Core::ReceiveScriptEvent::OnDeactivate ( )

overridevirtual

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

Reimplemented from ScriptCanvas::Node.

OnUpdateNode()

UpdateResult ScriptCanvas::Nodes::Core::ReceiveScriptEvent::OnUpdateNode ( )

overridevirtual

Reimplemented from ScriptCanvas::Node.

---

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

• Gems/ScriptCanvas/Code/Include/ScriptCanvas/Libraries/Core/ReceiveScriptEvent.h