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

Note

Script function

world.Note

Read about scripting

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.


Return value

Nothing.


See Also ...

Topic

Notes

Functions

(AnsiNote) Make a note in the output window from text with ANSI colour codes imbedded
(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
(DoAfterNote) Adds a one-shot, temporary note timer - simplified interface
(GetNoteStyle) Gets the style for notes
(Hyperlink) Creates a hyperlink in the output window
(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
(SetNotes) Sets the notes for the world.
(Tell) Sends a message to the output window - not terminated by a newline

(Help topic: function=Note)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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.

[Home]


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]