Vendetta/API/set waiting

From Quasar-RCE
Jump to navigationJump to search

Definition

lib.set_waiting (mod_id, mod_version, wait_state, freeze_key) :: nil

Description

  • Freezes or releases the pending execution state of mods dependent on the provided mod.
    • This means that plugins set as dependent will be delayed until the master is ‘released’

Arguments

  1. string mod_id: the mod to be frozen
  2. string mod_version: the version of the mod to be frozen
  3. string wait_state: "YES" to freeze the mod, "NO" to release the mod
  4. freeze_key: any value to act as a lock on this mod's dependents

Returns

  1. nil

Other notes

  • Added in LME 3.8.x
  • This function is vital for plugins that expect to do a lot of execution after the LME Init phase, such as any mod that expects to run during the default mod loader sequence.
  • This functionality will be rolled into update_state in an upcoming release and this function will be listed as deprecated