Skip to content

Use of Non-Roblox Tool Instances #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MrModification wants to merge 2 commits into from
Closed

Use of Non-Roblox Tool Instances #132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3e4fb4
--CustomTools
MrModification Feb 20, 2026
a244896
--Customtool bugfix
MrModification Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 102 additions & 35 deletions src/init.luau
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
]]

local ContextActionService = game:GetService("ContextActionService")
local GuiService = game:GetService("GuiService")
local Players = game:GetService("Players")
local RunService = game:GetService("RunService")
local StarterGui = game:GetService("StarterGui")
local TextChatService = game:GetService("TextChatService")
local UserInputService = game:GetService("UserInputService")
local StarterGui = game:GetService("StarterGui")
local GuiService = game:GetService("GuiService")
local RunService = game:GetService("RunService")
local VRService = game:GetService("VRService")
local Players = game:GetService("Players")
local PlayerGui: Instance = Players.LocalPlayer:WaitForChild("PlayerGui")

local BackpackScript = {}
Expand Down Expand Up @@ -340,9 +340,26 @@ local function DisableActiveHopper(): () --NOTE: HopperBin
ActiveHopper = nil :: any
end

local function UnequipCustomTools(exception: Instance?): ()
if Humanoid then
for _, v in Character:GetChildren() do
if v:GetAttribute("Tool") and v ~= exception then
v.Parent = Backpack
end
end
end
end

local function EquipCustomTool(tool: Tool): ()
if Humanoid then
tool.Parent = Character
end
end

local function UnequipAllTools(): () --NOTE: HopperBin
if Humanoid then
Humanoid:UnequipTools()
UnequipCustomTools()
if ActiveHopper then
DisableActiveHopper()
end
Expand All @@ -351,8 +368,12 @@ end

local function EquipNewTool(tool: Tool): () --NOTE: HopperBin
UnequipAllTools()
Humanoid:EquipTool(tool) --NOTE: This would also unequip current Tool
--tool.Parent = Character --TODO: Switch back to above line after EquipTool is fixed!
if tool:GetAttribute("Tool") then
EquipCustomTool(tool)
else
Humanoid:EquipTool(tool) --NOTE: This would also unequip current Tool
--tool.Parent = Character --TODO: Switch back to above line after EquipTool is fixed!
end
end

local function IsEquipped(tool: Tool): boolean
Expand All @@ -375,6 +396,7 @@ local function MakeSlot(parent: Instance, initIndex: number?): GuiObject
local ToolIcon: ImageLabel = nil
local ToolName: TextLabel = nil
local ToolChangeConn: any = nil
local ToolAttributeConn: any = nil
local HighlightFrame: any = nil -- UIStroke
local SelectionObj: ImageLabel = nil

Expand Down Expand Up @@ -411,32 +433,26 @@ local function MakeSlot(parent: Instance, initIndex: number?): GuiObject

-- Update the slot with tool data
local function assignToolData(): ()
local icon: string = tool.TextureId
local icon: string = tool:GetAttribute("Icon") or (tool:IsA("Tool") and tool.TextureId) or ""
ToolIcon.Image = icon
ToolName.Visible = (icon == "")

if icon ~= "" then
-- Enable the tool name on the slot if there is no icon
ToolName.Visible = false
else
ToolName.Visible = true
end
ToolName.Text = tool:GetAttribute("DisplayName") or tool.Name

ToolName.Text = tool.Name
local itemToolTip = tool:GetAttribute("ToolTip") or (tool:IsA("Tool") and tool.ToolTip) or ""

-- If there is a tooltip, then show it
if ToolTip and tool:IsA("Tool") then --NOTE: HopperBin
ToolTip.Text = tool.ToolTip
if itemToolTip ~= "" then
ToolTip.Text = itemToolTip
ToolTip.Size = UDim2.fromOffset(0, TOOLTIP_HEIGHT)
ToolTip.Position = UDim2.new(0.5, 0, 0, TOOLTIP_OFFSET)
end
end

assignToolData()

-- Disconnect tool event if it exists
if ToolChangeConn then
ToolChangeConn:Disconnect()
ToolChangeConn = nil
end
if ToolChangeConn then ToolChangeConn:Disconnect() ToolChangeConn = nil end
if ToolAttributeConn then ToolAttributeConn:Disconnect() ToolAttributeConn = nil end

-- Update the slot with new tool data if the tool's properties changes
ToolChangeConn = tool.Changed:Connect(function(property: string): ()
Expand All @@ -445,6 +461,14 @@ local function MakeSlot(parent: Instance, initIndex: number?): GuiObject
end
end)

-- Update on Attribute changes (Important for Custom Tools)
ToolAttributeConn = tool.AttributeChanged:Connect(function(attribute: string)
if attribute == "Icon" or attribute == "DisplayName" or attribute == "ToolTip" then
assignToolData()
end
end)

-- Handling Draggable state
local hotbarSlot: boolean = (self.Index <= NumberOfHotbarSlots)
local inventoryOpen: boolean = InventoryFrame.Visible

Expand Down Expand Up @@ -934,16 +958,29 @@ local function MakeSlot(parent: Instance, initIndex: number?): GuiObject
end

local function OnChildAdded(child: Instance): () -- To Character or Backpack
if not child:IsA("Tool") and not child:IsA("HopperBin") then --NOTE: HopperBin
local isCustomItem = child:GetAttribute("Tool") ~= nil
local isRobloxTool = child:IsA("Tool") or child:IsA("HopperBin")

if not isRobloxTool and not isCustomItem then
if child:IsA("Humanoid") and child.Parent == Character then
Humanoid = child
end
return
end

local tool: any = child

if tool.Parent == Character then
ShowVRBackpackPopup()
if isRobloxTool then
UnequipCustomTools()
else
UnequipCustomTools(tool)
Humanoid:UnequipTools()
if ActiveHopper then
DisableActiveHopper()
end
end
end

if ActiveHopper and tool.Parent == Character then --NOTE: HopperBin
Expand Down Expand Up @@ -1001,7 +1038,10 @@ local function OnChildAdded(child: Instance): () -- To Character or Backpack
end

local function OnChildRemoved(child: Instance): () -- From Character or Backpack
if not child:IsA("Tool") and not child:IsA("HopperBin") then --NOTE: HopperBin
local isCustomItem = child:GetAttribute("Tool") ~= nil
local isRobloxTool = child:IsA("Tool") or child:IsA("HopperBin")

if not isRobloxTool and not isCustomItem then
return
end
local tool: Tool | any = child
Expand All @@ -1013,7 +1053,17 @@ local function OnChildRemoved(child: Instance): () -- From Character or Backpack
if newParent == Character or newParent == Backpack then
return
end


if isCustomItem then
local canDrop = child:GetAttribute("CanBeDropped")
if canDrop == true then
child.Parent = workspace
else
child.Parent = Backpack
return
end
end

local slot: any = SlotsByTool[tool]
if slot then
slot:Clear()
Expand Down Expand Up @@ -1230,12 +1280,12 @@ changeToolFunc = function(actionName: string, inputState: Enum.UserInputState, i
if
(
lastChangeToolInputObject.KeyCode == Enum.KeyCode.ButtonR1
and inputObject.KeyCode == Enum.KeyCode.ButtonL1
)
or (
lastChangeToolInputObject.KeyCode == Enum.KeyCode.ButtonL1
and inputObject.KeyCode == Enum.KeyCode.ButtonR1
and inputObject.KeyCode == Enum.KeyCode.ButtonL1
)
or (
lastChangeToolInputObject.KeyCode == Enum.KeyCode.ButtonL1
and inputObject.KeyCode == Enum.KeyCode.ButtonR1
)
then
if (os.clock() - lastChangeToolInputTime) <= maxEquipDeltaTime then
UnequipAllTools()
Expand Down Expand Up @@ -1793,14 +1843,14 @@ local function resizeGamepadHintsFrame(): ()
for i: number = 1, #filteredGamepadHints do
filteredGamepadHints[i].Position = (
i == 1 and UDim2.new(0, 0, 0, 0)
or UDim2.new(
0,
filteredGamepadHints[i - 1].Position.X.Offset
or UDim2.new(
0,
filteredGamepadHints[i - 1].Position.X.Offset
+ filteredGamepadHints[i - 1].Size.X.Offset
+ spaceBetweenElements,
0,
0
)
0,
0
)
)
filteredGamepadHints[i].Size = UDim2.new(
0,
Expand Down Expand Up @@ -2100,6 +2150,23 @@ do -- Hotkey stuff
if ActiveHopper then
UnequipAllTools()
end

local customTool = nil
for _, v in Character:GetChildren() do
if v:GetAttribute("Tool") then
customTool = v
break
end
end

if customTool then
local canDrop = customTool:GetAttribute("CanBeDropped")
if canDrop == true then
customTool.Parent = workspace
else
customTool.Parent = Backpack
end
end
end

-- Listen to keyboard status, for showing/hiding hotkey labels
Expand Down
Loading