The Tool class inherits from BackpackItem. A tool acts as an item which can be held in a player's hand and can be interacted with.
Properties
CanBeDropped: bool
Indicates whether or not this tool can be dropped by pressing ← Backspace. If this property is false, the tool cannot be dropped.
- Category: Behavior.
- Serialization: can save and load.
- Thread safety: read safe
Enabled: bool
- Category: State.
- Serialization: can save and load.
- Thread safety: read safe
GripForward: Vector3
- Category: Transform.
- Serialization: cannot load or save.
- Thread safety: read safe
GripRight: Vector3
- Category: Transform.
- Serialization: cannot load or save.
- Thread safety: read safe
ManualActivationOnly: bool
- Category: Behavior.
- Serialization: can save and load.
- Thread safety: read safe
RequiresHandle: bool
- Category: Behavior.
- Serialization: can save and load.
- Thread safety: read safe
ToolTip: string
- Category: Appearance.
- Serialization: can save and load.
- Thread safety: read safe
Methods
Activate(): null
- Thread safety: unsafe
Deactivate(): null
- Thread safety: unsafe
Events
Activated()
- Thread safety: unsafe
Deactivated()
- Thread safety: unsafe
Unequipped()
- Thread safety: unsafe
External links
- Tool in the Roblox Creator Documentation
- Tool in the Roblox API Reference