Script function

world.NoteColourName

Type

Method

Summary

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

Prototype

void NoteColourName(BSTR Foreground, BSTR Background);

Description

You can use this to set the foreground (text) and background colours used in world.note and world.tell. The colour is specified as a colour name, eg. "red", "green", "beige", "cyan" and so on.

The names are not case-sensitive.

You can also use HTML colour codes, eg. "#7FFF00", in this case the colours are in the order #rrggbb (rr = red, gg = green, bb = blue).

If a particular colour is invalid or not found, then that colour will be unchanged. Thus you can use this function to change the foreground colour only, the background colour only, or both.

Eg.

world.notecolourname "red", "" ' foreground only
world.notecolourname "", "blue" ' background only
world.notecolourname "green", "cyan" ' both

You can use MUSHclient's "colour picker" to choose a suitable name. Use the Edit menu -> Colour Picker to do this, or press Ctrl+Alt+P.

VBscript example

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

Jscript example

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

PerlScript example

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

Python example

world.notecolourname ("red", "green")  # set note colour to use red on green
world.note("This will be in red on green")

Lua example

NoteColourName ("red", "green")  -- 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
(NoteColourRGB) Chooses which RGB colour 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=NoteColourName)