world.ColourNote

MUSHclient script function (Method) — introduced in version 3.23

Sends a message to the output window in specified colours

Prototype

void ColourNote(BSTR TextColour, BSTR BackgroundColour, BSTR Text);

Data type meanings

Description

This lets you do a "note" in a specified colour. It is not transmitted to the world. It is useful for making comments to yourself. The note colour is saved and restored, so that the world note colour is unchanged after using this function (however the new colour is used for the tell itself).

eg.

world.ColourNote "red", "blue", "Hello there"

The colour is specified by colour name - you can use the MUSHclient colour picker to see all possible colour names, or type: world.Debug "colours". You can also specify colours in HTML format, like this:

world.ColourNote "#FAEBD7", "#FFB6C1", "Hi there"

If you leave a colour name blank, it is unchanged. Thus you could do this to get red text on the existing background:

world.ColourNote "red", "", "Hello there"

A new line will automatically be started by output from the MUD, or a command that you type being echoed to the output window. You can send a new line yourself by sending vbCRLF (in Visual Basic) or n in Jscript or Perlscript.

To make changes to the text style (eg. bold, underline) see NoteStyle.

VBscript example

world.ColourNote "red", "blue", "Hello there"

Jscript example

world.ColourNote ("red", "blue", "Hello there");

PerlScript example

$world->ColourNote ("red", "blue", "Hello there");

Python example

world.ColourNote ("red", "blue", "Hello there")

Lua example

ColourNote ("red", "blue", "Hello there ",
            "white", "green", "everyone")

Lua notes

You can supply any number of arguments, however they must be in groups of three:

* foreground colour
* background colour
* text

The example above shows how you might send two lots of text coloured different ways.

The newline is only appended to the end of the note, not between individual items.

Return value

Nothing.

Related topic

Colour management

See also