Script function
world.NotepadColour
Read about scripting
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
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")
Available in MUSHclient 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")
Return value
0 = Could not do it (eg. that notepad does not exist, one of those colours do not exist)
1 = Colours changed OK.
See Also ...
Topic
Notepad
Functions
(ActivateNotepad) Activates a notepad window
(AppendToNotepad) Appends text to a notepad window
(CloseNotepad) Closes a notepad window
(GetMainWindowPosition) Returns the position and size of the main MUSHclient window
(GetNotepadLength) Gets the length of the text in a notepad window
(GetNotepadList) Gets the list of open notepads - returning their titles
(GetNotepadText) Gets the text from a notepad window
(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
(MoveNotepadWindow) Move and resize the specified notepad window
(MoveWorldWindow) Move and resize a world window
(NotepadFont) Changes the font and style of the selected notepad window
(NotepadReadOnly) Make a selected notepad window read-only
(NotepadSaveMethod) Changes the save method for this notepad window
(ReplaceNotepad) Replaces text in a notepad window
(SaveNotepad) Saves a notepad window to disk
(SendToNotepad) Creates a notepad and sends text to it
(Help topic: function=NotepadColour)