Angle
Pitch, yaw, roll in degrees, positive pitch down, yaw 0 along +X; methods and operators return new Angles.
Methods
Angle
Angle([pitch [, yaw [, roll]]]) -> Angle| Name | Type | Description |
|---|---|---|
| pitchoptional | number | Default 0. |
| yawoptional | number | Default 0. |
| rolloptional | number | Default 0. |
New Angle; missing components are 0, nothing is normalized.
ang.pitch
ang.pitch -> numberPositive looks down. Read and write.
Writing unknown fields or non-numbers raises.
ang.p
ang.p -> numberSame as ang.pitch.
ang.x
ang.x -> numberSame as ang.pitch.
ang.yaw
ang.yaw -> numberLeft/right turn. Read and write.
ang.y
ang.y -> numberSame as ang.yaw.
ang.roll
ang.roll -> numberTilt. Read and write.
ang.r
ang.r -> numberSame as ang.roll.
ang.z
ang.z -> numberSame as ang.roll.
ang:forward
ang:forward() -> VectorUnit look direction.
ang:right
ang:right() -> VectorUnit right vector.
ang:up
ang:up() -> VectorUnit up vector.
ang:vectors
ang:vectors() -> Vector, Vector, VectorForward, right and up in one call.
ang:normalize
ang:normalize() -> AngleCopy with each component wrapped to -180 to 180.
Pitch wraps, not clamps; use clamp() for view angles.
ang:clamp
ang:clamp() -> AngleValid view angle copy: pitch -89 to 89, yaw wrapped, roll 0.
ang:delta
ang:delta(other) -> Angle| Name | Type | Description |
|---|---|---|
| other | Angle | Angle to subtract. |
Shortest signed difference: yaw 179 vs -179 gives -2.
Returns Wrapped to -180 to 180
ang:length
ang:length() -> numbersqrt(pยฒ + yยฒ), ignoring roll; aim error on a delta.
ang:lerp
ang:lerp(to, t) -> Angle| Name | Type | Description |
|---|---|---|
| to | Angle | |
| t | number | 0 is ang, 1 is to. |
Per-component blend the short way round, for aim smoothing.
t is not clamped and the result is not wrapped; call normalize().
ang:unpack
ang:unpack() -> number, number, numberComponents as three values.
Returns pitch, yaw, roll
ang:clone
ang:clone() -> AngleIndependent copy.
a + b
Angle + Angle -> AnglePer-component sum of two Angles, not normalized.
a - b
Angle - Angle -> AnglePer-component difference, unwrapped; delta() gives the shortest.
a * b
Angle * number | number * Angle -> AngleScales each component by a number.
Angle * Angle raises 'number expected'.
a / b
Angle / number -> AngleDivides each component by a number.
Dividing by 0 raises "Angle: division by zero".
-a
-Angle -> AngleNegates each component.
a == b
Angle == Angle -> booleanExact match, no tolerance or wrapping: 180 ~= -180.
tostring(ang)
tostring(Angle) -> stringReadable pitch, yaw, roll; print() shows the same.
Returns Like "Angle(10.0, 90.0, 0.0)"