Number
Summary
Constructors
| range (min: number, max: number?) : CustomRange |
| simpleRange (min: number, max: number?) : NumberRange |
Methods
| step (x: number, step: number?) : number |
| round (x: number, decimals: number?) : number |
| map (x: number, inMin: number, inMax: number, outMin: number, outMax: number) : number Deprecated |
| lerp (a: number, b: number, alpha: number) : number |
| unlerp (a: number, b: number, x: number) : number |
Constructors
range
Creates a CustomRange object with the provided minimum and maximum values. If no maximum value is provided, the maximum value will be set to the minimum value.
Number.range ( min: number, max: number? ) : CustomRange
Parameters
| min : number |
| max : number? |
Returns
| CustomRange |
simpleRange
Creates a Roblox NumberRange object with the provided minimum and maximum values. If no maximum value is provided, the maximum value will be set to the minimum value.
Number.simpleRange ( min: number, max: number? ) : NumberRange
Parameters
| min : number |
| max : number? |
Returns
| NumberRange |
Methods
step
Rounds a number to the nearest multiple of the provided step value. If no step value is provided, the number will be rounded to the nearest integer.
Number.step ( x: number, step: number? ) : number
Parameters
| x : number |
| step : number? |
Returns
| number |
round
Rounds a number to the specified number of decimal places. If no number of decimal places is provided, the number will be rounded to the nearest integer.
Number.round ( x: number, decimals: number? ) : number
Parameters
| x : number |
| decimals : number? |
Returns
| number |
map
Deprecated
Use math.map() instead.
Maps a number from one range to another. The input number is expected to be within the input range, and the output will be within the output range.
Number.map (
x: number, inMin: number, inMax: number, outMin: number, outMax: number
) : number
Parameters
| x : number |
| inMin : number |
| inMax : number |
| outMin : number |
| outMax : number |
Returns
| number |
lerp
Linearly interpolates between two numbers based on a given alpha value. The alpha value is expected to be between 0 and 1, where 0 returns the first number and 1 returns the second number.
Number.lerp (
a: number, b: number, alpha: number
) : number
Parameters
| a : number |
| b : number |
| alpha : number |
Returns
| number |
unlerp
Calculates the alpha value that would produce a given number when linearly interpolating between two numbers.
Number.unlerp (
a: number, b: number, x: number
) : number
Parameters
| a : number |
| b : number |
| x : number |
Returns
| number |