PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

Tool

Show deprecated

Tool

Show deprecated

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|character model in the Workspace. By default, tools are held in the right hand and have a handle in them, which is a BasePart|Part named “Handle” inside (though one is not required if Tool/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 Tool/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 Tool/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 Player/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 ContextActionService/BindAction|BindAction and ContextActionService/UnbindAction|UnbindAction in the Tool/Equipped|Equipped and Tool/Unequipped|Unequipped events, respectively. Use a LocalScript send these actions to the server via a RemoteFunction inside the Tool.

Properties

bool

CanBeDropped

Controls whether the player can drop the tool

bool

Enabled

Relates to whether or not the tool can be used

CFrame

Grip

Stores the Tool’s Grip properties as one CFrame

Vector3

GripForward

[NotReplicated]

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

GripPos

[NotReplicated]

The positional offset of a Tool weld matrix

Vector3

GripRight

[NotReplicated]

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

GripUp

[NotReplicated]

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

ManualActivationOnly

The ManualActivationOnly property controls whether the Tool can be activated without executing Tool/Activate

bool

RequiresHandle

Determines whether a tool functions without a handle

string

ToolTip

Controls the message displayed when the player’s mouse hovers over the tool in their backpack

Functions

void

Activate ( )

Simulates a click on a Tool

void

Deactivate ( )

Simulates the deactivation of a Tool

Events

RBXScriptSignal

Activated ( )

Fired when the player clicks while a tool is equipped

RBXScriptSignal

Deactivated ( )

Fired when the left mouse button is released.

RBXScriptSignal

Equipped ( Instance mouse )

Fired when the tool is equipped

RBXScriptSignal

Unequipped ( )

Fired when the tool is unequipped