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


Script function


Read about scripting




Sets the notes for the world.


void SetNotes(BSTR Message);

View list of data type meanings


This sets the notes for the current world.

Use the built-in constant "vbcrlf" to add a new line to the notes.

Use GetNotes if you want to get the existing notes (perhaps to append to them, as in the example).

VBscript example

world.setnotes world.getnotes & vbcrlf _
     & "This is a new line of notes"

Jscript example

world.setnotes(world.getnotes() + 
     "\r\nThis is a new line of notes");

PerlScript example

$world->setnotes($world->getnotes() . 
     "\r\nThis is a new line of notes");

Python example

world.setnotes(world.getnotes + 
     "\r\nThis is a new line of notes")

Lua example

SetNotes (GetNotes () .. 
          "\r\nThis is a new line of notes")

Return value


See Also ...




(AnsiNote) Make a note in the output window from text with ANSI colour codes imbedded
(DoAfterNote) Adds a one-shot, temporary note timer - simplified interface
(GetNotes) Gets the world's notes
(GetNoteStyle) Gets the style for notes
(Hyperlink) Creates a hyperlink in the output window
(Note) Sends a note to the output window
(NoteHr) Draws a horizontal rule in the output window
(NoteStyle) Sets the style for notes
(Tell) Sends a message to the output window - not terminated by a newline

(Help topic: function=SetNotes)

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.


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]