Class engine.Module

Handles dialog windows

Methods

engine.Module:versionString (mod)

Create a version string for the module version Static

engine.Module:listModules (incompatible, moddir_filter)

List all available modules Static

engine.Module:loadDefinition (dir, team, incompatible)

Get a module definition from the module init.lua file

engine.Module:listSavefiles (incompatible_module, moddir_filter)

List all available savefiles Static

engine.Module:listVaultSaves ()

List all available vault characters Static

engine.Module:listVaultSavesForCurrent ()

List all available vault characters for the currently running module Static

engine.Module:listBackgrounds (mod)

List all available background alterations

engine.Module:listAddons (mod, ignore_compat)

List all available addons

engine.Module:loadScreen (mod)

Make a module loadscreen

engine.Module:instanciate (mod, name, new_game, no_reboot, extra_module_info)

Instanciate the given module, loading it and creating a new game / loading an existing one

engine.Module:setupWrite (mod, nomount)

Setup write dir for a module Static

engine.Module:loadSavefileDescription (dir)

Get a savefile description from the savefile desc.lua file



Methods

engine.Module:versionString (mod)
Create a version string for the module version Static

Parameters:

  • mod
engine.Module:listModules (incompatible, moddir_filter)
List all available modules Static

Parameters:

  • incompatible
  • moddir_filter
engine.Module:loadDefinition (dir, team, incompatible)
Get a module definition from the module init.lua file

Parameters:

  • dir
  • team
  • incompatible
engine.Module:listSavefiles (incompatible_module, moddir_filter)
List all available savefiles Static

Parameters:

  • incompatible_module
  • moddir_filter
engine.Module:listVaultSaves ()
List all available vault characters Static
engine.Module:listVaultSavesForCurrent ()
List all available vault characters for the currently running module Static
engine.Module:listBackgrounds (mod)
List all available background alterations

Parameters:

  • mod
engine.Module:listAddons (mod, ignore_compat)
List all available addons

Parameters:

  • mod
  • ignore_compat
engine.Module:loadScreen (mod)
Make a module loadscreen

Parameters:

  • mod
engine.Module:instanciate (mod, name, new_game, no_reboot, extra_module_info)
Instanciate the given module, loading it and creating a new game / loading an existing one

Parameters:

  • mod the module definition as given by Module:loadDefinition()
  • name the savefile name
  • new_game true if the game must be created (aka new character)
  • no_reboot
  • extra_module_info
engine.Module:setupWrite (mod, nomount)
Setup write dir for a module Static

Parameters:

  • mod
  • nomount Create module directory
engine.Module:loadSavefileDescription (dir)
Get a savefile description from the savefile desc.lua file

Parameters:

  • dir
generated by LDoc 1.4.3