NEON APIManaged ropes

Reports whether a rope currently holds one of GTA's eight native rope slots.

Syntax

Copy signature

bool isRopeActive(rope theRope)

Arguments

theRoperope

Managed rope element.

Returns

true when the rope is natively simulated right now; false otherwise or for an invalid rope.

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

• Logical ropes can outnumber the eight native slots. This is how a client asks whether a given rope currently has a lease.

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.

← Previous in categorygetRopePositionAt

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