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

MUSHclient scripting

Description of MUSHclient world function: world.SetNotes


Name SetNotes
Type Method
Summary Sets the notes for the world.
Prototype void SetNotes(BSTR Message);

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")
Returns Nothing.

See also ...

Function Description
GetNotes Gets the world's notes

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

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.

[Home]


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]