Api
MathutilsClamp
OpenAPI > MathUtils > clamp
OpenAPI.MathUtils.clamp() method
将一个数字限制在包括的下限和上限范围内。
此函数接受一个数字和两个边界，并返回限制在指定边界内的数字。 如果只提供一个边界，则返回值与该边界的最小值相比较。
Signature:
static clamp(value: number, minimum: number, maximum?: number): number;
Parameters
Parameter | Type | Description |
|---|---|---|
value | number | 要限制的数字。 |
minimum | number | 要限制的最小边界。 |
maximum | number | (Optional) 要限制的最大边界。 |
number
{number} 在指定边界内限制后的数字。
Example
const result1 = OpenAPI.MathUtils.clamp(10, 5); // result1 将会是 5，因为 10 被限制在边界 5 上
const result2 = OpenAPI.MathUtils.clamp(10, 5, 15); // result2 将会是 10，因为它在边界 5 和 15 内
const result3 = OpenAPI.MathUtils.clamp(2, 5, 15); // result3 将会是 5，因为 2 被限制在边界 5 下
const result4 = OpenAPI.MathUtils.clamp(20, 5, 15); // result4 将会是 15，因为 20 被限制在边界 15 上