Table of Contents

Class Mod

Namespace
Vintagestory.API.Common
Assembly
VintagestoryAPI.dll

Represents a mod in the mod manager. May contain zero to multiple ModSystem instances within it.

public abstract class Mod
Inheritance
Mod
Inherited Members

Properties

FileName

Gets the file name of this mod.

public string FileName { get; }

Property Value

string

Icon

Holds the icon of this mod. Found as "modicon.png" in the root of the mod's folder or archive. May be null.

public BitmapExternal Icon { get; }

Property Value

BitmapExternal

Info

Gets the info of this mod. Found either as "modinfo.json" in the of the mod's folder or archive, or in the case of raw .cs and .dll files, using the ModInfoAttribute on the assembly.

public ModInfo Info { get; }

Property Value

ModInfo

Logger

Gets the logger associated with this mod.

public ILogger Logger { get; }

Property Value

ILogger

SourcePath

Gets the full path to where this mod originated from, including file name.

public string SourcePath { get; }

Property Value

string

SourceType

Gets the origin file type of the mod (.cs, .dll, .zip or folder).

public EnumModSourceType SourceType { get; }

Property Value

EnumModSourceType

Systems

Gets a collection of systems belonging to this mod.

public IReadOnlyCollection<ModSystem> Systems { get; }

Property Value

IReadOnlyCollection<ModSystem>

WorldConfig

public ModWorldConfiguration WorldConfig { get; }

Property Value

ModWorldConfiguration

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.