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

MUSHclient scripting

Description of MUSHclient world function: world.Save

Name Save
Type Method
Summary Saves world configuration.
Prototype boolean Save(BSTR Name);

View list of data type meanings


Saves the current world, under the specified filename. Supply a blank file name to save under the current name.

Also, all plugins are forced to save their current state.

Under Lua (only) you can do a "save as" which saves under a new name, but preserves the original name, see below.

VBscript example
world.Save ""   ' Saves under current name
world.Save "my_new_name.mcl"  ' Saves under new name
Jscript example
world.Save("");   // Saves under current name
PerlScript example
$world->Save("");   # Saves under current name
Python example
world.Save("")   # Saves under current name
Lua example
Save("")   -- Saves under current name

Save ("my_new_name.mcl")  -- Save under a new name - which is used for future saves

Save ("my_backup.mcl", true)  -- Save a copy under a different name, original name is unchanged
Lua notes
The filename is optional, if not supplied the file is saved under its current name, if any.

You can supply a second boolean argument. If true, MUSHclient does a "save as", which means the file is saved under the given name, however the original name is preserved for future save. If you do a "save as" the file name is not optional.

Note under Lua the return codes are a bit misleading:

false: saved OK
true: did not save OK
Returns eOK: saved OK
any other value: not saved

Under Lua:

false: saved OK
true: did not save OK

View list of return code meanings

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


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]