Vendetta/API/set load

From Quasar-RCE
Revision as of 15:35, 3 March 2025 by Wikiadmin (talk | contribs) (created set_load)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Definition

lib.set_state (auth key, mod_id, mod_version, load_state) :: nil

Description

Changes the mod's ability to load to the new load state.

Arguments

  1. auth key: The auth key must be provided for this functionality
  2. string mod_id: the mod who's load state will be adjusted
  3. string mod_version: the version of the mod who's load state will be adjusted
  4. string load_state: the new load state for this mod. Valid options are "YES", "NO", "AUTH", and "FORCE".

Returns

  1. nil

Other notes

  • Added in LME 3.7.x
  • If the auth key is incorrect, this function fails silently
  • If the new load state is not valid, "NO" (do not load) is used instead