Script function
world.NoteColourRGB
Read about scripting
Type
Method
Summary
Chooses which RGB colour will be used for world notes - text and background
Prototype
void NoteColourRGB(long Foreground, long Background);
View list of 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.
See Also ...
Topics
Colour management
Default triggers/aliases/timers/macros/colours
Functions
(AdjustColour) Adjust an RGB colour
(ANSI) Generates an ANSI colour sequence
(BoldColour) Gets/sets the RGB colour for one of the 8 ANSI bold colours
(ColourNameToRGB) Converts a named colour to a RGB colour code.
(ColourNote) Sends a message to the output window in specified colours
(ColourTell) Sends a message to the output window in specified colours - not terminated by a newline
(CustomColourBackground) Sets the RGB value for the background of a custom colour
(CustomColourText) Sets the RGB value for the text of a custom colour
(GetCustomColourName) Gets the name of a custom colour
(GetMapColour) Returns the mapping for how a particular colour will be displayed
(MapColour) Changes the colour mapping - the way colours are displayed
(MapColourList) Returns an array of all the mapped colours
(NormalColour) Gets/sets the RGB colour for one of the 8 ANSI normal colours
(Note) Sends a note to the output window
(NoteColour) Chooses which custom colour will be used for world notes.
(NoteColourBack) Chooses which RGB colour will be used for world notes - background colour
(NoteColourFore) Chooses which RGB colour will be used for world notes - text colour
(NoteColourName) Chooses which RGB colour name will be used for world notes - text and background
(PickColour) Invokes the MUSHclient colour picker dialog
(RGBColourToName) Converts an RGB colour code to its equivalent name
(SetCustomColourName) Sets the name of a custom colour
(Tell) Sends a message to the output window - not terminated by a newline
(Help topic: function=NoteColourRGB)