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 Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ScriptCanvas::EBusHandler Class Referencefinal

Inherits ScriptCanvas::Nodeable.

Public Member Functions

 AZ_RTTI (EBusHandler, "{38E3448F-1876-41DF-A26F-EF873AF5EE14}", Nodeable)
 
 AZ_CLASS_ALLOCATOR (EBusHandler, AZ::SystemAllocator)
 
 EBusHandler (ExecutionStateWeakPtr executionState, AZStd::string_view busName, AZ::BehaviorContext *behaviorContext)
 
 EBusHandler (AZStd::string_view busName, AZ::BehaviorContext *behaviorContext)
 
bool Connect ()
 
bool ConnectTo (AZ::BehaviorArgument &busId)
 
void Disconnect ()
 
const AZStd::string & GetEBusName () const
 
int GetEventIndex (AZStd::string_view eventName) const
 
bool IsActive () const override
 
bool IsConnected () const
 
bool IsConnectedTo (AZ::BehaviorArgument &busId) const
 
void HandleEvent (int eventIndex)
 
- Public Member Functions inherited from ScriptCanvas::Nodeable
 AZ_RTTI (Nodeable, "{C8195695-423A-4960-A090-55B2E94E0B25}")
 
 AZ_CLASS_ALLOCATOR (Nodeable, AZ::SystemAllocator)
 
 Nodeable (ExecutionStateWeakPtr executionState)
 
void CallOut (size_t index, AZ::BehaviorArgument *resultBVP, AZ::BehaviorArgument *argsBVPs, int numArguments) const
 
const Execution::FunctorOut & GetExecutionOut (size_t index) const
 
const Execution::FunctorOut & GetExecutionOutChecked (size_t index) const
 
virtual NodePropertyInterface * GetPropertyInterface (AZ::Crc32)
 
void Deactivate ()
 
virtual bool IsActive () const
 
void InitializeExecutionOuts (size_t count)
 
void SetExecutionOut (size_t index, Execution::FunctorOut &&out)
 
void SetExecutionOutChecked (size_t index, Execution::FunctorOut &&out)
 

Static Public Member Functions

static EBusHandler * Create (ExecutionStateWeakPtr executionState, AZStd::string_view busName)
 
static void Reflect (AZ::ReflectContext *reflectContext)
 
- Static Public Member Functions inherited from ScriptCanvas::Nodeable
static void Reflect (AZ::ReflectContext *reflectContext)
 

Protected Member Functions

void OnDeactivate () override
 
- Protected Member Functions inherited from ScriptCanvas::Nodeable
ExecutionStateWeakConstPtr GetExecutionState () const
 
void InitializeExecutionOutByRequiredCount ()
 
void InitializeExecutionState (ExecutionState *executionState)
 
virtual void OnInitializeExecutionState ()
 
virtual void OnDeactivate ()
 
virtual size_t GetRequiredOutCount () const
 
template<typename... t_Args>
void ExecutionOut (size_t index, t_Args &&... args) const
 
void ExecutionOut (size_t index) const
 
template<typename t_Return >
void ExecutionOutResult (size_t index, t_Return &result) const
 
template<typename t_Return , typename... t_Args>
void ExecutionOutResult (size_t index, t_Return &result, t_Args &&... args) const
 

Additional Inherited Members

- Protected Types inherited from ScriptCanvas::Nodeable
template<typename T >
using decay_array = AZStd::conditional_t< AZStd::is_array_v< AZStd::remove_reference_t< T > >, std::remove_extent_t< AZStd::remove_reference_t< T > > *, T && >
 

Member Function Documentation

◆ IsActive()

bool ScriptCanvas::EBusHandler::IsActive ( ) const
overridevirtual

Reimplemented from ScriptCanvas::Nodeable.

◆ OnDeactivate()

void ScriptCanvas::EBusHandler::OnDeactivate ( )
overrideprotectedvirtual

Reimplemented from ScriptCanvas::Nodeable.

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