Wikiadmin: Created API index

2025-03-03T06:28:33Z

Created API index

New page

All public API functions and variables are listed below. Unless otherwise stated, everything is stored within the public table "lib"

{| class="wikitable"
! Function !! Description
|-
| '''NEO_EXISTS''' || (Global) Boolean true when Neoloader has started. Not part of the LME API
|-
| '''NEO_UNINSTALL''' || (Global) Boolean false when Neoloader is installing for the first time, true when told to uninstall. Otherwise, it shouldn't exist. Not part of the LME API
|-
| '''[0] = "LME"''' || String defining the public table "lib" as a 'Library Management Engine'; used for verifying if Neoloader (or compatible alternative) is installed or not.
See more in [[vendetta/overview|Neoloader general overview]] and the [[vendetta/design|LME design documentation]]
|-
| '''[1] = "Neoloader"''' || String defining the creator of the public table "lib"; just like [0], this is meant for verifying Neoloader as the creator of the lib table (as opposed to any future alternatives).
|-
| [[vendetta/API/activate_mod|activate_mod]] || Launches the selected mod (requires an authentication key)
|-
| [[vendetta/API/block_trap|block_trap]] || Similar to `pcall`, but errors trapped affect the linked mod's status; useful for hybrid mods.
|-
| [[vendetta/API/build_ini|build_ini]] || Constructs a Neoloader-relevant table from an INI file.
|-
| [[vendetta/API/check_queue|check_queue]] || Manually checks if delayed functions can be run.
|-
| [[vendetta/API/compare_sem_ver|compare_sem_ver]] || Compare two advanced version strings.
|-
| [[vendetta/API/err_handle|err_handle]] || Functions similarly to `assert`, but logs and returns instead of halting the Lua engine during game start.
|-
| [[vendetta/API/execute|execute]] || Activates a single function from a mod's set class.
|-
| [[vendetta/API/find_file|find_file]] || Attempts to find a file based on a list of possible locations.
|-
| [[vendetta/API/generate_key|generate_key]] || Creates a randomized key based on the SHA1 function.
|-
| [[vendetta/API/get_API|get_API]] || Gets the current API version of Neoloader.
|-
| [[vendetta/API/get_class|get_class]] || Gets a mod's class table.
|-
| [[vendetta/API/get_gstate|get_gstate]] || Gets Neoloader's general state.
|-
| [[vendetta/API/get_latest|get_latest]] || Gets the latest version of a mod.
|-
| [[vendetta/API/get_minor|get_minor]] || Gets the current minor version (additions to the API that don't change it).
|-
| [[vendetta/API/get_patch|get_patch]] || Gets the current patch version (fixes to the API that don't add anything new and don't change it).
|-
| [[vendetta/API/get_path|get_path]] || Gets the folder path of a mod.
|-
| [[vendetta/API/get_state|get_state]] || Gets a mod's state information in Neoloader.
|-
| [[vendetta/API/get_whole_ver|get_whole_ver]] || Gets a version broken down into individual components.
|-
| [[vendetta/API/is_exist|is_exist]] || Tests if a mod exists in Neoloader's registry.
|-
| [[vendetta/API/is_ready|is_ready]] || Tests if a mod in Neoloader's registry has been activated.
|-
| [[vendetta/API/lme_get_config|lme_get_config]] || Gets the current configuration of the LME provider.
|-
| [[vendetta/API/lme_configure|lme_configure]] || Configures the LME provider and saves the change.
|-
| [[vendetta/API/lock_class|lock_class]] || Prevents changes to a mod's class table.
|-
| [[vendetta/API/log_error|log_error]] || `print()`, but for Neoloader. Use this to have your mod's debug messages added to Neoloader's log.
|-
| [[vendetta/API/mod_read_str|mod_read_str]] || Reads a string from a mod's registration file.
|-
| [[vendetta/API/notify|notify]] || Sends a notification to Neoloader's current management interface.
|-
| [[vendetta/API/open_config|open_config]] || Opens the currently set management engine for Neoloader.
|-
| [[vendetta/API/open_if_config|open_if_config]] || Opens the currently set interface manager for Neoloader.
|-
| [[vendetta/API/pass_ini_identifier|pass_ini_identifier]] || Used internally; returns the ID/version of a mod when passed the INI file path.
|-
| [[vendetta/API/register|register]] || Registers a new mod into Neoloader.
|-
| [[vendetta/API/reload|reload]] || Triggers an interface reload.
|-
| [[vendetta/API/request_auth|request_auth]] || Obtains Neoloader's session auth key.
|-
| [[vendetta/API/require|require]] || Delays a function until the provided list of dependencies are met.
|-
| [[vendetta/API/resolve_dep_table|resolve_dep_table]] || Tests if the provided list of dependencies are met.
|-
| [[vendetta/API/resolve_file|resolve_file]] || Tries to load and execute the provided file.
|-
| [[vendetta/API/set_class|set_class]] || Sets the class table of a mod.
|-
| [[vendetta/API/set_load|set_load]] || Sets the loading state of a registered plugin.
|-
| [[vendetta/API/set_waiting|set_waiting]] || Freezes or releases the impending execution of a mod's dependents.
|-
| [[vendetta/API/uninstall|uninstall]] || Removes Neoloader and closes the game (requires an authentication key).
|-
| [[vendetta/API/unlock_class|unlock_class]] || Removes a lock on a mod's class table.
|-
| [[vendetta/API/update_state|update_state]] || Allows editing of limited LME control values.
|}

Vendetta/API - Revision history

Wikiadmin: Created API index