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

MUSHclient scripting

Description of MUSHclient world function: world.NoteColourName


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

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 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")
Returns Nothing.

See also ...

Function Description
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
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
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

[Back]

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.

[Home]


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]