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

MUSHclient scripting

Description of MUSHclient world function: world.NoteColourBack


Name NoteColourBack
Type Property
Summary Chooses which RGB colour will be used for world notes - background colour
Prototype long NoteColourBack;

View list of data type meanings

Description

You can use this to set the background colour 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).

If you are setting the colour you must specify an RGB value. 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 you will need to use the RGB values, for example Magenta would be: 0xFF00FF.

VBscript example
world.notecolourback = vbRed  ' set note background colour to red
world.note "This will be on a red background"
world.note world.notecolourback  ' display current note background colour
Jscript example
world.notecolourback = 0xFF;  // set note colour to use red background
world.note("This will be on a red background");
world.note(world.notecolourback);  // display current note background colour
PerlScript example
$world->{notecolourback} = 0xFF;  # set note colour to use red background
$world->note("This will be on a red background");
$world->note($world->{notecolourback});  # display current note background colour
Python example
world.notecolourback = 0xFF  # set note colour to use red background
world.note("This will be on a red background")
world.note(world.notecolourback)  # display current note background colour
Lua example
SetNoteColourBack (255)  -- set note colour to use red background
Note ("This will be on a red background")
Note(GetNoteColourBack ())  -- display current note background colour
Lua notes
Lua implements this as two functions:

GetNoteColourBack - gets the note colour background
SetNoteColourBack - sets the note colour background
Returns This is a property. You can use it to find the current note background colour.

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