NEON APIManaged ropes

Moves the rope's attachment point on its holder.

Syntax

Copy signature

bool setRopeHolderOffset(rope theRope, Vector3 offset)

Arguments

theRoperope

Managed rope element.

offsetVector3

Local offset on the holder.

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.

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.

← Previous in categorygetRopeHolderOffset Next in category →getRopeLength

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