Api
MathutilsInrange
OpenAPI > MathUtils > inRange
OpenAPI.MathUtils.inRange() method
检查值是否在指定范围内。
Signature:
static inRange(value: number, minimum: number, maximum?: number): boolean;
Parameters
Parameter | Type | Description |
---|---|---|
value | number | 要检查的值。 |
minimum | number | 范围的下限(包含)。 |
maximum | number | (Optional) 范围的上限(不包含)。 |
boolean
{boolean} 如果值在指定范围内则返回 true
,否则返回 false
。
Exceptions
{Error} 如果 minimum
大于或等于 maximum
,抛出错误。
Example
const result1 = OpenAPI.MathUtils.inRange(3, 5); // result1 将返回 true。
const result2 = OpenAPI.MathUtils.inRange(1, 2, 5); // result2 将返回 false。
const result3 = OpenAPI.MathUtils.inRange(1, 5, 2); // 如果最小值大于或等于最大值,将抛出错误。