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 | Protected Attributes | List of all members
ScriptCanvas::SupportsMethodContract Class Reference

#include <SupportsMethodContract.h>

Inherits ScriptCanvas::Contract.

Public Member Functions

 AZ_CLASS_ALLOCATOR (SupportsMethodContract, AZ::SystemAllocator)
 
 AZ_RTTI (SupportsMethodContract, "{9C7BD7CB-D11C-4683-8691-F2593D1C294A}", Contract)
 
 SupportsMethodContract (const char *methodName)
 
- Public Member Functions inherited from ScriptCanvas::Contract
 AZ_CLASS_ALLOCATOR (Contract, AZ::SystemAllocator)
 
 AZ_RTTI (Contract, "{93846E60-BD7E-438A-B970-5C4AA591CF93}")
 
AZ::Outcome< void, AZStd::string > Evaluate (const Slot &sourceSlot, const Slot &targetSlot) const
 
AZ::Outcome< void, AZStd::string > EvaluateForType (const Data::Type &dataType) const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *reflection)
 
- Static Public Member Functions inherited from ScriptCanvas::Contract
static void Reflect (AZ::ReflectContext *reflection)
 

Protected Member Functions

AZ::Outcome< void, AZStd::string > OnEvaluate (const Slot &sourceSlot, const Slot &targetSlot) const override
 
AZ::Outcome< void, AZStd::string > OnEvaluateForType (const Data::Type &dataType) const override
 
virtual AZ::Outcome< void, AZStd::string > OnEvaluate (const Slot &sourceSlot, const Slot &targetSlot) const =0
 
virtual AZ::Outcome< void, AZStd::string > OnEvaluateForType (const Data::Type &dataType) const
 

Protected Attributes

AZStd::string m_methodName
 

Detailed Description

Contracts that verifies if the specified BehaviorContext method name is supported by a data type. This can be used to only allow slot connections if the underlying type is able to call the specified method. For example, container types may support the "Insert" method, while most native or BC types would not.

Member Function Documentation

◆ OnEvaluate()

AZ::Outcome< void, AZStd::string > ScriptCanvas::SupportsMethodContract::OnEvaluate ( const Slot &  sourceSlot,
const Slot &  targetSlot 
) const
overrideprotectedvirtual

Implements ScriptCanvas::Contract.

◆ OnEvaluateForType()

AZ::Outcome< void, AZStd::string > ScriptCanvas::SupportsMethodContract::OnEvaluateForType ( const Data::Type &  dataType) const
overrideprotectedvirtual

Reimplemented from ScriptCanvas::Contract.

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