Open 3D Engine ScriptEvents 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 Member Functions | Static Public Member Functions | List of all members
ScriptEvents::Method Class Reference

#include <ScriptEventsMethod.h>

Public Member Functions

 AZ_TYPE_INFO (Method, "{E034EA83-C798-413D-ACE8-4923C51CF4F7}")
 
 Method (const Method &rhs)
 
Method & operator= (const Method &rhs)
 
 Method (Method &&rhs)
 
 Method (AZ::ScriptDataContext &dc)
 
void FromScript (AZ::ScriptDataContext &dc)
 
void AddParameter (AZ::ScriptDataContext &dc)
 
bool IsValid () const
 
Parameter & NewParameter ()
 
AZStd::string GetName () const
 
AZStd::string GetTooltip () const
 
const AZ::Uuid GetReturnType () const
 
const AZStd::vector< Parameter > & GetParameters () const
 
ScriptEventData::VersionedProperty & GetNameProperty ()
 
ScriptEventData::VersionedProperty & GetTooltipProperty ()
 
ScriptEventData::VersionedProperty & GetReturnTypeProperty ()
 
const ScriptEventData::VersionedProperty & GetNameProperty () const
 
const ScriptEventData::VersionedProperty & GetTooltipProperty () const
 
const ScriptEventData::VersionedProperty & GetReturnTypeProperty () const
 
AZ::Crc32 GetEventId () const
 
AZ::Outcome< bool, AZStd::string > Validate () const
 Validates that the asset data being stored is valid and supported.
 
void PreSave ()
 
void Flatten ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Holds the versioned definition for each of a script events. You can think of this as a function declaration with a name, a return type and an optional list of parameters (see ScriptEventParameter).

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