Open 3D Engine ScriptEvents Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
ScriptEvents::ScriptEventRequests Class Referenceabstract

External facing API for registering and getting ScriptEvents. More...

#include <ScriptEventsBus.h>

Inherits EBusTraits.

Public Types

using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual AZStd::intrusive_ptr
< Internal::ScriptEventRegistration > 		RegisterScriptEvent (const AZ::Data::AssetId &assetId, AZ::u32 version)=0
 
virtual void RegisterScriptEventFromDefinition ([[maybe_unused]] const ScriptEvent &definition)
 
virtual void UnregisterScriptEventFromDefinition ([[maybe_unused]] const ScriptEvent &definition)
 
virtual AZStd::intrusive_ptr
< Internal::ScriptEventRegistration > 		GetScriptEvent (const AZ::Data::AssetId &assetId, AZ::u32 version)=0
 
virtual const FundamentalTypes * GetFundamentalTypes ()=0
 
virtual AZ::Outcome
< ScriptEvents::ScriptEvent,
AZStd::string > 		LoadDefinitionSource (const AZ::IO::Path &path)=0
 
virtual AZ::Outcome< void,
AZStd::string > 		SaveDefinitionSourceFile (const ScriptEvents::ScriptEvent &events, const AZ::IO::Path &path)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Detailed Description

External facing API for registering and getting ScriptEvents.

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