FANDOM


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

Pubfield bool CanBeDropped

Whether or not this tool can be dropped by equipping it and pressing backspace.

Category: Behavior.

Serialization: can save and load.

Pubfield bool Enabled

Whether or not this tool can be used.

Category: State.

Serialization: can save and load.

Pubfield CFrame Grip

Category: Appearance.

Serialization: can save and load.

Pubfield Vector3 GripForward

Category: Appearance.

Serialization: can load only.

Tags: NotReplicated.

Pubfield Vector3 GripPos

Category: Appearance.

Serialization: can load only.

Tags: NotReplicated.

Pubfield Vector3 GripRight

Category: Appearance.

Serialization: can load only.

Tags: NotReplicated.

Pubfield Vector3 GripUp

Category: Appearance.

Serialization: can load only.

Tags: NotReplicated.

Pubfield bool ManualActivationOnly

Whether or not the Activate function can be called.

Category: Behavior.

Serialization: can save and load.

Pubfield bool RequiresHandle

Whether or not this tool requires a part called "Handle" to function.

Category: Behavior.

Serialization: can save and load.

Pubfield string ToolTip

The text that shows when hovering over this tool in a player's backpack.

Category: Appearance.

Serialization: can save and load.

Functions

Pubmethod void Activate()

Simulates the user clicking with this tool equipped.

Pubmethod void Deactivate()

Events

Pubevent Activated()

Fires when the mouse is clicked after the tool is equipped.

Pubevent Deactivated()

Pubevent Equipped(Instance mouse)

Fires when the tool is selected.

Pubevent Unequipped()

Fires when the tool is unselected.


External links

Community content is available under CC-BY-SA unless otherwise noted.