Skip to content

LoadOrder

Nightinggale edited this page Jun 5, 2018 · 1 revision

What it does

Tells if a mod is loaded before another mod.


Why you want to use this

Sometimes certain mods have to be loaded in a specific order if they are to work as intended. LoadOrder adds the ability to write error messages to the log in case the order is wrong.


Tags

Tag Mandatory Type Description
patchName no string Name of patch for log/profiling
first no* string Name of the mod, which has to come first
last no* string Name of the mod, which has to come last
Log writing no

Note: if first or last is empty, it's assumed to be the mod, which contains the patch file.

Note2: if both first and last are empty, the check goes into a legacy compatibility mode. Don't write new files using the old approach. The new one is easier to set up and as such much harder to get wrong.


Pass condition

It passes when first is loaded after last.

If either first or last looks for a mod, which is not loaded at all, then the test pass as well. This is intensional and aimed at the case where a mod is optional, but restricted order if present. If you need a mod to be loaded and in a specific order, you need to use both LoadOrder and IsModLoaded.


Example

<li Class="ModCheck.LoadOrder">
    <patchName>Makes sure this is loaded after Core</patchName>
    <first>Core</first>
</li>

Clone this wiki locally