Players will need something like an ax or a shovel to gather items with. In Roblox, items that players can equip and use are called tools. This lesson uses a starter tool with all the parts and an animation already made that can be customized later.

Setting up the Tool

To give players a tool at the start of the game, place it into the StarterPack.

Add the Tool to StarterPack

1. Download the starter tool here if it’s not already on your computer. Remember where you save it to.
2. In Explorer, under Workspace, right-click on StarterPack.

3. Select Insert from File.

4. Find the downloaded starter tool on your computer and open it.
5. Rename StarterTool to the name you want players to see. For example, Scoop.
6. Playtest your game. Players should be equipped with the scoop as soon as they start the game.

Setting Up the Tool Script

If the tool hits a harvestable object and the player has enough space in their bag, the player’s item count will go up by 1 on the leaderboard. Harvesting an item will make it disappear for a few seconds and become unharvestable for a few seconds before reappearing. This encourages players to explore to find more items, instead of just clicking the same item.

Create a new Script

1. Go back to StarterPack, under Scoop, add a new script named ToolScript.

2. Add a comment at the top.
3. In ToolScript, type:

-- Gives players items when tool hits cupcakes
local tool = script.Parent
local scoop = tool.Scoop

Check if Item is Harvestable

Whenever the tool touches an object, it’ll check if that object has CanHarvest inside and if the boolean is set to True.

1. Create a new function named onTouch with a parameter named partTouched.

local tool = script.Parent
local scoop = tool.Scoop

local function onTouch(partTouched)
	
end

2. In local function onTouch, type local canHarvest = partTouched.Parent:FindFirstChild(“CanHarvest”)

local function onTouch(partTouched)
	local canHarvest = partTouched.Parent:FindFirstChild("CanHarvest")
end

3. Under local canHarvest, type if canHarvest then and press Enter autocomplete add end

local function onTouch(partTouched)
	local canHarvest = partTouched.Parent:FindFirstChild("CanHarvest")
	if canHarvest then
		
	end
end

4. Under if canHarvest then, type print("Found an item"). This will help you check if your script is working.

if canHarvest then
     -- Used for testing if code works
	print("Found an item")
end

5. Under the function’s end, type scoop.Touched:Connect(onTouch). This lets the script check if anything is touching the scoop and if so, will call onTouch.

local function onTouch(partTouched)
	local canHarvest = partTouched.Parent:FindFirstChild("CanHarvest")
	if canHarvest then
		print("Found an item")
	end
end

scoop.Touched:Connect(onTouch)

6. Play the game and use the tool on a cupcake. Check in the Output Window that you get the message: "Found an Item" when touching that cupcake.

Get the Leaderboard Stats

Before increasing the player’s items, the tool must find the location of how many items a player has in that player’s leaderboard.

1. First, get the player using the tool. In the ToolScript, under local scoop = toolScoop, and above the custom function, type:

local scoop = toolScoop

local backpack = tool.Parent
local player = backpack.Parent

local function onTouch(partTouched)

2. On the next line, find the player’s leaderstats. Type local playerStats = player:FindFirstChild(“leaderstats”)

local backpack = tool.Parent
local player = backpack.Parent
local playerStats = player:FindFirstChild("leaderstats")

local function onTouch(partTouched)

3. Under local playerStats, create variables for the items and spaces stats. Type:

local playerStats = player:FindFirstChild("leaderstats")
-- Gets the player's items and spaces from their leaderboard
local playerItems = playerStats:FindFirstChild("Items")
local playerSpaces = playerStats:FindFirstChild("Spaces")

Check If the Object is Harvestable

Now that the tool script has the playerItems and playerSpaces variables created, you can start giving players an item point for each cupcake they harvest. Use the function created to check if the object touching the tool can be harvested, and if the player has enough space in their bag to increase the items shown on the leaderboard by one.

1. To check if the item can be harvested, type if canHarvest.Value == true. Don’t autocomplete the function yet.

local function onTouch(partTouched)
	local canHarvest = partTouched.Parent:FindFirstChild("CanHarvest")
	if canHarvest then
           print("Found an item")
		if canHarvest.Value == true 

	end
end

2. To check if the player has space for more items, on the same line, add and playerItems.Value < playerSpaces.Value then and press Enter to autocomplete the if statement. If statements within other if statements are called nested if statements.

local function onTouch(partTouched)
	local canHarvest = partTouched.Parent:FindFirstChild("CanHarvest")
	if canHarvest then
		if canHarvest.Value == true and playerItems.Value < playerSpaces.Value then
			
		end
	end
end

3. Under then, type playerItems.Value = playerItems.Value + 1

if canHarvest then
	if canHarvest.Value == true and playerItems.Value < playerSpaces.Value then
			playerItems.Value = playerItems.Value + 1
			
	end
end

4. Play your project; use your tool to harvest a cupcake.

Make the Object Reset

After a player harvests the item, the item should disappear and CanHarvest set to false for a short time before becoming harvestable again.

1. In onTouch, under playerItems.Value = playerItems.Value + 1, set canHarvest.Value to false.

if canHarvest then
	if canHarvest.Value == true and playerItems.Value < playerSpaces.Value then
		playerItems.Value = playerItems.Value + 1
		canHarvest.Value = false
	end
end

2. After canHarvest.Value = false, type the following:

if canHarvest.Value == true and playerItems.Value < playerSpaces.Value then
	playerItems.Value = playerItems.Value + 1
	canHarvest.Value = false
	partTouched.Transparency = 1 
	partTouched.CanCollide = false
end

3. Type wait(5). This makes the script wait 5 seconds before making the item reappear. You can change 5 seconds to any number that’s fair for your game.

if canHarvest.Value == true and playerItems.Value < playerSpaces.Value then
	playerItems.Value = playerItems.Value + 1
	canHarvest.Value = false
	partTouched.Transparency = 1 
	partTouched.CanCollide = false
	wait(5)
end

4. After wait(5), type the following to make the cupcake reappear:

	wait(5)
	canHarvest.Value = true
	partTouched.Transparency = 0 
	partTouched.CanCollide = true
end

5. Play your game and check that:

These documents are licensed by Roblox Corporation under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Roblox, Powering Imagination, and Robux are trademarks of Roblox Corporation, registered in the United States and other countries.