Browsing StarfallEx's section
โ† Back to ACE
Back to StarfallEx

SFEX.constraint.rope

S๐Ÿท๏ธ Constraint

Part of StarfallEx namespace

๐Ÿ”— External
constraint.rope(index, e1, e2, bone1, bone2, v1, v2, length, addlength, force_lim, width, material, rigid, color)
View on GitHub|lua/starfall/libs_sv/constraint.lua:357
๐Ÿ“‹ Has LDoc๐Ÿ‘๏ธ 0 viewsUpdated 2 months ago

Description

Creates a rope between two entities

Parameters

NameTypeDescription
indexnumberIndex of the rope constraint
e1EntityThe first entity
e2EntityThe second entity
bone1?numberNumber bone of the first entity. Default 0
bone2?numberNumber bone of the second entity. Default 0
v1VectorPosition on the first entity, in its local space coordinates
v2VectorPosition on the second entity, in its local space coordinates
length?numberLength of the created rope. Default 0
addlength?numberAmount to add to the base length of the rope. Default 0
force_lim?numberAmount of force until it breaks, 0 = Unbreakable. Default 0
width?numberWidth of the rope. Default 0
materialName?stringMaterial of the rope
rigid?booleanWhether the rope is rigid. Default false
color?ColorThe color of the rope. Default white

Returns

TypeDescription
ConstraintThe constraint entity

Examples

No examples available.

Used In

No usages found in the codebase.