Class HandleSnapshot

A snapshot of an asset handle.

The snapshot preserves the asset type and snapshot index, and stores the asset server path when one is registered so the handle can be reloaded by path.

Index

Constructors

Properties

Methods

fromSnapshot deserialize serialize validateSerial

Constructors

constructor

new HandleSnapshot(typeId: TypeId, asset: string | number): HandleSnapshot
Parameters
- typeId: TypeId
- asset: string | number
Returns HandleSnapshot
- Defined in packages/asset/src/core/handle.js:123

Properties

asset

asset: string | number

type

type: TypeId

Methods

fromSnapshot

fromSnapshot(world: World, sceneAssetId?: AssetId): UntypedHandle
Restore the live handle from the asset server.

If the asset server knows the path, we reload it by path. Otherwise we upgrade the stored snapshot index against the asset pool.
Parameters
- world: World
- OptionalsceneAssetId: AssetId
Returns UntypedHandle
- Defined in packages/asset/src/core/handle.js:138

`Static`deserialize

deserialize(value: HandleSnapshotSerial, out?: HandleSnapshot): HandleSnapshot
Parameters
- value: HandleSnapshotSerial
- Optionalout: HandleSnapshot = ...
Returns HandleSnapshot
- Defined in packages/asset/src/core/handle.js:173

`Static`serialize

serialize(value: HandleSnapshot): { asset: string | number; type: TypeId }
Parameters
- value: HandleSnapshot
Returns { asset: string | number; type: TypeId }
- Defined in packages/asset/src/core/handle.js:162

`Static`validateSerial

validateSerial(value: unknown): value is HandleSnapshotSerial
Parameters
- value: unknown
Returns value is HandleSnapshotSerial
- Defined in packages/asset/src/core/handle.js:184