Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
Tool
Inherits from: BackpackItem → Model → PVInstance → Instance → Object
A Tool is an object that a Humanoid object can equip. For players, they are stored in a Backpack object parented to a Player object. In-experience, 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.Character model in the Workspace. By default, tools are held in the right hand and have a handle in them, which is a BasePart named Handle inside (although one isn't required if Tool.RequiresHandle is false). Tools that are to be provided to (re)spawning players should be stored in the StarterPack.
Inherits from: BackpackItem
Descendants: Flag
Memory category: BaseParts
Code samples: View on Creator Hub (Explode-Tool-Example, Sword-Tool-Example).
Properties
| Name | Type / Returns | Description |
|---|---|---|
| Tool.CanBeDropped | boolean | Controls whether the player can drop the tool. |
| Tool.Enabled | boolean | Relates to whether or not the tool can be used. |
| Tool.Grip | CFrame | Stores the tool's "grip" properties as one CFrame. |
| Tool.GripForward | Vector3 | Represents the R02, R12, and R22 values of the grip CFrame rotation matrix. |
| Tool.GripPos | Vector3 | The positional offset of the tool's weld matrix. |
| Tool.GripRight | Vector3 | Represents the R00, R10, and R20 values of the grip CFrame rotation matrix. |
| Tool.GripUp | Vector3 | Represents the R01, R11, and R21 values of the grip CFrame rotation matrix. |
| Tool.ManualActivationOnly | boolean | Controls whether the Tool can be activated without executing Tool:Activate(). |
| Tool.RequiresHandle | boolean | Determines whether a Tool functions without a handle. |
| Tool.ToolTip | string | Controls the message displayed when the player's mouse hovers over the tool in their backpack. |
Inherited from BackpackItem
| Name | Type / Returns | Description |
|---|---|---|
| BackpackItem.TextureContent | Content | The texture icon that is displayed for a tool in the player's backpack. Only supports asset URIs. |
| BackpackItem.TextureId | ContentId | The texture icon that is displayed for a tool in the player's backpack. |
Inherited from Model
| Name | Type / Returns | Description |
|---|---|---|
| Model.LevelOfDetail | ModelLevelOfDetail | Sets the level of detail on the model for experiences with instance streaming enabled. |
| Model.ModelStreamingMode | ModelStreamingMode | Controls the model streaming behavior on Models when instance streaming is enabled. |
| Model.PrimaryPart | BasePart | The primary part of the Model, or nil if not explicitly set. |
| Model.Scale | float | Editor-only property used to scale the model around its pivot. Setting this property will move the scale as though Model:ScaleTo() was called on it. |
| Model.WorldPivot | CFrame | Determines where the pivot of a Model which does not have a set Model.PrimaryPart is located. |
Inherited from PVInstance
| Name | Type / Returns | Description |
|---|---|---|
| PVInstance.Origin | CFrame | Editor-only property that reads and sets the world CFrame of the PVInstance's pivot, moving the entire instance when changed from the Studio Properties window. |
| PVInstance.Pivot Offset | CFrame | Editor-only property that displays and edits the pivot's CFrame relative to the instance, moving only the pivot and leaving the instance in place. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
Tool.CanBeDropped
The CanBeDropped property controls whether the player can drop the Tool.
If true, when the backspace button is pressed, the tool will be parented to Workspace and removed from the player's Backpack. If false, nothing will happen when backspace is pressed, and the tool will remain equipped.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Behavior |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
Tool.Enabled
The Enabled property relates to whether or not the Tool can be used. This is useful if you want to prevent a player from using a tool, but don't want to remove it from their Backpack.
When set to true, the player can use the tool. When set to false, the tool is disabled and the player cannot use it; this prevents the tool from being activated or deactivated by the Tool:Activate() and Tool:Deactivate() methods, and it prevents the Tool.Activated and Tool.Deactivated events from firing.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
| simulationAccess | true |
Code samples: View on Creator Hub (superjump-tool).
Tool.Grip
The Grip property stores the tool's "grip" properties as a single CFrame. These properties position how the player holds the tool and include GripUp, GripRight, GripForward, and GripPos.
| Field | Value |
|---|---|
| type | CFrame |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Transform |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
| simulationAccess | true |
Code samples: View on Creator Hub (grip-stick).
Tool.GripForward
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 rotation matrix.
Other tool properties that control how a character holds a tool include Tool.GripUp, Tool.GripRight, and Tool.GripPos. All of these properties are stored in a single CFrame in the Tool.Grip property.
| Field | Value |
|---|---|
| type | Vector3 |
| tags | ["Hidden","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Transform |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (grip-stick).
Tool.GripPos
This property controls the positional offset of the tool's weld matrix. It is one of several properties used to position how the player character holds the tool.
Other properties that control how a character holds a tool include Tool.GripUp, Tool.GripRight, and Tool.GripForward. All of these properties are stored in a single CFrame in the Tool.Grip property.
| Field | Value |
|---|---|
| type | Vector3 |
| tags | ["Hidden","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Transform |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (grip-stick).
Tool.GripRight
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 rotation matrix.
Other tool properties that control how a character holds a tool include Tool.GripUp, Tool.GripForward, and Tool.GripPos. All of these properties are stored in a single CFrame in the Tool.Grip property.
| Field | Value |
|---|---|
| type | Vector3 |
| tags | ["Hidden","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Transform |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (grip-stick).
Tool.GripUp
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 rotation matrix.
Other tool properties that control how a character holds a tool include Tool.GripRight, Tool.GripForward, and Tool.GripPos. All of these properties are stored in a single CFrame in the Tool.Grip property.
| Field | Value |
|---|---|
| type | Vector3 |
| tags | ["Hidden","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Transform |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (grip-stick).
Tool.ManualActivationOnly
This property controls whether the Tool can be activated without explicitly executing Tool:Activate() in a script.
When set to true, the tool will only fire Tool.Activated when Tool:Activate() is called. This also suppresses the ContextActionService:BindActivate() function.
When set to false, mouse clicks (when the tool is equipped) will also fire Tool.Activated.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Behavior |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (sprint-tool).
Tool.RequiresHandle
This property determines whether a Tool functions without a handle.
A tool has a handle when it contains a child part named Handle. Tools with handles typically require the player equipping them to hold an object to use them, for instance weapons. Tools without handles typically don't require the player equipping them to hold anything to use them, for instance "fly" or "summon" tools.
When set to true, the tool will function only with a handle. When set to false, the tool will function even without a handle.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Behavior |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
Tool.ToolTip
The ToolTip property controls the message that will be displayed when the player's Mouse hovers over the Tool in their Backpack.
Generally, the value of this property should describe the what the tool is or its use. For instance, for a shovel tool, you may choose to set the ToolTip to:
tool.ToolTip = "Shovel"or
tool.ToolTip = "Use to dig"or
tool.ToolTip = "Shovel - Use to dig"| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| Tool:Activate | () | Simulates activation of the Tool. |
| Tool:Deactivate | () | Simulates deactivation of the Tool. |
Inherited from Model
| Name | Type / Returns | Description |
|---|---|---|
| Model:AddPersistentPlayer | () | Sets this model to be persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of addition. |
| Model:BreakJoints | () | Breaks connections between BaseParts, including surface connections with any adjacent parts, WeldConstraints and all Welds and other JointInstances. |
| Model:breakJoints | () | |
| Model:GetBoundingBox | Tuple | Returns a description of a volume that contains all parts of a Model. |
| Model:GetExtentsSize | Vector3 | Returns the size of the smallest bounding box that contains all of the BaseParts in the Model, aligned with the Model.PrimaryPart if it is set. |
| Model:GetModelCFrame | CFrame | This value historically returned the CFrame of a central position in the model. |
| Model:GetModelSize | Vector3 | Returns the Vector3 size of the Model. |
| Model:GetPersistentPlayers | List | Returns all the Player objects that this model object is persistent for. Behavior varies based on whether this method is called from a Script or a LocalScript. |
| Model:GetPrimaryPartCFrame | CFrame | Returns the CFrame of the model's Model.PrimaryPart. This function will throw an error if no primary part exists for the Model. |
| Model:GetScale | float | Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via Model:ScaleTo(). |
| Model:MakeJoints | () | Goes through all BaseParts in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint with any adjacent parts. |
| Model:makeJoints | () | |
| Model:move | () | |
| Model:MoveTo | () | Moves the PrimaryPart to the given position. If a primary part has not been specified, the root part of the model will be used. |
| Model:moveTo | () | |
| Model:RemovePersistentPlayer | () | Makes this model no longer persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of removal. |
| Model:ResetOrientationToIdentity | () | Resets the rotation of the model's parts to the previously set identity rotation, which is done through the Model:SetIdentityOrientation() method. |
| Model:ScaleTo | () | Sets the scale factor of the model, adjusting the sizing and location of all descendant Instances such that they have that scale factor relative to their initial sizes and locations when scale factor was 1. |
| Model:SetIdentityOrientation | () | Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of the ResetOrientationToIdentity method. |
| Model:SetPrimaryPartCFrame | () | Sets the BasePart.CFrame of the model's Model.PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the Model.PrimaryPart. |
| Model:TranslateBy | () | Shifts a Model by the given Vector3 offset, preserving the model's orientation. If another BasePart or Terrain already exists at the new position then the Model will overlap said object. |
Inherited from PVInstance
| Name | Type / Returns | Description |
|---|---|---|
| PVInstance:GetPivot | CFrame | Gets the pivot of a PVInstance. |
| PVInstance:PivotTo | () | Transforms the PVInstance along with all of its descendant PVInstances such that the pivot is now located at the specified CFrame. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
Tool:Activate
This function simulates activation of the Tool. The tool must be equipped for this function to work.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (invisibility-tool).
Tool:Deactivate
This function simulates deactivation of the Tool. The tool must be equipped for this function to work.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (invisibility-tool).
Events
| Name | Type / Returns | Description |
|---|---|---|
| Tool.Activated | Fires when the player clicks while the tool is equipped. | |
| Tool.Deactivated | Fires when the player releases their click while the tool is equipped and activated. | |
| Tool.Equipped | Fires when the tool is equipped. | |
| Tool.Unequipped | Fires when the tool is unequipped. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
Tool.Activated
This event fires when the player clicks while the Tool is equipped. It is not fired if the Ctrl key is pressed during the click.
This event is typically used to perform an action when the player uses the tool, for instance to launch a rocket from a rocket launcher weapon tool.
The below code, when placed in a LocalScript, creates a tool in the local player's Backpack and prints "Tool activated" when the player clicks while the created tool is equipped.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (Tool-Activated).
Tool.Deactivated
This event fires when the player releases their click while the Tool is equipped and activated. It is typically used to perform an action when the player stops using a tool.
The below code, when placed in a LocalScript, creates a tool in the local player's Backpack and prints "Tool deactivated" when the player releases their click while the tool is equipped and activated.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (Tool-Deactivated).
Tool.Equipped
This event fires when a player equips the Tool (takes it out of their Backpack).
The opposite of this event, Tool.Unequipped, can be used to determine when the player unequips the tool by putting it in their backpack.
Note that this event does not fire when Tool.RequiresHandle is enabled and no handle is present.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| mouse | Mouse | The player's mouse. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |
Code samples: View on Creator Hub (Tool-Equipped1).
Tool.Unequipped
This event fires when a player unequips the Tool (puts it in their Backpack).
The opposite of this event, Tool.Equipped, can be used to determine when the player equips the tool by taking it out of their backpack.
Note that this event does not fire when Tool.RequiresHandle is enabled and no handle is present.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |