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

MUSHclient scripting

Description of MUSHclient world function: world.NotepadColour

Name NotepadColour
Type Method
Summary Changes the text and background colour of the selected notepad window
Prototype long NotepadColour(BSTR Title, BSTR TextColour, BSTR BackgroundColour);

View list of data type meanings


This lets you set the text and background colour of an open notepad window.


AppendToNotepad ("test", "but does it get goat's blood out?") -- create window
NotepadColour ("test", "whitesmoke", "saddlebrown") -- change its colour

The colours are 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:

NotepadColour ("test", "#FAEBD7", "#FFB6C1")

Note: Available in version 3.57 onwards.

VBscript example
NotepadColour "test", "#FAEBD7", "#FFB6C1"
NotepadColour "test", "whitesmoke", "saddlebrown"
Jscript example
NotepadColour ("test", "#FAEBD7", "#FFB6C1");
NotepadColour ("test", "whitesmoke", "saddlebrown");
Lua example
NotepadColour ("test", "#FAEBD7", "#FFB6C1")
NotepadColour ("test", "whitesmoke", "saddlebrown")
Returns 0 = Could not do it (eg. that notepad does not exist, one of those colours do not exist)
1 = Colours changed OK.
Introduced in version 3.57

See also ...

Function Description
GetMainWindowPosition Returns the position and size of the main MUSHclient window
GetNotepadList Gets the list of open notepads - returning their titles
GetNotepadWindowPosition Returns the position and size of the specified notepad window
GetWorldWindowPosition Returns the position and size of the current world window
MoveMainWindow Move and resize the main MUSHclient window
MoveWorldWindow Move and resize a world window
NotepadColour Changes the text and background colour of the selected notepad window
NotepadFont Changes the font and style of the selected notepad window
NotepadReadOnly Make a selected notepad window read-only

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]