world.NoteColourRGB

MUSHclient script function (Method)

Chooses which RGB colour will be used for world notes - text and background

Prototype

void NoteColourRGB(long Foreground, long Background);

Data type meanings

Description

You can use this to set the foreground (text) and background colours used in world.note and world.tell. The colour is specified in RGB (Red, Green, Blue). Red is in the low-order byte, Green in the middle-order byte, and Blue in the higher-order byte. (ie. 0x00BBGGRR).

You must specify an RGB values. Some pre-defined values are available in VBscript, see below.

Constant Value Description
-------------------------------
vbBlack &h00 Black
vbRed &hFF Red
vbGreen &hFF00 Green
vbYellow &hFFFF Yellow
vbBlue &hFF0000 Blue
vbMagenta &hFF00FF Magenta
vbCyan &hFFFF00 Cyan
vbWhite &hFFFFFF White

In JScript and PerlScript you will need to use the RGB values, for example Magenta would be: 0xFF00FF.

To calculate this mathematically this would be:

colour = red + (green * 256) + (blue * 65536)

VBscript example

world.notecolourRGB vbRed, vbGreen  ' set note colour to red on green
world.note "This will be in red on green"

Jscript example

world.notecolourRGB (0xFF, 0xFF00);  // set note colour to use red on green
world.note("This will be in red on green");

PerlScript example

$world->NoteColourRGB (0xFF, 0xFF00);  # set note colour to use red on green
$world->note("This will be in red on green");

Python example

world.notecolourRGB (0xFF, 0xFF00)  # set note colour to use red on green
world.note("This will be in red on green")

Lua example

NoteColourRGB (255, 256 * 255)  -- set note colour to use red on green
Note("This will be in red on green")

Return value

Nothing.

Related topic

Colour management

See also