EquipTool

Unsafe

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

Function of:

Description:

This function makes the Humanoid equip the given Tool.

The below example would cause a Player to equip a tool in Workspace named ‘Tool’.

local Players = game:GetService("Players")

local player = Players:FindFirstChildOfClass(“Player”)
if player and player.Character then
	local humanoid = player.Character:FindFirstChildOfClass("Humanoid")
	if humanoid then
		local tool = workspace:FindFirstChild("Tool")
		if tool then
			humanoid:EquipTool(tool)	
		end
	end
end

When this function is called, the humanoid will automatically unequip any Tool|Tools that it currently has equipped

Although they will be equipped, Tool|Tools for which Tool/RequiresHandle is true will not function if they have no handle, regardless if this function is used to equip them or not

Parameters

Name	Type	Default	Description
Name tool	Type Instance	Default	Summary The `Tool` to equip

Returns

Return Type	Summary
Return Type void	Summary No return

Code Samples

Creating a Colorful Brick Tool

The code below creates a new tool and places into the Players/LocalPlayer|LocalPlayer's Backpack. Then, the code equips the tool for the player user Humanoid/EquipTool.

When the tool is equipped and the player uses it (e.g. pressed their mouse button in-game), the code spawns a new BasePart|part at the position of the click using the Humanoid/TargetPoint position. The code also sets several of the part’s properties, such as giving it a random BasePart/BrickColor.

			
				Creating a Colorful Brick Tool

				Expected Output
			
				Expand
				
			local player = game.Players.LocalPlayer
local character = player.CharacterAdded:wait()
local humanoid = character.Humanoid

-- Make a new tool and handle and put it in the player's Backpack
local function makeTool()
	-- Create tool
	local tool = Instance.new("Tool")
	tool.Parent = player:WaitForChild("Backpack")

	-- Create tool handle
	local handle = Instance.new("Part")
	handle.Name = "Handle"
	handle.Parent = tool
	handle.BrickColor = BrickColor.Random()
	
	-- Enable and equip tool
	tool.Enabled = true
	humanoid:EquipTool(tool)

	-- Handle tool use
	tool.Activated:Connect(onActivated)
end

-- Create a new randomly colored part at *pos* world position
local function spawnPart(pos)
	local part = Instance.new("Part")
	part.Anchored = true
	part.Size = Vector3.new(1,1,1)
	part.Position = pos
	part.Parent = game.Workspace
	part.BrickColor = BrickColor.Random()
end

-- Spawn a new part at TargetPoint when the tool is activated
function onActivated()
	spawnPart(humanoid.TargetPoint)
end

-- Make a new tool when the LocalScript first runs
makeTool()
		
				Copy Code
			
				Light Theme

EquipTool

See also

Parameters

tool

Returns

void

Code Samples

Creating a Colorful Brick Tool