PhysicsClientChecked by LS:MP

attachEntitiesToRope

ATTACH_ENTITIES_TO_ROPE0x3D95EC8B6D940AC3

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

SignatureJavaScript
attachEntitiesToRope(
  ropeId: number,
  ent1: Entity,
  ent2: Entity,
  ent1_x: number,
  ent1_y: number,
  ent1_z: number,
  ent2_x: number,
  ent2_y: number,
  ent2_z: number,
  length: number,
  componentA: number,
  componentB: number,
  boneA: string,
  boneB: string
): void
SignatureLua
attachEntitiesToRope(
  ropeId: integer,
  ent1: Entity,
  ent2: Entity,
  ent1_x: number,
  ent1_y: number,
  ent1_z: number,
  ent2_x: number,
  ent2_y: number,
  ent2_z: number,
  length: number,
  componentA: integer,
  componentB: integer,
  boneA: string,
  boneB: string
)

Usage

JavaScript
attachEntitiesToRope(
  ropeId, ent1, ent2, ent1_x, ent1_y, ent1_z, ent2_x, ent2_y, ent2_z, length, componentA,
  componentB, boneA, boneB
);
Lua
attachEntitiesToRope(
    ropeId, ent1, ent2, ent1_x, ent1_y, ent1_z, ent2_x, ent2_y, ent2_z, length, componentA,
    componentB, boneA, boneB
)

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
attachEntitiesToRope(
  ropeId, ent1, ent2, ent1_, ent2_, length, componentA, componentB, boneA, boneB
);
Lua · with vectors
attachEntitiesToRope(
    ropeId, ent1, ent2, ent1_, ent2_, length, componentA, componentB, boneA, boneB
)

Parameters

ParameterTypeJavaScriptLua
ropeIdintnumberinteger
ent1Entitynumberinteger
ent2Entitynumberinteger
ent1_xfloatnumbernumber
ent1_yfloatnumbernumber
ent1_zfloatnumbernumber
ent2_xfloatnumbernumber
ent2_yfloatnumbernumber
ent2_zfloatnumbernumber
lengthfloatnumbernumber
componentAintnumberinteger
componentBintnumberinteger
boneAstringstringstring
boneBstringstringstring

Returns

Nothing. In JavaScript the call evaluates to undefined.

On LS:MP

ℹ
Resource-owned attachments

Use a rope and two distinct local entities with physics instances, all owned by the calling resource. Length must be 0.01–1,000 and both component indices must be 0. Omit each bone name for the default attachment or pass an existing bone name.

ℹ
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
void ATTACH_ENTITIES_TO_ROPE(int ropeId, Entity ent1, Entity ent2, float ent1_x, float ent1_y, float ent1_z, float ent2_x, float ent2_y, float ent2_z, float length, int componentA, int componentB, const char* boneA, const char* boneB)
Hash
0x3D95EC8B6D940AC3

Open in the interactive natives reference