Skip to content

IsModSyncVersion

Nightinggale edited this page Jun 7, 2018 · 1 revision

What it does

Tests if the version in ModSync in a specific mod is of at least a specific version.


Why you want to use this

To provide a human readable error message if using an outdated mod will cause problems. This should only be an issue for people obtaining mods by other means than through steam.


Tags

Tag Mandatory Type Default Description
patchName no string Name of patch for log/profiling
modName yes string Name of the mod you the version from
version yes string The minimum version you want to accept
errorOnFail no bool false Sets a default error message if test fails
Log writing no

Version is Version from about.xml in the target mod. It has the form x.x, x.x.x or x.x.x.x where each x is a number. If the mod uses a different system for versioning, then ModCheck can't compare versions and will throw an error.


Pass condition

Passes the test if the mod version is the same or higher than the version tag.

Note that it tests one digit at a time and only tests the next if the first is identical. In other words 2.0 is higher than 1.9.


Example

<li Class="ModCheck.IsModSyncVersion">
    <modName>Core</modName>
    <version>0.18.1234</version>
    <errorOnFail>true</errorOnFail>
</li>

Clone this wiki locally