Color Meta¶
All documented color metatable methods discovered across framework and module source files.
Documented methods: 1 · Realm: shared
Methods¶
color:IsDark(minimumThreshold)¶
Returns true if the color is perceived as dark by a human viewer.
Computes the W3C-standard relative luminance using the formula: 0.299 * R + 0.587 * G + 0.114 * B (weights reflect human eye sensitivity to each channel). The result is compared against minimumThreshold: values below the threshold are considered dark.
The default threshold of 186 is a widely-used cutoff for choosing between white and black text on a coloured background.
Realm: shared
Parameters
| Name | Type | Description |
|---|---|---|
minimumThreshold |
number\|nil |
The brightness cutoff (0–255). Values below this are considered dark. Defaults to 186. |
Returns
boolean: True if the color's perceived brightness is below the threshold.
Usage
if ( color:IsDark() ) then
draw.SimpleText("Hello", "Default", x, y, Color(255, 255, 255))
else
draw.SimpleText("Hello", "Default", x, y, Color(0, 0, 0))
end
Source: gamemode/framework/meta/sh_color.lua:14