TypeLibraries

PlayerData

One player's corner of the experience's data store, from data.player. Keys are stored as player:<uuid>:<key>, so the 256-character key limit counts that prefix too.

Fields

playerData.id: string#

The player's uuid.

Methods

playerData:get(key: string) -> Value#

The stored value, or nil if there is none.

playerData:set(key: string, value: Value?)#

Stores a value. Raises on any other type, a key containing $, or a full store. nil removes

playerData:remove(key: string) -> boolean#

Removes the key; true if it held a value.

playerData:has(key: string) -> boolean#

Whether the key holds a value.

playerData:keys(limit: number?) -> { string }#

This player's keys, sorted. limit defaults to 1000 and is at most 10000. without the player prefix