RBX.lua.Tool (Object)

Up one category:
Class reference

[▲] Tool (extends BackpackItem) method Clone method FindFirstChild method GetChildren method GetDebugId method GetFullName method IsA method IsAncestorOf method IsDescendantOf method Destroy method ClearAllChildren property Enabled property BackendToolState property GripForward property GripPos property GripRight property GripUp property ActivationState property Grip property ToolTip property CanBeDropped property TextureId property Name property Parent property Archivable property ClassName property RobloxLocked property DataCost event Activated event Deactivated event Equipped event Unequipped event AncestryChanged event Changed event ChildAdded event ChildRemoved event DescendantAdded event DescendantRemoving

The Tool object acts as a weapon or other object that is stored in a Player's Backpack. When equipped, a tool is automatically transferred to the Player's character and it is held in the right hand by default. Tools require scripting and a part named Handle in it to function properly. Hammer tool selected, with the shortcut of 5.

Clone( )
Returns	Instance
Description:	Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of:	Instance

FindFirstChild( string name, bool recursive = false )
Returns	Instance
Description:	Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of:	Instance

GetChildren( )
Returns	table
Description:	Returns a read-only table of the object's children.
Member of:	Instance

GetFullName( )
Returns	String path to object
Description:	Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of:	Instance

IsA( string className )
Returns	bool
Description:	Returns true if the Instance is that class or a subclass.
Member of:	Instance

IsAncestorOf( Instance descendant )
Returns	boolean is ancestor
Description:	Returns true if the object is an ancestor of descendant.
Member of:	Instance

IsDescendantOf( Instance ancestor )
Returns	bool
Description:	Returns true if the object is an descendant of ancestor.
Member of:	Instance

Remove( )
Returns	nil
Description:	Sets the Parent property to nil and calls Remove() on all children.
Member of:	Instance

Name
Type	string
Description	The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of	Instance

Parent
Type	Instance
Description	The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of	Instance

Archivable
Type	bool
Description	Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of	Instance

ClassName
Type	string
Description	A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of	Instance

Enabled
Property	Bool Enabled
Description	Enables the functionality of an object
Member of	Flag, Sparkles, Tool, Fire, StudioTool

GripForward
Property	Vector3 GripForward
Description	This is one of the properties that edits a Tool's position in someone's hand.
Member of	Tool, Flag

GripPos
Property	Vector3 GripPos
Description	This is one of the properties that edits a Tool's position in someone's hand.
Member of	Tool

GripRight
Property	Vector3 GripRight
Description	This is one of the properties that edits a Tool's position in someone's hand.
Member of	Tool, Flag

GripUp
Property	Vector3 GripUp
Description	This is one of the properties that edits a Tool's position in someone's hand.
Member of	Tool, Flag

TextureId
Type	Content
Description	The URL link to an image, commonly known as a texture.
Member of	BackpackItem, FileMesh

AncestryChanged ( Instance child, Instance parent )
Description	Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of:	Instance

Changed ( Property property )
Description	Fired whenever a property of the object changes.
Member of:	Instance

ChildAdded ( Instance child )
Description	Fired after a child is added.
Member of:	Instance

ChildRemoved ( Instance child )
Description	Fired when a child is removed from the object.
Member of:	Instance

DescendantAdded ( Instance descendant )
Description	Fired when a descendant is added to the object.
Member of:	Instance

DescendantRemoving ( Instance descendant )
Description	Fired when a descendant is being removed.
Member of:	Instance

Activated ( )
Description	Fired when the player clicks while a tool is equipped.
Member of:	Tool, StudioTool

Deactivated ( )
Description	Fired immediately after the Activated event.
Member of:	Tool

Equipped ( Mouse mouse )
Description	Fired when tool is equipped.
Member of:	Tool

Equipped ( Instance humanoid, Instance skateboardController )
Description	Fired when a skateboard is equipped.
Member of:	SkateboardPlatform

Description

This event is triggered even a tool is equipped.

In a LocalScript:

Example

local function onEquipped(mouse)
  mouse.KeyDown:connect(onKeyDown)
  mouse.Button1Down.connect(function() onButton1Down(mouse) end)
end
tool.Equipped:connect(onEquipped)

Getting The Mouse Secretly

In one of your games you might want a player to have to click or press a key or something, but what if you don't want them to have to select a hopperbin or tool? One neat thing we can do with the tool is parent it into a player, and the equipped event will fire, giving us their mouse. Then we can do the clicking and pressing stuffs and delete the tool! Here's an example of a script that would get the mouse without them seeing anything:

Example

--This would go in the starterpack.
Player = script.Parent.Parent --Get the player.
Tool = Instance.new("Tool") --Create a tool.
Handle = Instance.new("Part",Tool) --Make a handle part so it will equip.
Handle.Name = "Handle" --Make sure it's called handle, or it won't work.
Tool.Equipped:connect(function(mouse) --When it's equipped fire a function.
    Tool.Parent = nil --Delete the tool so they don't see anything.
    mouse.KeyDown:connect(function(key) --When they press a key fire a function.
        print(key) --Print the key they pressed.
    end) --End the key function.
end) --End the equip function.
Tool.Parent = Player.Character --Parent it to the their character AFTER we have the equipped function ready so it will fire.

Now when the player presses a key it will print, and they didn't have to equip a tool or do anything!

Limitations

• Tool may equip before script add the connection, if both are added to Workspace on another machine.
• This event may not fire if the tool moves or removes before it reaches the right state.

Unequipped ( )
Description	Fired whenever you unequipp the object.
Member of:	Tool, Flag, SkateboardPlatform