PhysicsClientChecked by LS:MP

addRope

ADD_ROPE0xE832D760399EB220

The GTA V native ADD_ROPE of the PHYSICS namespace, as LS:MP client scripts call it: the global function addRope, in JavaScript and in Lua.

SignatureJavaScript
addRope(
  x: number,
  y: number,
  z: number,
  rotX: number,
  rotY: number,
  rotZ: number,
  length: number,
  ropeType: number,
  maxLength: number,
  minLength: number,
  windingSpeed: number,
  p11: boolean,
  p12: boolean,
  rigid: boolean,
  p14: number,
  breakWhenShot: boolean,
  materialName: string
): number
SignatureLua
addRope(
  x: number,
  y: number,
  z: number,
  rotX: number,
  rotY: number,
  rotZ: number,
  length: number,
  ropeType: integer,
  maxLength: number,
  minLength: number,
  windingSpeed: number,
  p11: boolean,
  p12: boolean,
  rigid: boolean,
  p14: number,
  breakWhenShot: boolean,
  materialName: string
): integer

Usage

JavaScript
const result = addRope(
  x, y, z, rotX, rotY, rotZ, length, ropeType, maxLength, minLength, windingSpeed, p11, p12,
  rigid, p14, breakWhenShot, materialName
);
Lua
local result = addRope(
    x, y, z, rotX, rotY, rotZ, length, ropeType, maxLength, minLength, windingSpeed, p11, p12,
    rigid, p14, breakWhenShot, materialName
)

Three consecutive numbers can be given as one vector: { x, y, z } (or [x, y, z]) in JavaScript, a Vector3 in Lua.

JavaScript · with vectors
const result = addRope(
  pos, rot, length, ropeType, maxLength, minLength, windingSpeed, p11, p12, rigid, p14,
  breakWhenShot, materialName
);
Lua · with vectors
local result = addRope(
    pos, rot, length, ropeType, maxLength, minLength, windingSpeed, p11, p12, rigid, p14,
    breakWhenShot, materialName
)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
rotXfloatnumbernumber
rotYfloatnumbernumber
rotZfloatnumbernumber
lengthfloatnumbernumber
ropeTypeintnumberinteger
maxLengthfloatnumbernumber
minLengthfloatnumbernumber
windingSpeedfloatnumbernumber
p11BOOLbooleanboolean
p12BOOLbooleanboolean
rigidBOOLbooleanboolean
p14floatnumbernumber
breakWhenShotBOOLbooleanboolean
materialNamestringstringstring

Returns

int JavaScript number, Lua integer

On LS:MP

ℹ
Local rope

Load rope textures first. The rope is created on the calling client. Types 0–6 are accepted. Length is 0.01–1,000, winding speed is 0–100 and the time multiplier is 0.01–10. The initial length (maxLength) is -1 or between 0.01 and length. minLength must be positive and within the effective initial length. Pass false for p11 and omit materialName. Each resource can have up to 32 live ropes created this way. A creation failure returns 0.

ℹ
GTA V Enhanced 1158.16

This LS:MP adapter is available on Enhanced 1158.16. Calls on another build raise an error.

Reference

Namespace
Physics PHYSICS
In the game
int ADD_ROPE(float x, float y, float z, float rotX, float rotY, float rotZ, float length, int ropeType, float maxLength, float minLength, float windingSpeed, BOOL p11, BOOL p12, BOOL rigid, float p14, BOOL breakWhenShot, const char* materialName)
Hash
0xE832D760399EB220

Open in the interactive natives reference