Tool
Represents an equippable player tool.
- Creatable
Instance.new("Tool")- Inherits
- Instance
- Replication
- Standard
Behavior
Tool represents an equippable player tool.
Summary
Whether the player can drop the Tool.
Whether this tool is enabled.
The local transform used to hold the Tool.
The forward basis vector of the Tool's grip.
The position component of the Tool's grip.
The right basis vector of the Tool's grip.
The up basis vector of the Tool's grip.
Whether the Tool requires activation through its API rather than automatic input handling.
Whether the Tool requires a child Part named Handle.
The asset identifier of the mesh texture.
The text displayed for the Tool in the inventory interface.
Activates the Tool.
Ends the Tool's active state.
Returns this instance if it is an ExecutionGroup.
Attempts to activate the Tool and reports whether activation succeeded.
Fires when the Tool is activated.
Fires when the Tool is deactivated.
Fires when the Tool is equipped.
Fires when the Tool is unequipped.
Properties
CanBeDropped
Tool.CanBeDropped: boolean = trueWhether the player can drop the Tool.
Enabled
Tool.Enabled: boolean = trueWhether this tool is enabled.
Grip
Tool.Grip: CFrame = CFrame.new(0, 0, 0)The local transform used to hold the Tool.
GripForward
Tool.GripForward: Vector3 = Vector3.new(0, 0, -1)The forward basis vector of the Tool's grip.
GripPos
Tool.GripPos: Vector3 = Vector3.new(0, 0, 0)The position component of the Tool's grip.
GripRight
Tool.GripRight: Vector3 = Vector3.new(1, 0, 0)The right basis vector of the Tool's grip.
GripUp
Tool.GripUp: Vector3 = Vector3.new(0, 1, 0)The up basis vector of the Tool's grip.
ManualActivationOnly
Tool.ManualActivationOnly: boolean = falseWhether the Tool requires activation through its API rather than automatic input handling.
RequiresHandle
Tool.RequiresHandle: boolean = trueWhether the Tool requires a child Part named Handle.
TextureId
Tool.TextureId: Content = ""The asset identifier of the mesh texture.
ToolTip
Tool.ToolTip: string = ""The text displayed for the Tool in the inventory interface.
Methods
Activate
Tool:Activate(): ()Activates the Tool.
Deactivate
Tool:Deactivate(): ()Ends the Tool's active state.
GetExecutionGroup
Tool:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
TryActivate
Tool:TryActivate(player: Player, cooldownSeconds: number): booleanAttempts to activate the Tool and reports whether activation succeeded.
Events
Activated
Tool.Activated: RBXScriptSignalFires when the Tool is activated.
Deactivated
Tool.Deactivated: RBXScriptSignalFires when the Tool is deactivated.
Equipped
Tool.Equipped: RBXScriptSignalFires when the Tool is equipped.
Unequipped
Tool.Unequipped: RBXScriptSignalFires when the Tool is unequipped.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying