world.NoteColourFore

MUSHclient script function (Property)

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

Prototype

long NoteColourFore;

Data type meanings

Description

You can use this to set the foreground (text) colour 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).

If you are setting the colour you must specify an RGB value. 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 you will need to use the RGB values, for example Magenta would be: 0xFF00FF.

VBscript example

world.notecolourfore = vbRed  ' set note colour to red
world.note "This will be in red"
world.note world.notecolourfore  ' display current note colour

Jscript example

world.notecolourfore = 0xFF;  // set note colour to use red
world.note("This will be in red");
world.note(world.notecolourfore);  // display current note colour

PerlScript example

$world->{notecolourfore} = 0xFF;  # set note colour to use red
$world->note("This will be in red");
$world->note($world->{notecolourfore});  # display current note colour

Python example

world.notecolourfore = 0xFF  # set note colour to use red
world.note("This will be in red")
world.note(world.notecolourfore)  # display current note colour

Lua example

SetNoteColourFore (255)  -- set note colour to use red foreground
Note ("This will be in red")
Note(GetNoteColourFore ())  -- display current note background colour

Lua notes

Lua implements this as two functions:

GetNoteColourFore - gets the note colour foreground
SetNoteColourFore - sets the note colour foreground

Return value

This is a property. You can use it to find the current note text colour.

Related topic

Colour management

See also