Roblox Wiki
Register
Advertisement
Roblox Wiki

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

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:Tool/Enabled.
  • Category: State.
  • Serialization: can save and load.
  • Thread safety: read safe

Grip: CFrame

This class member is missing documentation. Create or add to its subpage at Class:Tool/Grip.
  • Category: Transform.
  • Serialization: can save and load.
  • Thread safety: read safe

GripForward: Vector3

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:Tool/GripForward.
  • Category: Transform.
  • Serialization: cannot load or save.
  • Thread safety: read safe

GripPos: Vector3

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:Tool/GripPos.
  • Category: Transform.
  • Serialization: cannot load or save.
  • Thread safety: read safe

GripRight: Vector3

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:Tool/GripRight.
  • Category: Transform.
  • Serialization: cannot load or save.
  • Thread safety: read safe

GripUp: Vector3

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:Tool/GripUp.
  • Category: Transform.
  • Serialization: cannot load or save.
  • Thread safety: read safe

ManualActivationOnly: bool

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:Tool/ManualActivationOnly.
  • Category: Behavior.
  • Serialization: can save and load.
  • Thread safety: read safe

RequiresHandle: bool

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:Tool/RequiresHandle.
  • Category: Behavior.
  • Serialization: can save and load.
  • Thread safety: read safe

ToolTip: string

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:Tool/ToolTip.
  • Category: Appearance.
  • Serialization: can save and load.
  • Thread safety: read safe

Methods

Activate(): null

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:Tool/Activate.
  • Thread safety: unsafe

Deactivate(): null

This class member is missing documentation. Create or add to its subpage at Class:Tool/Deactivate.
  • Thread safety: unsafe

Events

Activated()

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:Tool/Activated.
  • Thread safety: unsafe

Deactivated()

This class member is missing documentation. Create or add to its subpage at Class:Tool/Deactivated.
  • Thread safety: unsafe

Equipped(mouse: Mouse)

Parameters
NameType
mouseMouse
  • Thread safety: unsafe

Unequipped()

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:Tool/Unequipped.
  • Thread safety: unsafe

External links

Advertisement