Class FlaxFile

Flax Game Engine asset files container object.

Inheritance

Object

FlaxStorage

FlaxFile

Inherited Members

FlaxStorage::_chunks

FlaxStorage::_chunksLock

FlaxStorage::_file

FlaxStorage::_files

FlaxStorage::_lastRefLostTime

FlaxStorage::_loadLocker

FlaxStorage::_path

FlaxStorage::_refCount

FlaxStorage::_version

FlaxStorage::AddChunk(FlaxChunk* chunk)

FlaxStorage::AddEntry(Entry& e)

FlaxStorage::AllocateChunk()

FlaxStorage::ChangeAssetID(Entry& e, const Guid& newId)

FlaxStorage::CloseFileHandles()

FlaxStorage::Create(const StringView& path, const AssetInitData& asset, bool silentMode=false, const CustomData* customData=nullptr)

FlaxStorage::Create(const StringView& path, const Array<AssetInitData>& assets, bool silentMode=false, const CustomData* customData=nullptr)

FlaxStorage::Create(const StringView& path, Span<AssetInitData> assets, bool silentMode=false, const CustomData* customData=nullptr)

FlaxStorage::Create(WriteStream* stream, Span<AssetInitData> assets, const CustomData* customData=nullptr)

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

Object::DeleteObjectNow()

Object::Flags

FlaxStorage::FlaxStorage(const StringView& path)

FlaxStorage::GetChunks(Array<FlaxChunk* >& output)

FlaxStorage::GetEntries(Array<Entry>& output)

FlaxStorage::GetEntry(int32 index)

FlaxStorage::GetEntry(int32 index, Entry& value)

FlaxStorage::GetEntry(const Guid& id, Entry& e)

FlaxStorage::GetMemoryUsage()

FlaxStorage::GetPath()

FlaxStorage::GetRefCount()

FlaxStorage::IsDisposed()

FlaxStorage::IsLoaded()

FlaxStorage::Load()

FlaxStorage::LoadAssetChunk(FlaxChunk* chunk)

FlaxStorage::LoadAssetHeader(const int32 index, AssetInitData& data)

FlaxStorage::LoadAssetHeader(const Guid& id, AssetInitData& data)

FlaxStorage::LoadAssetHeader(const Entry& e, AssetInitData& data)

FlaxStorage::Lock()

FlaxStorage::LockChunks()

FlaxStorage::LockSafe()

FlaxStorage::MagicCode

Object::OnDeleteObject()

FlaxStorage::OnReloaded

FlaxStorage::OnReloading

FlaxStorage::OnRename(const StringView& newPath)

FlaxStorage::OpenFile()

FlaxStorage::Reload()

FlaxStorage::ReloadSilent()

FlaxStorage::Save(const AssetInitData& data, bool silentMode=false)

FlaxStorage::SetEntry(int32 index, const Entry& value)

FlaxStorage::ShouldDispose()

FlaxStorage::Tick(double time)

FlaxStorage::UnlockChunks()

FlaxStorage::~FlaxStorage()

Object::~Object()

Assembly: FlaxEngine.dll

File: Engine/Content/Storage/FlaxFile.h

Syntax

public class FlaxFile : public FlaxStorage

Constructors

FlaxFile(const StringView& path)

Initializes a new instance of the FlaxFile class.

Declaration

public FlaxFile(const StringView& path)

Parameters

StringView path The path.

Fields

_asset

Declaration

protected Entry _asset

Field Value

Entry

Methods

AddEntry(Entry& e)

Declaration

protected void AddEntry(Entry& e) override

Parameters

Entry e

AllowDataModifications()

Checks whenever storage container allows the data modifications.

Declaration

public virtual bool AllowDataModifications() const override

Returns

bool

Overrides

FlaxStorage::AllowDataModifications()

Dispose()

Releases storage resources and closes handle to the file.

Declaration

public virtual void Dispose() override

Overrides

FlaxStorage::Dispose()

GetEntries(Array<Entry>& output)

Declaration

public void GetEntries(Array<Entry>& output) const override

Parameters

Array<Entry> output

GetEntriesCount()

Gets amount of entries in the storage.

Declaration

public virtual int32 GetEntriesCount() const override

Returns

int32

Overrides

FlaxStorage::GetEntriesCount()

GetEntry(const Guid& id, Entry& e)

Declaration

protected bool GetEntry(const Guid& id, Entry& e) override

Parameters

Guid id

Entry e

Returns

bool

GetEntry(int32 index, Entry& value)

Declaration

public void GetEntry(int32 index, Entry& value) const override

Parameters

int32 index

Entry value

HasAsset(const AssetInfo& info)

Determines whether the specified asset exists in this container.

Declaration

public virtual bool HasAsset(const AssetInfo& info) const override

Parameters

AssetInfo info The asset info.

Returns

bool True if the specified asset exists in this container, otherwise false.

Overrides

FlaxStorage::HasAsset(const AssetInfo& info)

HasAsset(const Guid& id)

Determines whether the specified asset exists in this container.

Declaration

public virtual bool HasAsset(const Guid& id) const override

Parameters

Guid id The asset identifier.

Returns

bool True if the specified asset exists in this container, otherwise false.

Overrides

FlaxStorage::HasAsset(const Guid& id)

IsPackage()

Determines whether this storage container is a package.

Declaration

public virtual bool IsPackage() const override

Returns

bool

Overrides

FlaxStorage::IsPackage()

SetEntry(int32 index, const Entry& value)

Declaration

public void SetEntry(int32 index, const Entry& value) override

Parameters

int32 index

Entry value

ToString()

Gets the string representation of this object.

Declaration

public virtual String ToString() const override

Returns

String

Overrides

Object::ToString()