Open 3D Engine AzCore 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 | Public Attributes | Static Public Attributes | Friends | List of all members
AZ::ScriptAsset Class Reference

#include <ScriptAsset.h>

Inherits AZ::Data::AssetData.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ScriptAsset, AZ::SystemAllocator)
 
 AZ_RTTI (ScriptAsset, "{82557326-4AE3-416C-95D6-C70635AB7588}", Data::AssetData)
 
 ScriptAsset (const Data::AssetId &assetId=Data::AssetId())
 
- Public Member Functions inherited from AZ::Data::AssetData
 AZ_CLASS_ALLOCATOR (AssetData, SystemAllocator)
 
 AZ_RTTI (AssetData, "{AF3F7D32-1536-422A-89F3-A11E1F5B5A9C}")
 
 AssetData (const AssetId &assetId=AssetId(), AssetStatus status=AssetStatus::NotLoaded)
 
void Acquire ()
 
void Release ()
 
void AcquireWeak ()
 
void ReleaseWeak ()
 
bool IsReady () const
 
bool IsError () const
 
bool IsLoading (bool includeQueued=true) const
 
AssetStatus GetStatus () const
 
const AssetId & GetId () const
 
AssetType GetType () const
 
int GetUseCount () const
 
int GetCreationToken () const
 

Public Attributes

LuaScriptData m_data
 

Static Public Attributes

static const u32 CompiledAssetSubId = 1
 

Friends

class ScriptSystemComponent
 

Additional Inherited Members

- Public Types inherited from AZ::Data::AssetData
enum class  AssetStatus : int {
  NotLoaded , Queued , StreamReady , Loading ,
  LoadedPreReady , ReadyPreNotify , Ready , Error
}
 
- Static Public Member Functions inherited from AZ::Data::AssetData
static void Reflect (ReflectContext *context)
 
- Protected Types inherited from AZ::Data::AssetData
enum class  AssetDataFlags : AZ::u32 { Requeue = 0 }
 
- Protected Member Functions inherited from AZ::Data::AssetData
virtual bool IsRegisterReadonlyAndShareable ()
 
virtual bool HandleAutoReload ()
 
bool GetFlag (const AssetDataFlags &checkFlag) const
 
void SetFlag (const AssetDataFlags &checkFlag, bool setValue)
 
bool GetRequeue () const
 
void SetRequeue (bool requeue)
 
void RegisterWithHandler (AssetHandler *assetHandler)
 
void UnregisterWithHandler ()
 
 AssetData (const AssetData &)=delete
 
- Protected Attributes inherited from AZ::Data::AssetData
AZStd::atomic_int m_useCount { 0 }
 
AZStd::atomic_int m_weakUseCount { 0 }
 
AZStd::atomic< AssetStatus > m_status
 
AssetId m_assetId
 
AssetHandler * m_registeredHandler { nullptr }
 
int m_creationToken = s_defaultCreationToken
 
AZStd::bitset< 32 > m_flags
 

Detailed Description

Script Asset - contains the source code for a script

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