Luxen: /* Returns */ LME 3.12.x behavior adds statistical reporting of memory and launch time values

2025-07-21T20:17:01Z

Returns: LME 3.12.x behavior adds statistical reporting of memory and launch time values

← Older revision		Revision as of 20:17, 21 July 2025
Line 49:		Line 49:
	\|-		\|-
	\| '''plugin_dependencies''' \|\| Table - A copy of this plugin's dependency list.		\| '''plugin_dependencies''' \|\| Table - A copy of this plugin's dependency list.
			\|-
			\| '''stats''' \|\| Table - contains statistical values related to load-time footprint and time taken to load.
	\|}		\|}

Wikiadmin: created get_state

2025-03-03T15:02:59Z

created get_state

New page

=== Definition ===
lib.get_state (id, version) :: mod_state_table

=== Description ===
Retrieves the state information of the selected mod

=== Arguments ===
# string id: name of the mod to be activated
# string version: version of the mod to be activated

=== Returns ===
# table mod_state: A table describing the mod's current state within the Neoloader registry
table definition:
{| class="wikitable"
! Key !! Description
|-
| '''load''' || String `"YES"` or `"NO"` - Indicates whether the mod is set to be loaded when Neoloader starts.
|-
| '''complete''' || Boolean - Indicates whether the mod completed successfully.
|-
| '''dependencies_met''' || Boolean - Determines whether all dependencies declared by the mod are satisfied.
|-
| '''load_position''' || Number - The order in which the mod was loaded compared to all registered mods.
|-
| '''errors''' || Table - List of logs associated with this mod.
|-
| '''latest''' || String - The latest version of this mod.
|-
| '''versions''' || Table - Contains all versions of this mod present in Neoloader.
|-
| '''plugin_id''' || String - The mod's unique ID.
|-
| '''plugin_version''' || String - The current version of the mod.
|-
| '''plugin_type''' || String - Descriptor of the mod, set by the author in the registration file.
(Not used by Neoloader, intended for managers.)
|-
| '''plugin_name''' || String - The public name of the mod.
|-
| '''plugin_author''' || String - The author of this mod.
|-
| '''plugin_link''' || String - A hyperlink to this mod's home page.
|-
| '''plugin_folder''' || String - The file path to the mod's folder.
|-
| '''plugin_ini_file''' || String - The file path to the mod's INI file.
|-
| '''plugin_frozen''' || String `"YES"` or `"NO"` - Determines whether this mod's dependents can execute.
|-
| '''plugin_dependencies''' || Table - A copy of this plugin's dependency list.
|}

=== Other notes ===
* Added in LME 2.x (Neoloader indev)
* Some of these details are not neccesary for Neoloader itself, and are intended to be used by potential mod management front-ends.

Vendetta/API/get state - Revision history

Luxen: /* Returns */ LME 3.12.x behavior adds statistical reporting of memory and launch time values

Wikiadmin: created get_state