ManualActivationOnly

Property of: Tool

Value Type: bool

Description:

The ManualActivationOnly property controls whether the Tool can be activated without explicitly executing Tool/Activate in a script.

When set to true, the tool will only fire Tool/Activated when Tool/Activate is called. This also suppresses the ContextActionService’s ContextActionService/BindActivate function.

When set to false, mouse clicks (when the tool is equipped) will also fire Tool/Activated.

Code Samples

Sprint Tool

The code sample below creates Tool in the Players/LocalPlayer|LocalPlayer's Backpack that increases the player’s Humanoid/Walkspeed|WalkSpeed from 16 to 30 for 5 seconds.

This example uses the tool’s Tool/ManualActivationOnly property as a debounce by setting the property to true when the player begins sprinting and to false when the player stops sprinting. As a result, when the player is sprinting the tool cannot be activated by pressing the left mouse button.

Unequipping the tool also stops the player from sprinting by changing the WalkSpeed to 16.

			
				Sprint Tool

				Expected Output
			
				Expand
				
			local player = game.Players.LocalPlayer
local character = player.Character
local humanoid = character.Humanoid

local tool = Instance.new("Tool")
tool.Name = "Sprint"
tool.RequiresHandle = false
tool.Parent = player.Backpack

local invisible = false

function toolActivated()
	humanoid.WalkSpeed = 30
	tool.ManualActivationOnly = true
	wait(5)
	tool.ManualActivationOnly = false
	humanoid.WalkSpeed = 16
end

tool.Activated:Connect(toolActivated)
tool.Unequipped:Connect(function() humanoid.WalkSpeed = 16 end)
		
				Copy Code
			
				Light Theme