Refines grapple gun mechanics and input handling

Improves the grapple gun's behavior for a more consistent and reliable experience.

- Standardizes unhooking: R-key (reload) unhooks when the gun is equipped, while a double-crouch tap unhooks when the gun is not actively held but present in inventory.
- Allows the grapple line to persist and be controlled even if the gun is unequipped, as long as it remains in the player's inventory.
- Significantly tightens grapple attachment collision detection for more precise and predictable sticking to terrain and objects.
- Ensures the gun's magazine visually reflects the grapple's state, appearing empty and hidden when the grapple is active, and full when retracted.
- Adds a safeguard in firearm logic to prevent issues if a magazine attempts to pop a non-existent round.

Author: OpenTools-run

Data/Base.rte/Devices/Tools/GrappleGun/Grapple.lua

@@ -192,7 +192,8 @@ function Update(self)
 
     local parentActor = self.parent -- self.parent is already an Actor type from the setup block
 
-    if not self.parentGun or self.parentGun.ID == rte.NoMOID or not parentActor:HasObject("Grapple Gun") then
+    -- Remove the HasObject check - allow grapple to persist even when gun is not equipped
+    if not self.parentGun or self.parentGun.ID == rte.NoMOID then
         self.ToDelete = true
         return
     end
@@ -347,40 +348,38 @@ function Update(self)
         if parentActor:IsPlayerControlled() then
             local controller = self.parent:GetController()
             if controller then
-                -- ONLY use RopeInputController for all input handling
-                
-                -- 1. R key to unhook (when holding gun)
+                -- 1. Handle R key (reload) to unhook - use the module function
                 if RopeInputController.handleReloadKeyUnhook(self, controller) then
-                    print("Unhooking via R key!")
                     self.ToDelete = true
                     return
                 end
 
-                -- 2. Double crouch-tap to unhook (when NOT holding gun)
-                if RopeInputController.handleTapDetection(self, controller) then
-                    print("Unhooking via double crouch!")
+                -- 2. Handle pie menu unhook commands
+                if RopeInputController.handlePieMenuSelection(self) then
                     self.ToDelete = true
                     return
                 end
 
-                -- 3. Pie menu unhook
-                if RopeInputController.handlePieMenuSelection(self) then
-                    print("Unhooking via pie menu!")
+                -- 3. Handle double-tap crouch to unhook - use the module function
+                if RopeInputController.handleTapDetection(self, controller) then
                     self.ToDelete = true
                     return
                 end
 
-                -- 4. Other rope controls
+                -- Set magazine to empty when grapple is active
+                if self.parentGun.Magazine then
+                    self.parentGun.Magazine.RoundCount = 0
+                    self.parentGun.Magazine.Scale = 0 -- Hide the magazine
+                end
+                
+                -- 4. Other rope controls (climbing, length adjustment)
                 RopeInputController.handleRopePulling(self)
                 RopeInputController.handleAutoRetraction(self, false)
             end
         end
 
         -- Gun stance offset when holding the gun
         if self.parentGun and self.parentGun.RootID == parentActor.ID then
-             if MovableMan:IsParticle(self.parentGun.Magazine) then -- Check if Magazine is a particle
-                ToMOSParticle(self.parentGun.Magazine).RoundCount = 0 -- Visually empty
-             end
             local offsetAngle = parentActor.FlipFactor * (self.lineVec.AbsRadAngle - parentActor:GetAimAngle(true))
             self.parentGun.StanceOffset = Vector(self.lineLength, 0):RadRotate(offsetAngle)
         end
@@ -391,12 +390,12 @@ function Update(self)
 
     -- Final deletion check and cleanup
     if self.ToDelete then
-        if self.parentGun and MovableMan:IsParticle(self.parentGun.Magazine) then
-            local mag = ToMOSParticle(self.parentGun.Magazine)
-            -- Show magazine briefly as if hook is retracting
-            mag.Pos = parentActor.Pos + (self.lineVec * 0.5)
-            mag.Scale = 1
-            mag.Frame = 0 -- Assuming frame 0 is the visible magazine
+        if self.parentGun and self.parentGun.Magazine then
+            -- Show the magazine as if the hook is being retracted
+            local drawPos = parentActor.Pos + (self.lineVec * 0.5)
+            self.parentGun.Magazine.Pos = drawPos
+            self.parentGun.Magazine.Scale = 1
+            self.parentGun.Magazine.Frame = 0
         end
         if self.returnSound then self.returnSound:Play(parentActor.Pos) end
     end
@@ -409,12 +408,14 @@ function Destroy(self)
 
     -- Clean up references on the parent gun
     if self.parentGun and self.parentGun.ID ~= rte.NoMOID then
-        self.parentGun.HUDVisible = true -- Assuming it was hidden
+        self.parentGun.HUDVisible = true
         self.parentGun:RemoveNumberValue("GrappleMode")
-        -- Reset stance offset if it was modified
-        self.parentGun.StanceOffset = Vector(0,0) 
-        if MovableMan:IsParticle(self.parentGun.Magazine) then
-            ToMOSParticle(self.parentGun.Magazine).Scale = 1 -- Ensure magazine is visible
+        self.parentGun.StanceOffset = Vector(0,0)
+        
+        -- Restore and show magazine when grapple is destroyed
+        if self.parentGun.Magazine then
+            self.parentGun.Magazine.RoundCount = 1 -- Restore to 1 round when grapple returns
+            self.parentGun.Magazine.Scale = 1 -- Make magazine visible again
         end
     end
 end

Data/Base.rte/Devices/Tools/GrappleGun/GrappleGun.lua

@@ -40,72 +40,70 @@ function Create(self)
         -- Log an error or warning if preset is missing/incorrect
         -- print("Warning: Grapple Gun Guide Arrow preset not found or incorrect type.")
     end
+
+    self.originalRoundCount = 1
+    self.hasGrappleActive = false
 end
 
 function Update(self)
     local parent = self:GetRootParent()
 
     -- Ensure the gun is held by a valid, player-controlled Actor.
     if not parent or not IsActor(parent) then
-        self:Deactivate() -- If not held by an actor, deactivate.
+        self:Deactivate()
         return
     end
 
-    local parentActor = ToActor(parent) -- Cast to Actor base type
-    -- Specific casting to AHuman or ACrab can be done if needed for type-specific logic
+    local parentActor = ToActor(parent)
 
     if not parentActor:IsPlayerControlled() or parentActor.Status >= Actor.DYING then
-        self:Deactivate() -- Deactivate if not player controlled or if player is dying.
+        self:Deactivate()
         return
     end
 
     local controller = parentActor:GetController()
     if not controller then
-        self:Deactivate() -- Should not happen if IsPlayerControlled is true, but good check.
+        self:Deactivate()
         return
     end
 
-    -- REMOVE/COMMENT OUT this section that deactivates in background:
-    --[[
-    if parentActor.EquippedBGItem and parentActor.EquippedBGItem.ID == self.ID and parentActor.EquippedItem then
-        self:Deactivate()
-        // Potentially return here if no further logic should run for a BG equipped grapple gun.
-    end
-    --]]
-    
-    -- Allow gun to stay active in background for rope functionality
-
     -- Magazine handling (visual representation of the hook's availability)
     if self.Magazine and MovableMan:IsParticle(self.Magazine) then
         local magazineParticle = ToMOSParticle(self.Magazine)
 
-        -- Double tapping crouch retrieves the hook (if a grapple is active)
-        -- This logic seems to be for initiating a retrieve action from the gun itself.
-        -- The actual unhooking is handled by the Grapple.lua script's tap detection.
-        -- This section might be redundant if Grapple.lua's tap detection is comprehensive.
-        if magazineParticle.Scale == 1 then -- Assuming Scale 1 means hook is "loaded" / available to fire
-            -- The following stance offsets seem to be for when the hook is *not* fired yet.
-            -- Consider if this is the correct condition.
-            local parentSprite = ToMOSprite(self:GetParent()) -- Assuming self:GetParent() is the gun's sprite component
+        -- Check if we have an active grapple
+        local hasActiveGrapple = false
+        for mo in MovableMan.AddedActors do
+            if mo and mo.PresetName == "Grapple Gun Claw" and mo.parentGun and mo.parentGun.ID == self.ID then
+                hasActiveGrapple = true
+                break
+            end
+        end
+        
+        -- Update magazine based on grapple state
+        if hasActiveGrapple then
+            magazineParticle.RoundCount = 0 -- Empty when grapple is out
+            magazineParticle.Scale = 0 -- Hidden
+            self.hasGrappleActive = true
+        elseif self.hasGrappleActive and not hasActiveGrapple then
+            -- Grapple just returned, restore ammo
+            magazineParticle.RoundCount = 1
+            magazineParticle.Scale = 1
+            magazineParticle.Frame = 0
+            self.hasGrappleActive = false
+        end
+        
+        -- Set stance offset when hook is loaded
+        if magazineParticle.Scale == 1 then
+            local parentSprite = ToMOSprite(self:GetParent())
             if parentSprite then
                 local spriteWidth = parentSprite:GetSpriteWidth() or 0
                 self.StanceOffset = Vector(spriteWidth, 1)
                 self.SharpStanceOffset = Vector(spriteWidth, 1)
             end
-
-            -- REMOVE the entire crouch-tap section from the gun - it should only be in the hook
-            -- The gun should NOT handle unhooking directly
-            
-            -- Only keep this for other gun functionality, NOT for unhooking:
-            if controller:IsState(Controller.WEAPON_RELOAD) then
-                -- Gun's own reload logic here (if any)
-                -- Do NOT send unhook signals from here
-            end
-            
         end
 
         -- Guide arrow visibility logic
-        -- Show if magazine scale is 0 (hook is fired) AND not sharp aiming, OR if parent is moving fast.
         local shouldShowGuide = false
         if magazineParticle.Scale == 0 and not controller:IsState(Controller.AIM_SHARP) then
             shouldShowGuide = true
@@ -114,55 +112,26 @@ function Update(self)
         end
         self.guide = shouldShowGuide
     else
-        self.guide = false -- No magazine or not a particle, so no guide based on it.
+        self.guide = false
     end
 
     -- Draw the guide arrow if enabled and valid
     if self.guide and self.arrow and self.arrow.ID ~= rte.NoMOID then
         local frame = 0
         if parentActor.Vel and parentActor.Vel:MagnitudeIsGreaterThan(12) then
-            frame = 1 -- Use a different arrow frame for higher speeds
+            frame = 1
         end
 
-        -- Calculate positions for drawing the arrow
-        -- EyePos might not exist on all Actor types, ensure parentActor has it or use a fallback.
-        local eyePos = parentActor.EyePos or Vector(0,0) 
-        local startPos = (parentActor.Pos + eyePos + self.Pos)/3 -- Averaged position
+        local eyePos = parentActor.EyePos or Vector(0,0)
+        local startPos = (parentActor.Pos + eyePos + self.Pos)/3
         local aimAngle = parentActor:GetAimAngle(true)
-        local aimDistance = parentActor.AimDistance or 50 -- Default AimDistance if not present
+        local aimDistance = parentActor.AimDistance or 50
         local guidePos = startPos + Vector(aimDistance + (parentActor.Vel and parentActor.Vel.Magnitude or 0), 0):RadRotate(aimAngle)
 
-        -- Ensure the arrow MO still exists before trying to draw with it
         if MovableMan:IsValid(self.arrow) then
              PrimitiveMan:DrawBitmapPrimitive(ActivityMan:GetActivity():ScreenOfPlayer(controller.Player), guidePos, self.arrow, aimAngle, frame)
         else
-            self.arrow = nil -- Arrow MO was deleted, nullify reference
-        end
-    end
-    
-    -- Ensure magazine is visually "full" and ready if no grapple is active.
-    -- This assumes the HDFirearm's standard magazine logic handles firing.
-    -- If a grapple claw MO (the projectile) is active, Grapple.lua will hide the magazine.
-    -- This section ensures it's visible when no grapple is out.
-    if self.Magazine and MovableMan:IsParticle(self.Magazine) then
-        local magParticle = ToMOSParticle(self.Magazine)
-        local isActiveGrapple = false
-        -- Check if there's an active grapple associated with this gun
-        for mo_instance in MovableMan:GetMOsByPreset("Grapple Gun Claw") do
-            if mo_instance and mo_instance.parentGun and mo_instance.parentGun.ID == self.ID then
-                isActiveGrapple = true
-                break
-            end
-        end
-
-        if not isActiveGrapple then
-            magParticle.RoundCount = 1 -- Visually full
-            magParticle.Scale = 1      -- Visible
-            magParticle.Frame = 0      -- Standard frame
-        else
-            magParticle.Scale = 0 -- Hidden by active grapple (Grapple.lua also does this)
-            magParticle.RoundCount = 0 -- Visually empty
-
+            self.arrow = nil
         end
     end
 end

Data/Base.rte/Devices/Tools/GrappleGun/Pie.lua

@@ -2,26 +2,6 @@
 -- RopeStateManager might not be directly needed here if we only set GrappleMode on the gun.
 -- local RopeStateManager = require("Devices.Tools.GrappleGun.Scripts.RopeStateManager")
 
--- Action for Retract slice in the pie menu.
-function GrapplePieRetract(pieMenuOwner, pieMenu, pieSlice)
-    if pieMenuOwner and pieMenuOwner.EquippedItem then
-        local gun = ToMOSRotating(pieMenuOwner.EquippedItem) -- Assume it's a MOSRotating
-        if gun and gun.PresetName == "Grapple Gun" then -- Ensure it's the correct gun
-            gun:SetNumberValue("GrappleMode", 1) -- 1 signifies Retract
-        end
-    end
-end
-
--- Action for Extend slice in the pie menu.
-function GrapplePieExtend(pieMenuOwner, pieMenu, pieSlice)
-    if pieMenuOwner and pieMenuOwner.EquippedItem then
-        local gun = ToMOSRotating(pieMenuOwner.EquippedItem)
-        if gun and gun.PresetName == "Grapple Gun" then
-            gun:SetNumberValue("GrappleMode", 2) -- 2 signifies Extend
-        end
-    end
-end
-
 -- Utility function to safely check if an object has a specific property (key) in its Lua script table.
 -- This is useful for checking if a script-defined variable exists on an MO.
 function HasScriptProperty(obj, propName)
@@ -34,61 +14,40 @@ function HasScriptProperty(obj, propName)
     return status and result
 end
 
-
--- Action for Unhook slice in the pie menu.
-function GrapplePieUnhook(pieMenuOwner, pieMenu, pieSlice)
+-- Helper function to validate grapple gun
+local function ValidateGrappleGun(pieMenuOwner)
     if not pieMenuOwner or not pieMenuOwner.EquippedItem then
-        return
+        return nil
     end
-
+    
     local gun = ToMOSRotating(pieMenuOwner.EquippedItem)
-    if not (gun and gun.PresetName == "Grapple Gun") then
-        return -- Not the grapple gun
+    if gun and gun.PresetName == "Grapple Gun" then
+        return gun
     end
+    
+    return nil
+end
 
-    local activeGrappleMO = nil
-    -- Find the active grapple claw associated with this specific gun instance.
-    for mo_instance in MovableMan:GetMOsByPreset("Grapple Gun Claw") do
-        -- Check if the instance is valid, has the parentGun property, and it matches our gun.
-        if mo_instance and mo_instance.ID ~= rte.NoMOID and 
-           HasScriptProperty(mo_instance, "parentGun") and -- Use HasScriptProperty for Lua members
-           mo_instance.parentGun and mo_instance.parentGun.ID == gun.ID then
-            activeGrappleMO = mo_instance
-            break
-        end
+-- Action for Retract slice in the pie menu.
+function GrapplePieRetract(pieMenuOwner, pieMenu, pieSlice)
+    local gun = ValidateGrappleGun(pieMenuOwner)
+    if gun then
+        gun:SetNumberValue("GrappleMode", 1) -- 1 signifies Retract
     end
+end
 
-    local allowUnhook = true -- Default to allowing unhook.
-    if activeGrappleMO then
-        -- Check the 'canRelease' property on the grapple claw instance itself.
-        -- This property is set by the Grapple.lua script based on its state (e.g., after sticking).
-        if HasScriptProperty(activeGrappleMO, "canRelease") then
-            allowUnhook = (activeGrappleMO.canRelease == true)
-        else
-            -- If canRelease property doesn't exist, but grapple is active,
-            -- it might imply it's in a state where it can be unhooked (e.g., already stuck).
-            -- However, for safety, if 'canRelease' is the definitive flag, stick to it.
-            -- If the grapple is flying (actionMode 1), 'canRelease' might be false.
-            -- If it's stuck (actionMode > 1), 'canRelease' should become true.
-            -- If actionMode is 1 (flying), pie menu unhook might not be desired or should just delete it.
-            if HasScriptProperty(activeGrappleMO, "actionMode") and activeGrappleMO.actionMode == 1 then
-                 allowUnhook = true -- Allow "unhooking" (deleting) a flying hook via pie menu
-            elseif not HasScriptProperty(activeGrappleMO, "canRelease") then
-                 allowUnhook = false -- If stuck and no canRelease flag, assume cannot release.
-            end
-        end
-    else
-        -- No active grapple found for this gun. Unhook action is irrelevant.
-        allowUnhook = false 
+-- Action for Extend slice in the pie menu.
+function GrapplePieExtend(pieMenuOwner, pieMenu, pieSlice)
+    local gun = ValidateGrappleGun(pieMenuOwner)
+    if gun then
+        gun:SetNumberValue("GrappleMode", 2) -- 2 signifies Extend
     end
+end
 
-    if allowUnhook then
-        gun:SetNumberValue("GrappleMode", 3) -- 3 signifies Unhook. Grapple.lua will handle this.
-    else
-        -- Play a denial sound if unhook is not allowed (e.g., hook is still flying and not releasable yet).
-        local denySound = CreateSoundContainer("Grapple Gun Click", "Base.rte") -- Or a specific "deny" sound
-        if denySound then
-            denySound:Play(gun.Pos)
-        end
+-- Action for Unhook slice in the pie menu.
+function GrapplePieUnhook(pieMenuOwner, pieMenu, pieSlice)
+    local gun = ValidateGrappleGun(pieMenuOwner)
+    if gun then
+        gun:SetNumberValue("GrappleMode", 3) -- 3 signifies Unhook
     end
 end