Note
Script function

world.Note

DOC_scripting Read about scripting

Type

Method

Summary

Sends a note to the output window

Prototype

void Note(BSTR Message);

DOC_data_types 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 world.Tell instead.

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

DOC_note Notes

Functions

FNC_AnsiNote AnsiNote (Make a note in the output window from text with ANSI colour codes imbedded)
FNC_ColourNote ColourNote (Sends a message to the output window in specified colours)
FNC_ColourTell ColourTell (Sends a message to the output window in specified colours - not terminated by a newline)
FNC_DoAfterNote DoAfterNote (Adds a one-shot, temporary note timer - simplified interface)
FNC_GetNoteStyle GetNoteStyle (Gets the style for notes)
FNC_Hyperlink Hyperlink (Creates a hyperlink in the output window)
FNC_NoteColour NoteColour (Chooses which custom colour will be used for world notes.)
FNC_NoteColourBack NoteColourBack (Chooses which RGB colour will be used for world notes - background colour)
FNC_NoteColourFore NoteColourFore (Chooses which RGB colour will be used for world notes - text colour)
FNC_NoteColourName NoteColourName (Chooses which RGB colour name will be used for world notes - text and background)
FNC_NoteColourRGB NoteColourRGB (Chooses which RGB colour will be used for world notes - text and background)
FNC_NoteHr NoteHr (Draws a horizontal rule in the output window)
FNC_NoteStyle NoteStyle (Sets the style for notes)
FNC_Send Send (Sends a message to the MUD)
FNC_SetNotes SetNotes (Sets the notes for the world.)
FNC_Tell Tell (Sends a message to the output window - not terminated by a newline)

(Help topic: function=Note)

DOC_contents Documentation contents page