Color

A type alias: another name for the type it stands for.

Stands for
number

Methods

MethodReturnsDescription
new(number, number, number)Color(number, number, number) -> Color: An opaque colour; each component 0-255, else an error naming the bad ones.
new(number, number, number, number)Color
new(number)Color
new(number, boolean)Color
decode(string)Colornm as an integer (#rrggbb, 0x..., decimal, octal), opaque.
getHSBColor(number, number, number)ColorThe opaque colour of hue, saturation and brightness, computed in 32-bit floats.
HSBtoRGB(number, number, number)numberThe opaque RGB of hue, saturation and brightness, as a signed 32-bit integer.
RGBtoHSB(number, number, number, {number}?){number}{hue, saturation, brightness}; filled into hsbvals and returned when it is a table.
equals(Color, any)booleanColor.equals(c, obj): whether obj is the same colour. == answers the same, since a colour is a number.
getRed(Color)numberColor.getRed(c): the red component, 0-255.
getGreen(Color)numberColor.getGreen(c): the green component, 0-255.
getBlue(Color)numberColor.getBlue(c): the blue component, 0-255.
getAlpha(Color)numberColor.getAlpha(c): the alpha component, 0-255.
getRGB(Color)numberColor.getRGB(c): the 32 bits as a signed integer (Color.RED is -65536).
brighter(Color)ColorColor.brighter(c): each channel divided by 0.7, at most 255, keeping alpha; a non-zero channel under 3 counts as 3, and black gives `(3,…
darker(Color)ColorColor.darker(c): each channel times 0.7, truncated, keeping alpha.

Fields

FieldTypeDescription
WHITEColorColor.WHITE, packed ARGB.
whiteColorColor.white, packed ARGB.
LIGHT_GRAYColorColor.LIGHT_GRAY, packed ARGB.
lightGrayColorColor.lightGray, packed ARGB.
GRAYColorColor.GRAY, packed ARGB.
grayColorColor.gray, packed ARGB.
DARK_GRAYColorColor.DARK_GRAY, packed ARGB.
darkGrayColorColor.darkGray, packed ARGB.
BLACKColorColor.BLACK, packed ARGB.
blackColorColor.black, packed ARGB.
REDColorColor.RED, packed ARGB.
redColorColor.red, packed ARGB.
PINKColorColor.PINK, packed ARGB.
pinkColorColor.pink, packed ARGB.
ORANGEColorColor.ORANGE, packed ARGB.
orangeColorColor.orange, packed ARGB.
YELLOWColorColor.YELLOW, packed ARGB.
yellowColorColor.yellow, packed ARGB.
GREENColorColor.GREEN, packed ARGB.
greenColorColor.green, packed ARGB.
MAGENTAColorColor.MAGENTA, packed ARGB.
magentaColorColor.magenta, packed ARGB.
CYANColorColor.CYAN, packed ARGB.
cyanColorColor.cyan, packed ARGB.
BLUEColorColor.BLUE, packed ARGB.
blueColorColor.blue, packed ARGB.

Returned by

MethodReturnsDescription
ChatColorConfig.opaqueAutochatMessageColor?Color of autochat messages. The user's textrecolor value opaqueAutochatMessage; unset, nil (no recolour).
ChatColorConfig.opaqueAutochatMessageHighlightColor?Color of highlights in autochat messages. The user's textrecolor value opaqueAutochatMessageHighlight; unset, nil (no recolour).
ChatColorConfig.opaqueClanChannelNameColor?Color of clan chat channel name. The user's textrecolor value opaqueClanChatChannelName; unset, nil (no recolour).
ChatColorConfig.opaqueClanChatGuestInfoColor?Guest clan chat information (eg. when joining a channel). The user's textrecolor value opaqueClanGuestInfo; unset, nil (no recolour).
ChatColorConfig.opaqueClanChatGuestInfoHighlightColor?Guest clan chat information highlight. The user's textrecolor value opaqueClanGuestInfoHighlight; unset, the default: Color.RED (`0xF…
ChatColorConfig.opaqueClanChatGuestMessageColor?Color of guest clan chat messages. The user's textrecolor value opaqueClanGuestMessage; unset, nil (no recolour).
ChatColorConfig.opaqueClanChatGuestMessageHighlightColor?Color of highlights in guest clan chat messages. The user's textrecolor value opaqueClanChatGuestMessageHighlight; unset, the default:…
ChatColorConfig.opaqueClanChatGuestUsernamesColor?Color of usernames in guest clan chat. The user's textrecolor value opaqueClanChatGuestUsernames; unset, nil (no recolour).
ChatColorConfig.opaqueClanChatInfoColor?Clan chat information (eg. when joining a channel). The user's textrecolor value opaqueClanInfo; unset, nil (no recolour).
ChatColorConfig.opaqueClanChatInfoHighlightColor?Clan chat information highlight. The user's textrecolor value opaqueClanInfoHighlight; unset, the default: Color.RED (0xFFFF0000).
ChatColorConfig.opaqueClanChatMessageColor?Color of clan chat messages. The user's textrecolor value opaqueClanMessage; unset, nil (no recolour).
ChatColorConfig.opaqueClanChatMessageHighlightColor?Color of highlights in clan chat messages. The user's textrecolor value opaqueClanMessageHighlight; unset, the default: `Color.decode("…
ChatColorConfig.opaqueClanChatUsernamesColor?Color of usernames in clan chat. The user's textrecolor value opaqueClanChatUsernames; unset, nil (no recolour).
ChatColorConfig.opaqueClanGuestChatChannelNameColor?Color of guest clan chat channel name. The user's textrecolor value opaqueClanChatGuestChannelName; unset, nil (no recolour).
ChatColorConfig.opaqueExamineColor?Color of examine text. The user's textrecolor value opaqueExamine; unset, nil (no recolour).
ChatColorConfig.opaqueExamineHighlightColor?Color of highlights in examine text. The user's textrecolor value opaqueExamineHighlight; unset, the default: Color.decode("#0000FF")…
ChatColorConfig.opaqueFilteredColor?Color of filtered text (messages that aren't shown when game messages are filtered). The user's textrecolor value opaqueFiltered; unset…
ChatColorConfig.opaqueFilteredHighlightColor?Color of highlights in filtered text. The user's textrecolor value opaqueFilteredHighlight; unset, nil (no recolour).
ChatColorConfig.opaqueFriendsChatChannelNameColor?Color of friends chat channel name. The user's textrecolor value opaqueClanChannelName; unset, nil (no recolour).
ChatColorConfig.opaqueFriendsChatInfoColor?Friends chat information (eg. when joining a channel). The user's textrecolor value opaqueFriendsChatInfo; unset, nil (no recolour).
ChatColorConfig.opaqueFriendsChatInfoHighlightColor?Friends chat information highlight. The user's textrecolor value opaqueClanChatInfoHighlight; unset, the default: Color.RED (`0xFFFF0…
ChatColorConfig.opaqueFriendsChatMessageColor?Color of friends chat messages. The user's textrecolor value opaqueClanChatMessage; unset, nil (no recolour).
ChatColorConfig.opaqueFriendsChatMessageHighlightColor?Color of highlights in friends chat messages. The user's textrecolor value opaqueClanChatMessageHighlight; unset, the default: `Color.d…
ChatColorConfig.opaqueFriendsChatUsernamesColor?Color of usernames in friends chat. The user's textrecolor value opaqueClanUsernames; unset, nil (no recolour).
ChatColorConfig.opaqueGameMessageColor?Color of game messages. The user's textrecolor value opaqueGameMessage; unset, nil (no recolour).
ChatColorConfig.opaqueGameMessageHighlightColor?Color of highlights in game messages. The user's textrecolor value opaqueGameMessageHighlight; unset, the default: `Color.decode("#EF10…
ChatColorConfig.opaquePlayerUsernameColor?Color of your username. The user's textrecolor value opaquePlayerUsername; unset, nil (no recolour).
ChatColorConfig.opaquePrivateMessageReceivedColor?Color of private messages you've received. The user's textrecolor value opaquePrivateMessageReceived; unset, nil (no recolour).
ChatColorConfig.opaquePrivateMessageReceivedHighlightColor?Color of highlights in private messages you've received. The user's textrecolor value opaquePrivateMessageReceivedHighlight; unset, the…
ChatColorConfig.opaquePrivateMessageSentColor?Color of private messages you've sent. The user's textrecolor value opaquePrivateMessageSent; unset, nil (no recolour).
ChatColorConfig.opaquePrivateMessageSentHighlightColor?Color of highlights in private messages you've sent. The user's textrecolor value opaquePrivateMessageSentHighlight; unset, the default…
ChatColorConfig.opaquePrivateUsernamesColor?Color of usernames in private chat. The user's textrecolor value opaquePrivateUsernames; unset, nil (no recolour).
ChatColorConfig.opaquePublicChatColor?Color of public chat. The user's textrecolor value opaquePublicChat; unset, nil (no recolour).
ChatColorConfig.opaquePublicChatHighlightColor?Color of highlights in public chat. The user's textrecolor value opaquePublicChatHighlight; unset, the default: `Color.decode("#000000"…
ChatColorConfig.opaquePublicFriendUsernamesColor?Color of friend usernames in public chat. The user's textrecolor value opaquePublicFriendUsernames; unset, nil (no recolour).
ChatColorConfig.opaqueServerMessageColor?Color of server messages (eg. 'Welcome to RuneScape'). The user's textrecolor value opaqueServerMessage; unset, nil (no recolour).
ChatColorConfig.opaqueServerMessageHighlightColor?Color of highlights in server messages. The user's textrecolor value opaqueServerMessageHighlight; unset, nil (no recolour).
ChatColorConfig.opaqueTradeChatMessageColor?Color of trade chat messages. The user's textrecolor value opaqueTradeChatMessage; unset, nil (no recolour).
ChatColorConfig.opaqueTradeChatMessageHighlightColor?Color of highlights in trade chat messages. The user's textrecolor value opaqueTradeChatMessageHighlight; unset, nil (no recolour).
ChatColorConfig.opaqueUsernameColor?Color of usernames. The user's textrecolor value opaqueUsername; unset, nil (no recolour).
ChatColorConfig.transparentAutochatMessageColor?Color of autochat messages (transparent). The user's textrecolor value transparentAutochatMessage; unset, nil (no recolour).
ChatColorConfig.transparentAutochatMessageHighlightColor?Color of highlights in autochat messages (transparent). The user's textrecolor value transparentAutochatMessageHighlight; unset, nil…
ChatColorConfig.transparentClanChannelGuestNameColor?Color of guest clan chat channel name (transparent). The user's textrecolor value transparentClanChatGuestChannelName; unset, nil (no…
ChatColorConfig.transparentClanChannelNameColor?Color of clan chat channel name (transparent). The user's textrecolor value transparentClanChatChannelName; unset, nil (no recolour).
ChatColorConfig.transparentClanChatGuestInfoColor?Guest clan chat information (eg. when joining a channel) (transparent). The user's textrecolor value transparentClanGuestInfo; unset, `…
ChatColorConfig.transparentClanChatGuestInfoHighlightColor?Guest clan chat information highlight (transparent). The user's textrecolor value transparentClanGuestInfoHighlight; unset, the default…
ChatColorConfig.transparentClanChatGuestMessageColor?Color of guest clan chat messages (transparent). The user's textrecolor value transparentClanGuestMessage; unset, nil (no recolour).
ChatColorConfig.transparentClanChatGuestMessageHighlightColor?Color of highlights in guest clan chat messages (transparent). The user's textrecolor value transparentClanChatGuestMessageHighlight; u…
ChatColorConfig.transparentClanChatGuestUsernamesColor?Color of usernames in guest clan chat (transparent). The user's textrecolor value transparentClanClanGuestUsernames; unset, nil (no r…
ChatColorConfig.transparentClanChatInfoColor?Clan chat information (eg. when joining a channel) (transparent). The user's textrecolor value transparentClanInfo; unset, nil (no re…
ChatColorConfig.transparentClanChatInfoHighlightColor?Clan chat information highlight (transparent). The user's textrecolor value transparentClanInfoHighlight; unset, the default: `Color.RE…
ChatColorConfig.transparentClanChatMessageColor?Color of clan chat messages (transparent). The user's textrecolor value transparentClanMessage; unset, nil (no recolour).
ChatColorConfig.transparentClanChatMessageHighlightColor?Color of highlights in clan chat messages (transparent). The user's textrecolor value transparentClanMessageHighlight; unset, the defau…
ChatColorConfig.transparentClanChatUsernamesColor?Color of usernames in clan chat (transparent). The user's textrecolor value transparentClanClanUsernames; unset, nil (no recolour).
ChatColorConfig.transparentExamineColor?Color of examine text (transparent). The user's textrecolor value transparentExamine; unset, nil (no recolour).
ChatColorConfig.transparentExamineHighlightColor?Color of highlights in examine text (transparent). The user's textrecolor value transparentExamineHighlight; unset, the default: `Color…
ChatColorConfig.transparentFilteredColor?Color of filtered text (messages that aren't shown when game messages are filtered) (transparent). The user's textrecolor value `transpar…
ChatColorConfig.transparentFilteredHighlightColor?Color of highlights in filtered text (transparent). The user's textrecolor value transparentFilteredHighlight; unset, nil (no recolou…
ChatColorConfig.transparentFriendsChatChannelNameColor?Color of friends chat channel name (transparent). The user's textrecolor value transparentClanChannelName; unset, nil (no recolour).
ChatColorConfig.transparentFriendsChatInfoColor?Friends chat information (eg. when joining a channel) (transparent). The user's textrecolor value transparentFriendsChatInfo; unset, `n…
ChatColorConfig.transparentFriendsChatInfoHighlightColor?Friends chat information highlight (transparent). The user's textrecolor value transparentClanChatInfoHighlight; unset, the default: `C…
ChatColorConfig.transparentFriendsChatMessageColor?Color of friends chat messages (transparent). The user's textrecolor value transparentClanChatMessage; unset, nil (no recolour).
ChatColorConfig.transparentFriendsChatMessageHighlightColor?Color of highlights in friends chat messages (transparent). The user's textrecolor value transparentClanChatMessageHighlight; unset, th…
ChatColorConfig.transparentFriendsChatUsernamesColor?Color of usernames in friends chat (transparent). The user's textrecolor value transparentClanUsernames; unset, nil (no recolour).
ChatColorConfig.transparentGameMessageColor?Color of game messages (transparent). The user's textrecolor value transparentGameMessage; unset, nil (no recolour).
ChatColorConfig.transparentGameMessageHighlightColor?Color of highlights in game messages (transparent). The user's textrecolor value transparentGameMessageHighlight; unset, the default: `…
ChatColorConfig.transparentPlayerUsernameColor?Color of your username (transparent). The user's textrecolor value transparentPlayerUsername; unset, nil (no recolour).
ChatColorConfig.transparentPrivateMessageReceivedColor?Color of private messages you've received (transparent). The user's textrecolor value transparentPrivateMessageReceived; unset, nil (…
ChatColorConfig.transparentPrivateMessageReceivedHighlightColor?Color of highlights in private messages you've received (transparent). The user's textrecolor value `transparentPrivateMessageReceivedHig…
ChatColorConfig.transparentPrivateMessageSentColor?Color of private messages you've sent (transparent). The user's textrecolor value transparentPrivateMessageSent; unset, nil (no recol…
ChatColorConfig.transparentPrivateMessageSentHighlightColor?Color of highlights in private messages you've sent (transparent). The user's textrecolor value transparentPrivateMessageSentHighlight;…
ChatColorConfig.transparentPrivateUsernamesColor?Color of usernames in private chat (transparent). The user's textrecolor value transparentPrivateUsernames; unset, nil (no recolour).
ChatColorConfig.transparentPublicChatColor?Color of public chat (transparent). The user's textrecolor value transparentPublicChat; unset, nil (no recolour).
ChatColorConfig.transparentPublicChatHighlightColor?Color of highlights in public chat (transparent). The user's textrecolor value transparentPublicChatHighlight; unset, the default: `Col…
ChatColorConfig.transparentPublicFriendUsernamesColor?Color of friend usernames in public chat (transparent). The user's textrecolor value transparentPublicFriendUsernames; unset, nil (no…
ChatColorConfig.transparentServerMessageColor?Color of server messages (eg. 'Welcome to RuneScape') (transparent). The user's textrecolor value transparentServerMessage; unset, `nil…
ChatColorConfig.transparentServerMessageHighlightColor?Color of highlights in server messages (transparent). The user's textrecolor value transparentServerMessageHighlight; unset, nil (no…
ChatColorConfig.transparentTradeChatMessageColor?Color of trade chat messages (transparent). The user's textrecolor value transparentTradeChatMessage; unset, nil (no recolour).
ChatColorConfig.transparentTradeChatMessageHighlightColor?Color of highlights in trade chat messages (transparent). The user's textrecolor value transparentTradeChatMessageHighlight; unset, `ni…
ChatColorConfig.transparentUsernameColor?Color of usernames (transparent). The user's textrecolor value transparentUsername; unset, nil (no recolour).
ClientConfig.notificationFlashColorColorThe colour of notification flashes.
ColorClass.brighterColorColor.brighter(c): each channel divided by 0.7, at most 255, keeping alpha; a non-zero channel under 3 counts as 3, and black gives `(3,…
ColorClass.darkerColorColor.darker(c): each channel times 0.7, truncated, keeping alpha.
ColorClass.decodeColornm as an integer (#rrggbb, 0x..., decimal, octal), opaque.
ColorClass.getHSBColorColorThe opaque colour of hue, saturation and brightness, computed in 32-bit floats.
ColorClass.newColor(number, number, number) -> Color: An opaque colour; each component 0-255, else an error naming the bad ones.
ColorJButton.getColorColor?The swatch colour.
ColorUtilClass.colorLerpColorEach channel, alpha included, interpolated and rounded half up; a t that pushes a channel out of range is an error.
ColorUtilClass.colorWithAlphaColorThe same RGB with alpha, clamped to 0-255.
ColorUtilClass.fromHexColor?Six digits or fewer opaque, more read as ARGB; nil when it does not decode.
ColorUtilClass.fromObjectColorA saturated, bright colour whose hue comes from a hash of the object: a string, integer or boolean; anything else raises.
ColorUtilClass.fromStringColor?string as an integer (#rrggbb, 0x..., decimal, octal) read as ARGB, or nil when it does not decode.
Component.getBackgroundColor?The background: the component's own, else its nearest ancestor's, else nil.
Component.getForegroundColor?The foreground: the component's own, else its nearest ancestor's, else nil.
GradientPaint.getColor1ColorThe first colour.
GradientPaint.getColor2ColorThe second colour.
Graphics.getColorColorThe current colour (the last setColor, or the colour of the last colour paint).
Graphics2D.getBackgroundColorThe background colour.
HighlightedNpc.getFillColorColorThe fill colour.
HighlightedNpc.getHighlightColorColorThe border (and name) colour.
InfoBox.getTextColorColor?The caption's colour (nil: white). Abstract: a subclass defines it.
JShadowedLabel.getShadowColorThe shadow's colour (Color.BLACK unless set).
Notification.getFlashColorColor?The flash's colour.
OverlayPanel.getPreferredColorColor?The background used instead of the standard one, or nil.
PanelComponent.getBackgroundColorColor?getBackgroundColor().
SkillColor.getColorColorThis constant's getColor() value, listed on each constant.
WidgetMenuOption.getColorColorThe colour the next setMenuTarget wraps the target in.

Method details

new

new: ((number, number, number) -> Color) & ((number, number, number, number) -> Color) & ((number) -> Color) & ((number, boolean) -> Color)

(number, number, number) -> Color: An opaque colour; each component 0-255, else an error naming the bad ones.

(number, number, number, number) -> Color: A colour with alpha; each component 0-255.

(number) -> Color: The opaque colour of the low 24 bits of rgb.

(number, boolean) -> Color: All 32 bits when hasalpha, else the low 24 opaque.

decode

decode: (string) -> Color

nm as an integer (#rrggbb, 0x..., decimal, octal), opaque.

getHSBColor

getHSBColor: (number, number, number) -> Color

The opaque colour of hue, saturation and brightness, computed in 32-bit floats.

HSBtoRGB

HSBtoRGB: (number, number, number) -> number

The opaque RGB of hue, saturation and brightness, as a signed 32-bit integer.

RGBtoHSB

RGBtoHSB: (number, number, number, {number}?) -> {number}

{hue, saturation, brightness}; filled into hsbvals and returned when it is a table.

equals

equals: (Color, any) -> boolean

Color.equals(c, obj): whether obj is the same colour. == answers the same, since a colour is a number.

getRed

getRed: (Color) -> number

Color.getRed(c): the red component, 0-255.

getGreen

getGreen: (Color) -> number

Color.getGreen(c): the green component, 0-255.

getBlue

getBlue: (Color) -> number

Color.getBlue(c): the blue component, 0-255.

getAlpha

getAlpha: (Color) -> number

Color.getAlpha(c): the alpha component, 0-255.

getRGB

getRGB: (Color) -> number

Color.getRGB(c): the 32 bits as a signed integer (Color.RED is -65536).

brighter

brighter: (Color) -> Color

Color.brighter(c): each channel divided by 0.7, at most 255, keeping alpha; a non-zero channel under 3 counts as 3, and black gives (3, 3, 3).

darker

darker: (Color) -> Color

Color.darker(c): each channel times 0.7, truncated, keeping alpha.