NoteColourRGB
Script function

world.NoteColourRGB

DOC_scripting 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);

DOC_data_types 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

DOC_colours Colour management
DOC_defaults Default triggers/aliases/timers/macros/colours

Functions

FNC_AdjustColour AdjustColour (Adjust an RGB colour)
FNC_ANSI ANSI (Generates an ANSI colour sequence)
FNC_BoldColour BoldColour (Gets/sets the RGB colour for one of the 8 ANSI bold colours)
FNC_ColourNameToRGB ColourNameToRGB (Converts a named colour to a RGB colour code.)
FNC_ColourNote ColourNote (Sends a message to the output window in specified colours)
FNC_ColourTell ColourTell (Sends a message to the output window in specified colours - not terminated by a newline)
FNC_CustomColourBackground CustomColourBackground (Sets the RGB value for the background of a custom colour)
FNC_CustomColourText CustomColourText (Sets the RGB value for the text of a custom colour)
FNC_GetCustomColourName GetCustomColourName (Gets the name of a custom colour)
FNC_GetMapColour GetMapColour (Returns the mapping for how a particular colour will be displayed)
FNC_MapColour MapColour (Changes the colour mapping - the way colours are displayed)
FNC_MapColourList MapColourList (Returns an array of all the mapped colours)
FNC_NormalColour NormalColour (Gets/sets the RGB colour for one of the 8 ANSI normal colours)
FNC_Note Note (Sends a note to the output window)
FNC_NoteColour NoteColour (Chooses which custom colour will be used for world notes.)
FNC_NoteColourBack NoteColourBack (Chooses which RGB colour will be used for world notes - background colour)
FNC_NoteColourFore NoteColourFore (Chooses which RGB colour will be used for world notes - text colour)
FNC_NoteColourName NoteColourName (Chooses which RGB colour name will be used for world notes - text and background)
FNC_PickColour PickColour (Invokes the MUSHclient colour picker dialog)
FNC_RGBColourToName RGBColourToName (Converts an RGB colour code to its equivalent name)
FNC_SetCustomColourName SetCustomColourName (Sets the name of a custom colour)
FNC_Tell Tell (Sends a message to the output window - not terminated by a newline)

(Help topic: function=NoteColourRGB)

DOC_contents Documentation contents page