Skip to content

Client API is read-only. Use server APIs and your own remotes to change saved data.

Client Functions

Client-side PlayerState API for data access and change listeners.

Client Only - READ-ONLY

Client scripts only. These functions are READ-ONLY - no data modification!
Need to change data? Create your own RemoteEvents with server validation.

Reference sections

TopicDescription
All functionsAlphabetical index of every client API symbol
Data accessGet, GetPath, GetOfflineData, etc.
LeaderboardDisplay ranks on the client
StatusIsReady
Shared sessionServer-wide ephemeral reads
CacheClearCache
Change listenersOnChanged
AdvancedRaw Replica handle
ExamplesLarger patterns
Error handlingReadiness & connections
PerformanceOptimization notes

PlayerState - High-Performance Roblox Data Management