Player-scoped storage for key-value pairs
Sets module-wide defaults for both scene-scoped and player-scoped storage. Merges the given partial options into the current configuration. Note: cacheMaxEntries applies per scope (scene and player each keep their own cache) and bounds entry count, not bytes (entries hold serialized value bodies).
Retrieves a value from scene storage by key from the Server Side Storage service.
By default (cacheReads), values read or written during the last cacheMaxAgeMs are served from a local cache without a network request, including confirmed "not found" results. Concurrent gets for the same key share one request. Out-of-band writers (e.g. CLI storage commands) may not be visible for up to cacheMaxAgeMs — pass { fresh: true } to force a network read.
A promise that resolves to the parsed JSON value, or null if not found
The key to retrieve
Optional options: GetOptionsOptional { fresh } to bypass the read cache
Returns key-value entries from scene storage, optionally filtered by prefix. Supports pagination via limit and offset.
A promise that resolves to { data, pagination: { offset, total } } for pagination UI
Optional options: GetValuesOptionsOptional { prefix, limit, offset } for filtering and pagination.
Stores a value in scene storage in the Server Side Storage service.
The key to store the value under
The value to store (will be JSON serialized)
Optional options: SetOptionsOptional { skipIfUnchanged } to skip the network write when the value is already stored
Storage interface with methods for scene-scoped and player-scoped storage.