Skip to content
MTA:SA Neon Documentation

setRopeLength

Shared
NEON APIManaged ropes

Changes a rope's length, which is how attached cargo is raised or lowered.

Syntax

bool setRopeLength(rope theRope, float length)

Arguments

theRoperope

Managed rope element.

lengthfloat

New length. 0 or greater.

Returns

true when applied; false for an invalid rope or value.

Ownership and lifecycle

A rope belongs to the resource that created it. GTA has eight native rope slots, so Neon leases them to the logical ropes that need one; a rope without a lease still exists but is not natively simulated at that moment. Every native type except swat requires a valid physical holder.

Important behavior
  • Shortening the rope is how you lift. The showcase hoists a crate and a vehicle this way rather than moving them directly.
  • A wrecking ball left at a default length can initialise below terrain, so set it deliberately.

Where this comes from

SOURCECLuaRopeDefs.cppServer/mods/deathmatch/logic/luadefs/CLuaRopeDefs.cpp INTRODUCED / EXTENDED32d6ac731Read the commit and why the change was made TEST RESOURCE rope-test test-resources/rope-test
RELATED NEON APIS

Continue exploring

Read the system guide →
createRope Creates a managed rope driven by one of GTA's own native rope types. getRopeType Returns which native GTA rope type a rope runs. setRopeType Changes which native GTA rope type a rope runs.

← Back to the Neon Lua API · How Managed ropes works →