SaveInstance

Deprecated

This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Player

Description:

This function was once used by an ancient data persistence method to save an instance which can be loaded again at a later time using Player/LoadInstance…

Parameters

Name	Type	Default	Description
Name key	Type string	Default	Summary
Name value	Type Instance	Default	Summary

Returns

Return Type	Summary
Return Type void	Summary

Code Samples

Player:SaveInstance

The below code will save ‘Model’, a descendant of Workspace, to the player each time they join the game. To access this instance again, we would need to index it by it’s key, ‘Model’, as defined in the first argument of this method.

			
				Player:SaveInstance

				Expected Output
			
				Expand
				
			game.Players.PlayerAdded:Connect(function(Player)
    Player:WaitForDataReady() 
    Player:SaveInstance("Model", game.Workspace.Model)
end)
		
				Copy Code
			
				Light Theme

SaveInstance

Parameters

key

value

Returns

void

Code Samples

Player:SaveInstance