struct `AcquirePackageReadLockOptions`

Options that control how are package read locks acquired.

Public

Constructors

AcquirePackageReadLockOptions

AcquirePackageReadLockOptions(bool loadIfMissing = true, bool blockUntilAcquired = true, const char *lockReason = nullptr)

Fields

LoadIfMissing

bool LoadIfMissing

If package cannot be found in the loaded package list, initiate a load operation.

BlockUntilAcquired

bool BlockUntilAcquired

Block the calling thread until the lock can be acquired.

If false, locking will fail if someone else is holding a write lock.

VirtualPathPrefix

Path VirtualPathPrefix

If non-empty, this path will be added as a prefix to all resources within the package, so they may be looked up using this path. (e.g. "/Game/Textures/" prefix path will allow loading of a resource within the package named "BrickAlbedo" via "/Game/Textures/BrickAlbedo" path).

Virtual package path prefix is only relevant when a package is being registered with the package manager.

LockReason

const char * LockReason

Reason for acquiring the lock, for debugging only.