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::ScriptEvent Class Reference

#include <ScriptEventDefinition.h>

Public Member Functions

 AZ_TYPE_INFO (ScriptEvent, "{10A08CD3-32C9-4E18-8039-4B8A8157918E}")
 
bool IsAddressRequired () const
 
 ScriptEvent (AZ::ScriptDataContext &dc)
 
void MakeBackup ()
 
void AddMethod (AZ::ScriptDataContext &dc)
 
void Register (AZ::ScriptDataContext &dc)
 
void Release (AZ::ScriptDataContext &dc)
 
Method & NewMethod ()
 
bool FindMethod (const AZ::Crc32 &eventId, Method &outMethod) const
 
bool FindMethod (const AZStd::string_view &name, Method &outMethod) const
 
bool HasMethod (const AZ::Crc32 &eventId) const
 
AZ::u32 GetVersion () const
 
AZStd::string GetName () const
 
AZStd::string GetCategory () const
 
AZStd::string GetTooltip () const
 
AZ::Uuid GetAddressType () const
 
AZStd::string GetBehaviorContextName () const
 
AZStd::string CreateBehaviorContextName ([[maybe_unused]] AZ::u32 versionNumber) const
 
const AZStd::string & GetScriptCanvasSerializationData () const
 
AZStd::string & ModScriptCanvasSerializationData ()
 
const AZStd::vector< Method > & GetMethods () const
 
AZStd::string_view GetLabel () const
 
void SetVersion (AZ::u32 version)
 
ScriptEventData::VersionedProperty & GetNameProperty ()
 
ScriptEventData::VersionedProperty & GetCategoryProperty ()
 
ScriptEventData::VersionedProperty & GetTooltipProperty ()
 
ScriptEventData::VersionedProperty & GetAddressTypeProperty ()
 
const ScriptEventData::VersionedProperty & GetNameProperty () const
 
const ScriptEventData::VersionedProperty & GetCategoryProperty () const
 
const ScriptEventData::VersionedProperty & GetTooltipProperty () const
 
const ScriptEventData::VersionedProperty & GetAddressTypeProperty () const
 
AZ::Outcome< bool, AZStd::string > Validate () const
 Validates that the asset data being stored is valid and supported.
 
void IncreaseVersion ()
 
void Flatten ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Defines a Script Event. This is the user-facing Script Event definition. When users create Script Events from Lua or in the editor this is the data definition that a Script Event Asset will serialize.

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