Garry's Mod Wiki

Home / math.Clamp

math.Clamp

  number math.Clamp( number input, number min, number max )
View Source Search Github

Description

Clamps a number between a minimum and maximum value.

Arguments

1 number input
The number to clamp.
2 number min
The minimum value.
3 number max
The maximum value, this function will never return a number greater than this.

Returns

1 number
The clamped value.

Example

Demonstrates what this function does.

print( math.Clamp( 10, 0, 5 ) ) -- 10 is greater than 5 so returns 5 print( math.Clamp( 3, 0, 5 ) ) -- 3 is greater than 0 and less than 5, so returns 3 print( math.Clamp( -1, 0, 5 ) ) -- -1 is less than 0, so returns 0 print( math.Clamp( 20, 50, 10 ) ) -- 20 is greater than 10 so returns 10, even though min arg is 50
Output:
5 3 0 10

Example

Heals player by 10, but won't let their health go above 100.

ply:SetHealth( math.Clamp( ply:Health() + 10, 0, 100 ) )

Account Management

Special Pages

Wiki List