` {#save-api-browser-slot-method-entries}
Provides an array of details about all slot saves.
#### History:
* `v2.37.0`: Introduced.
#### Parameters: *none*
#### Returns:
An `Array` of `{ index, info }` generic objects, or an empty `Array` if no slot saves exist.
* **`index`:** (`integer`) The slot save's index (`0`-based).
* **`info`:** (`object`) The [save's descriptor object](#save-api-objects-descriptor).
#### Throws:
An `Error` instance.
#### Examples:
```js
Save.browser.slot.entries().forEach(function (entry) {
console.log(`Descriptor of the slot save at index ${entry.index}:`, entry.info);
});
```
### `Save.browser.slot.get(index)` → `object` {#save-api-browser-slot-method-get}
Details the slot save at the given index.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`index`:** (`integer`) Slot save index (`0`-based). Must be in the range `0`–`Config.saves.maxSlotSaves`.
#### Returns:
The [descriptor object](#save-api-objects-descriptor) for the slot save if it exists, elsewise `null`.
#### Throws:
An `Error` instance.
#### Examples:
```js
console.log(`Descriptor of the slot save at index ${index}:`, Save.browser.slot.get(index));
```
### `Save.browser.slot.has(index)` → `boolean` {#save-api-browser-slot-method-has}
Determines whether the slot save at the given index exists.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`index`:** (`integer`) Slot save index (`0`-based). Must be in the range `0`–`Config.saves.maxSlotSaves`.
#### Returns:
Boolean `true` if the slot save exists, elsewise `false`.
#### Throws:
An `Error` instance.
#### Examples:
```js
if (Save.browser.slot.has(index)) {
/* The slot save at the given index exists. */
}
```
### `Save.browser.slot.isEnabled()` → `boolean` {#save-api-browser-slot-method-isenabled}
Determines whether slot saves are enabled.
#### History:
* `v2.37.0`: Introduced.
#### Parameters: *none*
#### Returns:
Boolean `true` if slot saves are anabled, elsewise `false`.
#### Throws: *none*
#### Examples:
```js
if (Save.browser.slot.isEnabled()) {
/* Slot saves are enabled. */
}
```
### `Save.browser.slot.load(index)` → `Promise` {#save-api-browser-slot-method-load}
Loads the slot save at the given index.
Warning:
Saves cannot be loaded during startup and any attempt to do so will cause an error.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`index`:** (`integer`) Slot save index (`0`-based). Must be in the range `0`–`Config.saves.maxSlotSaves`.
#### Returns: *none*
A `Promise` that simply resolves, or rejects with an error if the save could not be loaded.
#### Throws: *none*
#### Examples:
##### Basic usage
Load the slot save at the given index. This should be sufficient in the majority of cases.
```js
Save.browser.slot.load(index)
.then(() => {
Engine.show();
})
.catch(error => {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
});
```
### `Save.browser.slot.save(index, [desc [, metadata]])` {#save-api-browser-slot-method-save}
Saves a slot save to the given index.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`index`:** (`integer`) Slot save index (`0`-based). Must be in the range `0`–`Config.saves.maxSlotSaves`.
* **`desc`:** (optional, `string`) The description of the slot save. If omitted or `null`, defaults to the active passage's description.
* **`metadata`:** (optional, `any`) The data to be stored in the save object's `metadata` property. *Must* be JSON-serializable.
#### Returns: *none*
#### Throws:
An `Error` instance.
#### Examples:
##### Basic usage
Save to slot save index `0` with the default description and no metadata, handling failure.
```js
try {
Save.browser.slot.save(0);
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
Save to slot save index `0` with a description and no metadata, handling failure.
```js
try {
Save.browser.slot.save(0, "In the wilds");
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
Save to slot save index `0` with the default description and metadata, handling failure.
```js
try {
const saveMetadata = {
chars : ['Celes', 'Locke', 'Edward'],
gold : 2345
};
Save.browser.slot.save(0, null, saveMetadata);
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
Save to slot save index `0` with a description and metadata, handling failure.
```js
try {
const saveMetadata = {
chars : ['Celes', 'Locke', 'Edward'],
gold : 2345
};
Save.browser.slot.save(0, "In the wilds", saveMetadata);
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
## Disk Saves {#save-api-disk}
### `Save.disk.export(filename)` {#save-api-disk-method-export}
Exports all existing browser saves as a bundle to disk, which may be restored via [`Save.disk.import()`](#save-api-disk-method-import).
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`filename`:** (`string`) The base filename of the browser save export, which gets slugified to remove most symbols. Appended to this is a datestamp (format: `YYYMMDD-hhmmss`) and the file extension `.savesbundle`—e.g., `"The Scooby Chronicles"` would result in the full filename: `the-scooby-chronicles-{datestamp}.savesbundle`.
#### Returns: *none*
#### Throws:
An `Error` instance.
#### Examples:
Export all saves as a bundle with a base filename, handling failure.
```js
try {
Save.disk.export('The 6th Fantasy');
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
### `Save.disk.import(event)` → `Promise` {#save-api-disk-method-import}
Imports a saves bundle from disk, created via [`Save.disk.export()`](#save-api-disk-method-export).
Note:
This method must be used as, or be called by, the change event handler of an <input type="file"> element.
Warning:
All existing browser saves will be deleted as part of restoring the exported save bundle.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`event`:** (`Event`) The event object that was passed to the `change` event handler of the associated `Note:
This method must be used as, or be called by, the change event handler of an <input type="file"> element.
Warning:
Saves cannot be loaded during startup and any attempt to do so will cause an error.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`event`:** (`Event`) The event object that was passed to the `change` event handler of the associated `>
<>
< >
```
### `Save.disk.save(filename [, metadata])` {#save-api-disk-method-save}
Saves the current story state to disk, which may be restored via [`Save.disk.load()`](#save-api-disk-method-load).
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`filename`:** (`string`) The base filename of the disk save, which gets slugified to remove most symbols. Appended to this is a datestamp (format: `YYYMMDD-hhmmss`) and the file extension `.save`—e.g., `"The Scooby Chronicles"` would result in the full filename: `the-scooby-chronicles-{datestamp}.save`.
* **`metadata`:** (optional, `any`) The data to be stored in the save object's `metadata` property. *Must* be JSON-serializable.
#### Returns: *none*
#### Throws:
An `Error` instance.
#### Examples:
Save with a base filename and no metadata, handling failure.
```js
try {
Save.disk.save("The 6th Fantasy");
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
Save with a base filename and metadata, handling failure.
```js
try {
const saveMetadata = {
chars : ['Celes', 'Locke', 'Edward'],
gold : 2345
};
Save.disk.save("The 6th Fantasy", saveMetadata);
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
## Base64 SavesWarning:
All existing browser saves will be deleted as part of restoring the exported save bundle.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`bundle`:** (`string`) The Base64 saves bundle string.
#### Returns:
A `Promise` that simply resolves, or rejects with an error if the browser saves bundle could not be imported.
#### Throws: *none*
#### Examples:
##### Basic usage
Import the saves bundle, only handling failure. This should be sufficient in the majority of cases.
```js
Save.base64.import(base64Bundle)
.catch(error => {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
});
```
Import the saves bundle, handling both success and failure.
```js
Save.base64.import(base64Bundle)
.then(() => {
/* Success. Do something special. */
})
.catch(error => {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
});
```
### `Save.base64.load(save)` → `Promise` {#save-api-base64-method-load}
Loads the given Base64 save string, created via [`Save.base64.save()`](#save-api-base64-method-save).
Warning:
Saves cannot be loaded during startup and any attempt to do so will cause an error.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`save`:** (`string`) The Base64 save string.
#### Returns:
A `Promise` that resolves with the save's metadata (`any`), or rejects with an error if the save could not be loaded.
#### Throws: *none*
#### Examples:
##### Basic usage
Load the save string. This should be sufficient in the majority of cases.
```js
Save.base64.load(base64Save)
.then(metadata => {
Engine.show();
})
.catch(error => {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
});
```
### `Save.base64.save([metadata])` → `string` {#save-api-base64-method-save}
Saves the current story state as a Base64 string.
#### History:
* `v2.37.0`: Introduced.
#### Parameters:
* **`metadata`:** (optional, `any`) The data to be stored in the save object's `metadata` property. *Must* be JSON-serializable.
#### Returns:
A Base64 save `string`.
#### Throws:
An `Error` instance.
#### Examples:
##### Basic usage
Save without metadata, handling failure.
```js
try {
const base64Save = Save.base64.save();
/* Do something with the save. */
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
Save with metadata, handling failure.
```js
try {
const saveMetadata = {
chars : ['Celes', 'Locke', 'Edward'],
gold : 2345
};
const base64Save = Save.base64.save(saveMetadata);
/* Do something with the save. */
}
catch (error) {
/* Failure. Handle the error. */
console.error(error);
UI.alert(error);
}
```
## Save Events {#save-api-events}
### `Save.onLoad.size` → `integer``Save.clear()` {#save-api-method-clear}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.clear()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.clear()` method.
### `Save.get()` {#save-api-method-get}
Deprecated:
This method has been deprecated and should no longer be used.
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated.
### `Save.ok()` → `boolean` {#save-api-method-ok}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.isEnabled()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.isEnabled()` method.
### `Save.autosave.delete()` {#save-api-method-autosave-delete}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.auto.delete()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.auto.delete()` method.
### `Save.autosave.get()` → `object` {#save-api-method-autosave-get}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.auto.get()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.auto.get()` method.
### `Save.autosave.has()` → `boolean` {#save-api-method-autosave-has}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.auto.has()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.auto.has()` method.
### `Save.autosave.load()` {#save-api-method-autosave-load}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.auto.load()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.auto.load()` method.
### `Save.autosave.ok()` → `boolean` {#save-api-method-autosave-ok}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.auto.isEnabled()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.auto.isEnabled()` method.
### `Save.autosave.save([title [, metadata]])` {#save-api-method-autosave-save}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.auto.save()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.auto.save()` method.
### `Save.slots.length` → `integer` {#save-api-getter-slots-length}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.slot.size
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.slot.size` property.
### `Save.slots.count()` → `integer` {#save-api-method-slots-count}
Deprecated:
This method has been deprecated and should no longer be used.
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated.
### `Save.slots.delete(slot)` {#save-api-method-slots-delete}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.slot.delete()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.slot.delete()` method.
### `Save.slots.get(slot)` → `object` {#save-api-method-slots-get}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.slot.get()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.slot.get()` method.
### `Save.slots.has(slot)` → `boolean` {#save-api-method-slots-has}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.slot.has()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.slot.has()` method.
### `Save.slots.isEmpty()` → `boolean` {#save-api-method-slots-isempty}
Deprecated:
This method has been deprecated and should no longer be used.
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated.
### `Save.slots.load(slot)` {#save-api-method-slots-load}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.slot.load()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.slot.load()` method.
### `Save.slots.ok()` → `boolean` {#save-api-method-slots-ok}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.slot.isEnabled()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.slot.isEnabled()` method.
### `Save.slots.save(slot [, title [, metadata]])` {#save-api-method-slots-save}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.browser.slot.save()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.browser.slot.save()` method.
### `Save.import(event)` {#save-api-method-import}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.disk.load()
#### History:
* `v2.0.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.disk.load()` method.
### `Save.export([filename [, metadata]])` {#save-api-method-export}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.disk.save()
#### History:
* `v2.0.0`: Introduced.
* `v2.8.0`: Added `metadata` parameter.
* `v2.37.0`: Deprecated in favor of the `Save.disk.save()` method.
### `Save.deserialize(saveStr)` → `any` | `null` {#save-api-method-deserialize}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.base64.load()
#### History:
* `v2.21.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.base64.load()` method.
### `Save.serialize([metadata])` → `string` | `null` {#save-api-method-serialize}
Deprecated:
This method has been deprecated and should no longer be used. See the Save.base64.save()
#### History:
* `v2.21.0`: Introduced.
* `v2.37.0`: Deprecated in favor of the `Save.base64.save()` method.