Lib.Store

Last updated on

No permission. Backed by Open77.kvp, per server address and per resource, 1 MiB per resource. The player can edit them: never trust them.

Lib.Store.Get

Reads one value. Not a Result.

Lib.Store.Get(key, fallback)

Parameters

• key: string
• fallback?: any — answered when the key is absent or unreadable

Returns

• any

local volume = Lib.Store.Get('volume', 0.8)

Lib.Store.Has

Whether a key is stored.

Lib.Store.Has(key)

Parameters

• key: string

Returns

• boolean

Lib.Store.Set

Persists one typed value. No tables.

Lib.Store.Set(key, value)

Parameters

• key: string
  • 1–128 bytes.
• value: string | number | boolean
  • Numbers must be finite.

Returns

• Result — errors invalid_key, invalid_value

Lib.Store.Set('volume', 0.5)

Lib.Store.Delete

Deletes one key.

Lib.Store.Delete(key)

Parameters

• key: string

Returns

• Result — whether it existed; error invalid_key

Lib.Store.Keys

Your keys under a prefix, sorted.

Lib.Store.Keys(prefix)

Parameters

• prefix?: string

Returns

• Result — sorted keys