world.SetNotes

MUSHclient script function (Method)

Sets the notes for the world.

Prototype

void SetNotes(BSTR Message);

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.

Related topic

Notes

See also