Skip to main content

game.load

Overview

  • Loads a specific save slot. This is ASYNCHRONOUS and returns as soon as the request is accepted: poll game.get_state until phase == 'in_game'. Callable from the lobby or from inside a running game (the current session is torn down and replaced). When 'file' is omitted it defaults to the folder name, then falls back to the matching entry from the save list (auto saves use a different file name than their folder). Rejected while a level move is already in flight - a second request would be swallowed silently, so poll game.get_state until the first one finishes instead of retrying immediately.

Metadata

FieldValue
DisplayLoad Save
Categorygame
AccessUserCheat
ScopeB1Standalone
TagsExperimental
Aliases—

Parameters

NameTypeRequiredDefaultDescription
folderstringyes—Save folder name from game.list_saves
filestringno—Save file name. Omit to resolve it automatically from the folder.

Usage

await inzoi.cli.execute('game.load', {
folder: '',
file: '', // optional
});