Skip to content
MTA:SA Neon Documentation

getRopePositionAt

Client-side
NEON APIManaged ropes

Returns an interpolated point along a rope, read from the live native solver.

Syntax

Vector3|false getRopePositionAt(rope theRope, float progress)

Arguments

theRoperope

Managed rope element.

progressfloat

Position along the rope, from 0 at the top to 1 at the end.

Returns

A Vector3 world position, or false for an invalid rope or when the rope holds no native slot.

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
  • Client-only, because it reads the running solver rather than synchronized state.

Where this comes from

SOURCECLuaRopeDefs.cppClient/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 →