Name SaveState
Type Method
Summary Saves the state of the current plugin
Prototype long SaveState();
Description This causes the current plugin to save its state (ie. its variables) to its "state" file. You might call this in a timer every couple of minutes to ensure that variables are saved in the event of a program or computer crash.

To save its state a plugin must have

save_state="y"

in its plugin configuration.

Plugins automatically save their state when they are closed (ie. when they are uninstalled, or when the world closes). However if the world does not close for days then you may want to arrange for the plugin to save its state more often, particularly if the variables that the plugin is using are valuable.

The plugins save their state to a directory called "state" which is a subdirectory of the nominated "world plugins directory". If no such directory exists, then the plugin cannot save its state.

There is a state file for each world/plugin combination.

The file name will look like this:

a282eaabbecd18a56aa07f84-c8efc9f9e1edd118c6f2dbf5-state.xml

This is:

(world ID)-(plugin ID)-state.xml

Each world should have a unique ID, and each plugin should have a unique ID, thus each world's plugin's state should have a unique file name.
VBscript example 
world.SaveState
Jscript example 
world.SaveState ();
PerlScript example 
$world->SaveState ();
Returns eNotAPlugin: Script is not currently executing inside a plugin.
ePluginDoesNotSaveState: This plugin is not configured to save its state.
ePluginCouldNotSaveState: The plugin could not save its state (eg. no "state" directory, disk full, not permitted)
eOK: Plugin saved its state OK.

See also ...