All client functions
Alphabetical index of PlayerStateClient functions (read-only).
Common tasks
| I want to… | Use | Docs |
|---|---|---|
| Read a top-level value | Get | Data access |
| Read a nested value | GetPath | Data access |
| Know when data is ready | IsReady | Status |
| React to changes | OnChanged | Change listeners |
| Read server-wide temp state | GetShared / GetSharedPath | Shared session |
| Change saved data from client | Your remotes + server APIs | Client writes via remotes |
| Symbol | Summary | Docs |
|---|---|---|
ClearCache | Clear client path parse cache | Cache |
Clone | Clone a value from local cache | Data Access |
Get | Read top-level replicated key | Data Access |
GetAll | Read full replicated player data | Data Access |
GetFromDict | Read dict entry at path | Data Access |
GetLeaderboard | Fetch leaderboard entries (client) | Leaderboard |
GetLeaderboardInfo | Leaderboard metadata for UI | Leaderboard |
GetOfflineData | Request another user's saved snapshot | Data Access |
GetPath | Read nested replicated path | Data Access |
GetReplica | Get raw Replica instance | Advanced |
GetShared | Read shared session top-level key | Shared Session |
GetSharedAll | Read all shared session data | Shared Session |
GetSharedPath | Read shared session nested path | Shared Session |
GetSharedReplica | Get shared session Replica | Shared Session |
IsReady | Whether local profile data is ready | Status |
IsSharedReady | Whether shared session is ready | Shared Session |
OnChanged | Subscribe to replicated data changes | Listeners |
OnSharedChanged | Subscribe to shared session changes | Shared Session |
See also the Client overview topic table for grouped documentation.