Manifest

The functions on this page are accessible from only the manifest.lua file that lists the contents of a mod.

void set_global_name(String name)
Sets the name displayed on the chapter select screen.

void add_chapter(String name, Float x, Float y)
Creates a new chapter, to be displayed at the coordinates (x, y) on the chapter select screen.

void add_level_to_chapter(String chapter_name, String level_name, Float x, Float y)
Creates a new level, to be displayed at the coordinates (x, y) on the level select screen for the given chapter. There must be a level with this name within the mod's main directory and level names must be unique.

void add_level_path_require(String before_level, String after_level)
Makes unlocking after_level require completing before_level and draws a path between them. The levels must be in the same chapter.

void add_level_path(String before_level, String after_level)
Draws a path between the two given levels. The levels must be in the same chapter.

void set_next_level_hint(String before_level, String after_level) void set_next_level_hint(String before_level, vector<String> after_level)
Overrides the default priority of which levels should be candidates for when the users clicks the Next Level button after finishing before_level.

void disallow_default_next_levels(String before_level)
Restricts the selection of Next Level to one which has been explicitly listed by set_next_level_hint

void add_achievement_to_level(String level_name, String achievement_name, vector<Prerequisite>? prerequisites)
Adds a new achievement, which will display once all prerequisites are met (if any are listed). A single prerequisite can also be passed in place of a vector. This must be done in order for achievements to display in the info panel.

void add_chapter_path(String before_chapter, String after_chapter)
Draws a path between the two given chapters.

void add_chapter_requirement(String chapter_name, vector<Prerequisite> prerequisites)
Adds the given prerequisites to unlock the named chapter. A single prerequisite can be passed in the slot of the vector.

void add_chapter_requirement(String chapter_name, vector<Prerequisite> prerequisites)
Adds the given prerequisites to unlock the named chapter. A single prerequisite can be passed in place of a vector if desired.

void add_level_requirement(String level_name, vector<Prerequisite> prerequisites)
Adds the given prerequisites to unlock the named level. A single prerequisite can be passed in place of a vector if desired.

void add_level_description(String level_name, String description)
Adds the given description to the named level, visible on the level select screen.

void add_chapter_description(String chapter_name, String description)
Adds the given description to the named chapter, visible on the chapter select screen.

void add_level_list_global_achievement(String achievement_name, vector<String> levels, Int? count)
Adds a new mod-wide achievement for completing the given count (default: all) of levels from the list.

void add_chapter_global_achievement(String achievement_name, String chapter_name, Int? count)
Adds a new mod-wide achievement for completing the given count (default: all) of levels from the named chapter.

void add_achievement_list_global_achievement(String achievement_name, vector<(String, String)>, Int? count)
Adds a new mod-wide achievement for completing the given count (default: all) of achievements from the given list of {level_name, achievement_name} pairs.

Prerequisite

The following functions return prerequisites that can be fed to functions that require them:

Prerequisite prerequisite_level(String level_name)
Returns a prerequisite requiring the given level be completed.

Prerequisite prerequisite_level(String chapter_name, Int requirement_count)
Returns a prerequisite requiring the given number of levels from the specified chapter be completed.

Prerequisite n_achievements_among(vector<(String, String)>, Int requirement_count)
Returns a prerequisite requiring the given number of achievements be completed from the given list of pairs {level_name, achievement_name}