LoadInstance

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 returns an instance that was previously saved to the player with Player/SaveInstance with the same key. Returns nil if the key doesn’t exist.

Parameters

Name	Type	Default	Description
Name key	Type string	Default	Summary

Returns

Return Type	Summary
Return Type Instance	Summary

Code Samples

Player:LoadInstance

The below example would reparent the saved instance to Workspace.

			
				Player:LoadInstance

				Expected Output
			
				Expand
				
			game.Players.PlayerAdded:Connect(function(Player)
    if Player:WaitForDataReady() then
        local Model = Player:LoadInstance("Model")
        Model.Parent = Workspace
    end
end)
		
				Copy Code
			
				Light Theme