RemoveCharacter

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 RemoveCharacter Player function removes the player’s character. It also clears the player’s Backpack and PlayerGui. This is useful when you would like to temporarily remove a player’s character.

To reload a players character after using this function, simply use the Player/LoadCharacter function.

Note

This function does not remove a player from the game. It only removes their character. To remove a player from the game, you can use the Player/Kick function.

Returns

Return Type	Summary
Return Type void	Summary No return.

Code Samples

How to Remove a Player's Character

This example demonstrates how to remove a player’s character from the game using Player/RemoveCharacter.

After five seconds the example reload’s the player’s character using Player/LoadCharacter to demonstrate that the player’s PlayerGui and Backpack are cleared when the character is removed.

			
				How to Remove a Player's Character

				Expected Output
			
				Expand
				
			local player = game.Players.LocalPlayer

player:RemoveCharacter()
wait(5)
player:LoadCharacter()
		
				Copy Code
			
				Light Theme

RemoveCharacter

Note

Returns

void

Code Samples

How to Remove a Player's Character