Class Mod
- Namespace
- PolyMod
- Assembly
- PolyMod.dll
A mod that PolyMod found in the mods directory, or the base game entry with the id polytopia.
public class Mod
- Inheritance
-
Mod
- Inherited Members
Constructors
Mod(Manifest, Status, List<File>)
Makes a mod from a manifest.
public Mod(Mod.Manifest manifest, Mod.Status status, List<Mod.File> files)
Parameters
manifestMod.ManifestThe manifest that gives the id, name, description, version, authors, dependencies and client value.
statusMod.StatusThe initial load status of the mod.
filesList<Mod.File>The files of the mod.
Fields
authors
The names of the authors of the mod.
public string[] authors
Field Value
- string[]
checksum
The SHA-256 checksum of the mod, as a hexadecimal string. PolyMod makes it from the id, the version, and the name and contents of each file. It stays empty for client-side mods, for the base game entry, and for mods that do not have the status Success.
public string checksum
Field Value
client
If true, the mod is client-side only and PolyMod does not include it in the mod checksum.
public bool client
Field Value
dependencies
The dependencies of the mod, or null.
public Mod.Dependency[]? dependencies
Field Value
description
The description of the mod, or null.
public string? description
Field Value
files
The files of the mod. This list does not contain manifest.json.
public List<Mod.File> files
Field Value
id
The id of the mod.
public string id
Field Value
name
The name of the mod to show. If the manifest has no name, this is the id.
public string? name
Field Value
status
The load status of the mod.
public Mod.Status status
Field Value
version
The version of the mod.
public Version version