MUSHclient scripting

Description of MUSHclient world function: world.Note

Name	Note
Type	Method
Summary	Sends a note to the output window
Prototype	`void Note(BSTR Message);` View list of data type meanings
Description	This makes a note in the output window. It is not transmitted to the world. It is useful for making comments to yourself. The note is automatically terminated by a newline, so each world.Note will appear on a separate line. The note appears in the current NoteColour (a custom colour), or in the RGB colours selected by NoteColourFore and NoteColourBack. You can also choose colours with NoteColourRGB and NoteColourName. If you want to change colours in the middle of a note, use Tell instead. To make changes to the text style (eg. bold, underline) see NoteStyle.
VBscript example	`world.note "This monster is worth avoiding!"`
Jscript example	`world.note("This monster is worth avoiding!");`
PerlScript example	`$world->note("This monster is worth avoiding!");`
Python example	`world.note("This monster is worth avoiding!")`
Lua example	`Note ("This monster is worth avoiding!")`
Lua notes	`You can supply multiple arguments, which are concatenated together.`
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
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
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
NoteHr	Draws a horizontal rule in the output window
NoteStyle	Sets the style for notes
Send	Sends a message to the MUD
Tell	Sends a message to the output window - not terminated by a newline

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.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.