Script function

world.SetNotes

Type

Method

Summary

Sets the notes for the world.

Prototype

void SetNotes(BSTR Message);

Description

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

Nothing.

See Also ...

Topic

Notes

Functions

(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)