EquipTool
Equips a Tool on a character through the game's own bound functions.
Syntax
:EquipTool(tool: Instance) -> nilParameters
| Parameter | Type | Description |
|---|---|---|
tool | Instance | The tool value used by the call. |
Returns
| Type | Description |
|---|---|
nil | This function does not return a value. |
Description
EquipTool is part of the Instances library. Instances are live proxies backed by game memory. Property reads and method calls go through Roblox's own objects.
The operation is performed immediately using the arguments supplied at the call site.
The aliases :UnequipTools() resolve to the same implementation.
Example
local character = game:GetService("Players").LocalPlayer.Character
local tool = Instance.new("Tool")
tool.Parent = character
character:EquipTool(tool)
character:UnequipTools()Notes
- Aliases:
:UnequipTools(). - Instance proxies are backed by live game memory.