SetNotes
Script function

world.SetNotes

DOC_scripting Read about scripting

Type

Method

Summary

Sets the notes for the world.

Prototype

void SetNotes(BSTR Message);

DOC_data_types View list of data type meanings

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

DOC_note Notes

Functions

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

(Help topic: function=SetNotes)

DOC_contents Documentation contents page