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

SFEX.constraint.axis

S๐Ÿท๏ธ Constraint

Part of StarfallEx namespace

๐Ÿ”— External
constraint.axis(e1, e2, bone1, bone2, v1, v2, force_lim, torque_lim, friction, nocollide, laxis)
View on GitHub|lua/starfall/libs_sv/constraint.lua:165
๐Ÿ“‹ Has LDoc๐Ÿ‘๏ธ 0 viewsUpdated 2 months ago

Description

Axis two entities. v1 in e1's coordinates and v2 in e2's coordinates (or laxis in e1's coordinates again) define the axis

Parameters

NameTypeDescription
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 to center the axis, local to e1's space coordinates
v2VectorThe second position defining the axis, local to e2's space coordinates. The laxis may be specified instead which is local to e1's space coordinates
force_lim?numberAmount of force until it breaks, 0 = Unbreakable. Default 0
torque_lim?numberAmount of torque until it breaks, 0 = Unbreakable. Default 0
friction?numberFriction of the constraint. Default 0
nocollide?booleanBool whether or not to nocollide the two entities. Default false
laxis?VectorOptional second position of the constraint, same as v2 but local to e1

Returns

TypeDescription
ConstraintThe constraint entity

Examples

No examples available.

Used In

No usages found in the codebase.