Class JsonAsset

Generic type of Json-format asset. It provides the managed representation of this resource data so it can be accessed via C# API.

Inheritance

Object

ScriptingObject

ManagedScriptingObject

Asset

JsonAssetBase

JsonAsset

Inherited Members

Asset::_deleteFileOnUnload

ScriptingObject::_gcHandle

ScriptingObject::_id

JsonAssetBase::_isResaving

Asset::_isVirtual

JsonAssetBase::_isVirtualDocument

Asset::_loadingTask

Asset::_loadState

JsonAssetBase::_path

Asset::_refCount

ScriptingObject::_type

Asset::AddReference()

Asset::Asset(const SpawnParams& params, const AssetInfo* info)

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

Asset::CancelStreaming()

ScriptingObject::Cast(ScriptingObject* obj)

Asset::ChangeID(const Guid& newId)

Asset::const

Asset::createLoadingTask()

Asset::CreateManaged()

ScriptingObject::CreateManagedInternal()

JsonAssetBase::Data

JsonAssetBase::DataEngineBuild

JsonAssetBase::DataTypeName

Asset::DECLARE_ENUM_7(LoadResult, Ok, Failed, MissingDataChunk, CannotLoadData, CannotLoadStorage, CannotLoadInitData, InvalidData)

ScriptingObject::Deleted

Asset::DeleteManaged()

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

Asset::DEPRECATED("Use GetReferences with assets and files parameter instead")

Asset::DestroyManaged()

JsonAssetBase::Document

JsonAsset

Object::Flags

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

ScriptingObject::GetClass()

JsonAssetBase::GetData()

ScriptingObject::GetID()

ScriptingObject::GetManagedInstance()

ScriptingObject::GetOrCreateManagedInstance()

JsonAssetBase::GetPath()

JsonAssetBase::GetReferences(const StringAnsiView& json, Array<Guid, HeapAllocation>& assets)

JsonAssetBase::GetReferences(Array<Guid, HeapAllocation>& assets, Array<String, HeapAllocation>& files)

Asset::GetReferences()

Asset::GetReferencesCount()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

Asset::GetTypeName()

ScriptingObject::HasManagedInstance()

JsonAssetBase::Init(const StringView& dataTypeName, const StringAnsiView& dataJson)

Asset::InitAsVirtual()

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

Asset::IsInternalType()

Asset::IsLoaded()

ScriptingObject::IsRegistered()

Asset::IsVirtual()

JsonAssetBase::JsonAssetBase(const SpawnParams& params, const AssetInfo* info)

Asset::LastLoadFailed()

JsonAsset

Asset::Locker

ManagedScriptingObject::ManagedScriptingObject(const SpawnParams& params)

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

Asset::OnCheckSave(const StringView& path=StringView::Empty)

Asset::OnDeleteObject()

Asset::onLoad(LoadAssetTask* task)

Asset::onLoaded()

Asset::OnLoaded

Asset::OnManagedInstanceDeleted()

Asset::OnReloading

JsonAssetBase::onRename(const StringView& newPath)

Asset::OnScriptingDispose()

Asset::onUnload_MainThread()

Asset::OnUnloaded

ScriptingObject::RegisterObject()

Asset::releaseStorage()

Asset::Reload()

Asset::RemoveReference()

JsonAssetBase::Save(JsonWriter& writer)

JsonAssetBase::Save(const StringView& path=StringView::Empty)

JsonAssetBase::saveInternal(JsonWriter& writer)

ScriptingObject::ScriptingObject(const SpawnParams& params)

JsonAssetBase::SetData(const StringView& value)

ManagedScriptingObject::SetManagedInstance(MObject* instance)

Asset::ShouldDeleteFileOnUnload()

JsonAsset

Asset::startLoading()

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

Asset::ToString()

ScriptingObject::UnregisterObject()

Asset::WaitForLoaded(double timeoutInMilliseconds=30000.0)

Object::~Object()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/Content/JsonAsset.h

Syntax

public class JsonAsset : public JsonAssetBase

Fields

Instance

The deserialized unmanaged object instance (e.g. PhysicalMaterial). Might be null if asset was loaded before binary module with that asset was loaded (use GetInstance for this case).

Declaration

public void* Instance

Field Value

void

InstanceType

The scripting type of the deserialized unmanaged object instance (e.g. PhysicalMaterial).

Declaration

public ScriptingTypeHandle InstanceType

Field Value

ScriptingTypeHandle

Methods

GetInstance()

Gets the deserialized native object instance of the given type. Returns null if asset is not loaded or loaded object has different type.

Declaration

public T* GetInstance() const

Returns

T The asset instance object or null.

Type Parameters

typename T

GetMemoryUsage()

Gets amount of CPU memory used by this resource (in bytes). It's a rough estimation. Memory may be fragmented, compressed or sub-allocated so the actual memory pressure from this resource may vary.

Declaration

public virtual uint64 GetMemoryUsage() const override

Returns

uint64

Overrides

JsonAssetBase::GetMemoryUsage()

loadAsset()

Loads asset

Declaration

protected virtual LoadResult loadAsset() override

Returns

LoadResult Loading result

Overrides

JsonAssetBase::loadAsset()

OnGetData(rapidjson_flax::StringBuffer& buffer)

Declaration

protected virtual void OnGetData(rapidjson_flax::StringBuffer& buffer) const override

Parameters

rapidjson_flax::StringBuffer buffer

Overrides

JsonAssetBase::OnGetData(rapidjson_flax::StringBuffer& buffer)

onLoaded_MainThread()

Declaration

protected virtual void onLoaded_MainThread() override

Overrides

Asset::onLoaded_MainThread()

unload(bool isReloading)

Unloads asset data

Declaration

protected virtual void unload(bool isReloading) override

Parameters

bool isReloading True if asset is reloading data, otherwise false.

Overrides

JsonAssetBase::unload(bool isReloading)

See Also

JsonAssetBase