We use cookies on this site to enhance your user experience

Tools are objects that a Humanoid object can equip. For players, they are stored in a Backpack object parented to a Player object. In-game, players may have multiple tools which appear as icons at the bottom of the screen. Equipping a tool moves it from the Backpack and into a player’s character model in the Workspace. By default, tools are held in the right hand and have a handle in them, which is a Part named “Handle” inside (though one is not required if RequiresHandle is off). Tools that are to be provided to (re)spawning players ought to be stored in the StarterPack.

On desktop, pressing a number key (1, 2, 3…) will equip a tool. Equipped tools can be dropped into the Workspace by pressing Backspace. It’s recommended that you turn CanBeDropped off so it is not possible to drop a tool, die, respawn and drop again to duplicate tools. On gamepads, LB and RB buttons will equip tools. You can disable activation via left click (or right trigger on gamepad) by setting ManualActivationOnly on. Doing so requires that you call Activate yourself through some sort of other user input.

Tools are not the only way to capture user input. You can also use ContextActionService, UserInputService or GetMouse. If you need a Tool to have multiple actions, such as pressing a key while the Tool is equipped, you should use ContextActionService’s BindAction and UnbindAction in the Equipped and Unequipped events, respectively. Use a LocalScript send these actions to the server via a RemoteFunction inside the Tool.

Properties

Name Type Description
bool

If true, when the backspace button is pressed the tool will be parented to the workspace and removed from the player’s backpack. If false, when the backspace button is pressed the tool will go back to the Player’s Backpack.

bool

Relates to whether or not the tool can be used.

CFrame

Stores the Tool’s Grip properties as one CFrame.

Vector3

One of the properties that specifies a Tool’s orientation in a character’s hand. This represents the R02, R12, and R22 values of the Grip CFrame’s rotation matrix.

Vector3

The positional offset of a Tool weld matrix.

Vector3

One of the properties that specifies a Tool’s orientation in a character’s hand. This represents the R00, R10, and R20 values of the Grip CFrame’s rotation matrix.

Vector3

One of the properties that specifies a Tool’s orientation in a character’s hand. This represents the R01, R11, and R21 values of the Grip CFrame’s rotation matrix.

bool

When set to true, the tool will only fire Tool/Activated when Tool/Activate is called. This also suppresses the ContextActionService's ContextActionService/BindActivate function.

When set to false, mouse clicks (when the tool is equipped) will also fire `Tool/Activated`.

bool

If set to false the tool will function without a handle.

string

This property controls the message that will be displayed when the player’s mouse is hovering over the tool in their backpack.

Inherited from Instance , GuiItem , BackpackItem

Archivable ClassName DataCost Name Parent RobloxLocked TextureId

Events

Name Type Description

Fired when the player clicks while a tool is equipped.

Fired when the left mouse button is released.

Fired when the tool is equipped.

Fired when the tool is unequipped.

Inherited from Instance , GuiItem , BackpackItem

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving