world.Note

MUSHclient script function (Method)

Sends a note to the output window

Prototype

void Note(BSTR Message);

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.

Return value

Nothing.

Related topic

Notes

See also