LoadCharacterWithHumanoidDescription

Yields

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.

Unsafe

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

Function of:

Player

Description:

This function spawns an avatar so it has everything equipped in the passed in HumanoidDescription.

After calling LoadCharacterWithHumanoidDescription for an individual player, it is not recommended to call the function again for the same player until after that player’s Player/CharacterAppearanceLoaded event has fired.

Parameters

Name	Type	Default	Description
Name humanoidDescription	Type HumanoidDescription	Default	Summary A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character

Returns

Return Type	Summary
Return Type void	Summary No return

Code Samples

Spawn Characters With HumanoidDescription

To create a HumanoidDescription and then spawn a character with that description applied, add a Script (not a LocalScript) to the workspace and add this code to it:

To experiment with this code, download HumanoidDescriptionCreateAndSpawn.rbxlx.

			
				Spawn Characters With HumanoidDescription

				Expected Output
			
				Expand
				
			-- Stop automatic spawning so it can be done in the "PlayerAdded" callback
game.Players.CharacterAutoLoads = false
 
local function onPlayerAdded(player)
	-- Create a HumanoidDescription
	local humanoidDescription = Instance.new("HumanoidDescription")
	humanoidDescription.HatAccessory = "2551510151,2535600138"
	humanoidDescription.BodyTypeScale = 0.1
	humanoidDescription.ClimbAnimation = 619521311
	humanoidDescription.Face = 86487700
	humanoidDescription.GraphicTShirt = 1711661
	humanoidDescription.HeadColor = Color3.new(0, 1, 0)
	-- Spawn character with the HumanoidDescription
	player:LoadCharacterWithHumanoidDescription(humanoidDescription)
end
 
-- Connect "PlayerAdded" event to "onPlayerAdded()" function
game.Players.PlayerAdded:Connect(onPlayerAdded)
		
				Copy Code
			
				Light Theme

LoadCharacterWithHumanoidDescription

See also

Parameters

humanoidDescription

Returns

void

Code Samples

Spawn Characters With HumanoidDescription