Skip to content
MTA:SA Neon Documentation

setRopeType

Shared
NEON APIManaged ropes

Changes which native GTA rope type a rope runs.

Syntax

bool setRopeType(rope theRope, string type)

Arguments

theRoperope

Managed rope element.

typestring

winchMagnet, harness, miniMagnet, dockCrane, wreckingBall, quarryCrane, vegasCrane or swat.

Returns

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

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
  • Switching to any type other than swat requires the rope to have 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. getRopeDuration Returns the total lifetime a rope was created with, in milliseconds.

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