world.NoteColourBack

MUSHclient script function (Property)

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

Prototype

long NoteColourBack;

Data type meanings

Description

You can use this to set the background 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.notecolourback = vbRed  ' set note background colour to red
world.note "This will be on a red background"
world.note world.notecolourback  ' display current note background colour

Jscript example

world.notecolourback = 0xFF;  // set note colour to use red background
world.note("This will be on a red background");
world.note(world.notecolourback);  // display current note background colour

PerlScript example

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

Python example

world.notecolourback = 0xFF  # set note colour to use red background
world.note("This will be on a red background")
world.note(world.notecolourback)  # display current note background colour

Lua example

SetNoteColourBack (255)  -- set note colour to use red background
Note ("This will be on a red background")
Note(GetNoteColourBack ())  -- display current note background colour

Lua notes

Lua implements this as two functions:

GetNoteColourBack - gets the note colour background
SetNoteColourBack - sets the note colour background

Return value

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

Related topic

Colour management

See also