world.NotepadColour

MUSHclient script function (Method) — introduced in version 3.57

Changes the text and background colour of the selected notepad window

Prototype

long NotepadColour(BSTR Title, BSTR TextColour, BSTR BackgroundColour);

Data type meanings

Description

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

eg.

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

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

Return value

0 = Could not do it (eg. that notepad does not exist, one of those colours do not exist)
1 = Colours changed OK.

Related topic

Notepad

See also