wrapNumber()function

wrapNumber(num: number, min: number, max: number): number
ParamType
numnumber
The number to wrap. required
minnumber
The minimum bound, inclusive. required
maxnumber
The maximum bound, exclusive (values wrap back to min). required
Return
number
num wrapped to lie between min and max.
Throws
unknown
ValueError if max is less than min.

Wrap a number between two values.

  • Numbers wrap around between min and max (like a clock).
  • e.g. 12 bounded by 2 and 8 is 6
  • Words in both directions.
  • e.g. -2 bounded by 2 and 8 is 4

Examples

wrapNumber(12, 2, 8) // 6