[PHYSICS - AddRope]: Updated Rope Type Info

[JayPaulinCodes]

Summary

Updated the AddRope native documentation to fix the incorrect information regarding the ropeType parameter and provided more details regarding the 8 possible rope types. Also included a simple example usage of the native in the form of a command.

Validating Example(s)

• Video showcasing the 8 different rope types being spawned in: https://youtu.be/CkCVmEPQVgY
• Video showcasing the Lua native usage example: https://youtu.be/467hwsBaudg
• Code used for the validating examples:

local currentRope = nil
local propHandle = nil
local propHash = `prop_cs_fuel_nozle`
local pumpHash = `prop_gas_pump_1d`
local timeout = 1000
local pumpCoords = vector3(-2096.096436, -311.906891, 14.510918)
print("propHash", propHash)
print("pumpHash", pumpHash)

function spawnRopeOfType(ropeType)
    print("============================================")
    local pedHandle = PlayerPedId()
    local position = GetEntityCoords(pedHandle)
    print("ped", pedHandle, position)

    -- Create the prop
    if not HasModelLoaded(propHash) then
        local timer = 0
        while not HasModelLoaded(propHash) and timer < timeout do
            RequestModel(propHash)
            timer = timer + 1
            Citizen.Wait(1)
        end
    end
    propHandle = CreateObjectNoOffset(propHash, position.x, position.y, position.z, true, true, false)
    SetModelAsNoLongerNeeded(propHash)
    print("propHandle", propHandle)

    -- Attach the prop to ped
    local boneIndex = GetPedBoneIndex(pedHandle, 18905) -- SKEL_L_Hand
    print("boneIndex", boneIndex)
    AttachEntityToEntity(propHandle, pedHandle, boneIndex, 0.11, 0.02, 0.02, -15.0, -90.0, -80.0, false, false, false, false, 2, true)

    -- Create the rope
    local timer2 = 0
    while not RopeAreTexturesLoaded() and timer2 < timeout do
        RopeLoadTextures()
        timer2 = timer2 + 1
        Citizen.Wait(1)
    end

    currentRope = AddRope(
        0.0, -- x
        0.0, -- y
        0.0, -- z
        0.0, -- rotX
        0.0, -- rotY
        0.0, -- rotZ
        3.0, -- maxLength
        ropeType, -- ropeType
        1000.0, -- initLength
        0.0, -- minLength
        0.5, -- lengthChangeRate
        false, -- onlyPPU
        true, -- collisionOn
        true, -- lockFromFront
        1.0, -- timeMultiplier
        true, -- breakable
        0 -- unkPtr
    )
    print("currentRope", currentRope)
    ActivatePhysics(currentRope)

    -- Attach the rope to the prop
    local propPos = GetOffsetFromEntityInWorldCoords(propHandle, 0.0, -0.033, -0.195)
    print("propPos", propPos)
    local pumpHandle = GetClosestObjectOfType(pumpCoords.x, pumpCoords.y, pumpCoords.z, 10.0, pumpHash, false, true, true)
    print("pumpHandle", pumpHandle)
    local pumpCoords = GetEntityCoords(pumpHandle)
    print("pumpCoords", pumpCoords)
    
    AttachEntitiesToRope(currentRope, pumpHandle, propHandle, 
        pumpCoords.x, pumpCoords.y, pumpCoords.z,
        propPos.x, propPos.y, propPos.z,
        5.0, false, false, nil, nil)
end

RegisterCommand("ropetypes_dev_del", function(soruce, args)
    DeleteRope(currentRope)
    DeleteObject(propHandle)
end)

RegisterCommand("ropetypes_dev_spawn_0", function(soruce, args)
    print("ropetypes_dev_spawn_0")
    spawnRopeOfType(0)
end)

RegisterCommand("ropetypes_dev_spawn_1", function(soruce, args)
    print("ropetypes_dev_spawn_1")
    spawnRopeOfType(1)
end)

RegisterCommand("ropetypes_dev_spawn_2", function(soruce, args)
    print("ropetypes_dev_spawn_2")
    spawnRopeOfType(2)
end)

RegisterCommand("ropetypes_dev_spawn_3", function(soruce, args)
    print("ropetypes_dev_spawn_3")
    spawnRopeOfType(3)
end)

RegisterCommand("ropetypes_dev_spawn_4", function(soruce, args)
    print("ropetypes_dev_spawn_4")
    spawnRopeOfType(4)
end)

RegisterCommand("ropetypes_dev_spawn_5", function(soruce, args)
    print("ropetypes_dev_spawn_5")
    spawnRopeOfType(5)
end)

RegisterCommand("ropetypes_dev_spawn_6", function(soruce, args)
    print("ropetypes_dev_spawn_6")
    spawnRopeOfType(6)
end)

RegisterCommand("ropetypes_dev_spawn_7", function(soruce, args)
    print("ropetypes_dev_spawn_7")
    spawnRopeOfType(7)
end)


RegisterCommand("new_rope", function(soruce, args)

    -- Get the handle for the player's ped
    local pedHandle = PlayerPedId()

    -- Ensure that the rope textures are loaded
    local timer = 0
    while not RopeAreTexturesLoaded() and timer < 1000 do
        RopeLoadTextures()
        timer = timer + 1
        Citizen.Wait(0)
    end

    -- Get the coordinates for where the rope will be
    local ropePos = GetOffsetFromEntityInWorldCoords(pedHandle, 0.0, 2.0, 0.5)

    -- Create the rope
    local newRopeHandle = AddRope(
        ropePos.x, -- x
        ropePos.y, -- y
        ropePos.z, -- z
        0.0, -- rotX
        0.0, -- rotY
        0.0, -- rotZ
        10.0, -- maxLength
        1, -- ropeType
        10.0, -- initLength
        0.0, -- minLength
        1.0, -- lengthChangeRate
        false, -- onlyPPU
        false, -- collisionOn
        false, -- lockFromFront
        1.0, -- timeMultiplier
        false, -- breakable
        0 -- unkPtr
    )

end)

Contribution Guidelines Acknowledgement

Before you submit this PR, please make sure:

• You have read the contribution guidelines
• You include an example that validates your change
• Your English is grammatically correct

[colistro123]

Suggested some corrections and did some nitpicking, otherwise looks good to me for the most part.

[colistro123]

LGTM 😊