All server functions

Alphabetical index of PlayerStateServer functions and lifecycle signals.

Common tasks

I want to…	Use	Docs
Load a player	Init	Initialization
Set a value	Set	Basic data
Set a nested value	SetPath	Paths
Save now	SaveData	Utilities · Events
React to changes	OnChanged	Change listeners
Hook before leave/shutdown	BeforeRelease	Events
Hook before save	BeforeSave	Events
Batch many writes	BatchSetValues	Batch
Server-wide temp state	SetShared / GetShared	Shared session

Symbol	Summary	Docs
AddToArray	Append item to an array path	Arrays
BatchSetValues	Apply multiple set operations in one batch	Batch
BatchUpdateValues	Batch increment/decrement on numeric paths	Batch
BeforeRelease	Leave/shutdown hook before session release	Events
BeforeSave	Hook before save (SaveData, leave, shutdown)	Events
ClearPathCache	Clear server path parse cache	Cache
Clone	Deep or shallow clone of a value	Utilities
Decrement	Decrease a numeric key or path	Numeric
FlushBatch	Flush pending batched writes for a player	Batch
Get	Read a top-level data key	Data
GetAll	Read full player data table	Utilities
GetFromDict	Read a key from a dictionary path	Dicts
GetLeaderboard	Fetch top entries for a leaderboard stat	Leaderboard
GetOfflineData	Load saved data for an offline user	Utilities
GetPath	Read a nested path	Paths
GetPlayerRank	Get a player's rank on a leaderboard	Leaderboard
GetProfile	Get ProfileStore profile object	Utilities
GetReplica	Get Replica instance for a player	Utilities
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
Increment	Increase a numeric key or path	Numeric
Init	Load profile and start session for a player	Initialization
IsPlayerDataReady	Non-blocking profile + Replica readiness	Utilities
IsSharedReady	Whether shared session Replica is ready	Shared Session
MigrationResult	Signal when legacy migration finishes	Events
OnChanged	Subscribe to profile data changes	Listeners
OnSharedChanged	Subscribe to shared session changes	Shared Session
ProfileLoaded	Signal when player data is ready after join	Events
ProfileUnloaded	Signal when profile session ends	Events
RemoveFromArray	Remove array item by index	Arrays
RemoveFromDict	Remove dict entry by key	Dicts
SaveData	Manually save player data	Utilities
Set	Write a top-level data key	Data
SetInDict	Write dict entry at path	Dicts
SetOfflineData	Write offline user's saved data	Utilities
SetPath	Write nested path with validation	Paths
SetShared	Write shared session top-level key	Shared Session
SetSharedPath	Write shared session nested path	Shared Session
SetSharedValues	Batch write shared session keys	Shared Session
SetValues	Set multiple top-level keys at once	Batch
UpdateArrayItem	Replace array item at index	Arrays
UpdateLeaderboard	Update leaderboard score for a player	Leaderboard
WipeOfflinePlayerData	Delete offline user's saved data	Utilities
WipePlayerData	Wipe active player's saved data	Utilities

See also the Server overview topic table for grouped documentation.