Skip to content
MTA:SA Neon Documentation

attachElementToRope

Shared
NEON APIManaged ropes

Attaches an element to a rope so the native solver carries it.

Syntax

bool attachElementToRope(rope theRope, element theElement)

Arguments

theRoperope

Managed rope element.

theElementelement

Object or vehicle to carry.

Returns

true when attached; false for an invalid rope or element.

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
  • Unfreeze the element first. A frozen element makes the rope solver fight MTA's frozen state.
  • Once attached, raise and lower it with setRopeLength rather than moving it directly.

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 →