[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.ColourNote

Name ColourNote
Type Method
Summary Sends a message to the output window in specified colours
Prototype void ColourNote(BSTR TextColour, BSTR BackgroundColour, BSTR Text);

View list of data type meanings


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).


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.

Note: Available in version 3.23 onwards.

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.
Returns Nothing.
Introduced in version 3.23

See also ...

Function Description
AnsiNote Make a note in the output window from text with ANSI colour codes imbedded
ChatNote Does a note using ANSI codes for the chat system
ColourTell Sends a message to the output window in specified colours - not terminated by a newline
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
NoteColourRGB Chooses which RGB colour will be used for world notes - text and background
NoteStyle Sets the style for notes
Send Sends a message to the MUD
Tell Sends a message to the output window - not terminated by a newline

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]