CreateLocalPlayer

LocalUserSecurity

This member cannot be used in scripts, but is usable in the command bar.

Unsafe

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

Function of:

Description:

The LocalPlayer will be set automatically when a client connects to the game, so uses for this method are extremely limited. This function is protected, attempting to use it in a Script or LocalScript will cause an error.

Although you cannot create the LocalPlayer, you can reference the LocalPlayer created by a game using the following code in a LocalScript:

	local player = game.Players.LocalPlayer

Returns

Return Type	Summary
Return Type Player	Summary

Code Samples

Creating a LocalPlayer

This example demonstrates that the Players/CreateLocalPlayer function executes without error if using the Command Bar or a Plugin and errors if executed in a LocalScript.

			
				Creating a LocalPlayer

				Expected Output
			
				Expand
				
			-- Command bar
local player = game.Players:CreateLocalPlayer() -- Returns a `Player` instance for the created local player

-- LocalScript
local player = game.Players:CreateLocalPlayer() -- Errors
		
				Copy Code
			
				Light Theme