Class ModSystem

Base of a system, which is part of a code mod. Takes care of setting up, registering and handling all sorts of things. You may choose to split up a mod into multiple distinct systems if you so choose, but there may also be just one.

Inheritance
System.Object
ModSystem
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Vintagestory.API.Common
Assembly: VintagestoryAPI.dll
Syntax
public abstract class ModSystem

Properties

AllowRuntimeReload

When the server reloads mods at runtime, should this mod also be reloaded. Return false e.g. for any mod that adds blocks.

Declaration
public virtual bool AllowRuntimeReload { get; }
Property Value
Type Description
System.Boolean

Mod

Gets the Mod this mod system is part of.

Declaration
public Mod Mod { get; }
Property Value
Type Description
Mod

Methods

Dispose()

If this mod allows runtime reloading, you must implement this method to unregister any listeners / handlers

Declaration
public virtual void Dispose()

ExecuteOrder()

If you need mods to be executed in a certain order, adjust this methods return value. The server will call each Mods Start() method the ascending order of each mods execute order value. And thus, as long as every mod registers it's event handlers in the Start() method, all event handlers will be called in the same execution order. Default execute order of some survival mod parts Worldgen:

  • GenTerra: 0
  • RockStrata: 0.1
  • Deposits: 0.2
  • Caves: 0.3
  • Blocklayers: 0.4 Loading
  • Json Overrides loader: 0.05
  • Load hardcoded mantle block: 0.1
  • Block&Item Loader: 0.2
  • Recipe (Smithing, Knapping, Clayforming, Grid recipes, Alloys) Loader: 1
Declaration
public virtual double ExecuteOrder()
Returns
Type Description
System.Double

ShouldLoad(EnumAppSide)

Returns if this mod should be loaded for the given app side.

Declaration
public virtual bool ShouldLoad(EnumAppSide forSide)
Parameters
Type Name Description
EnumAppSide forSide
Returns
Type Description
System.Boolean

Start(ICoreAPI)

Side agnostic Start method, called after all mods received a call to StartPre().

Declaration
public virtual void Start(ICoreAPI api)
Parameters
Type Name Description
ICoreAPI api

StartClientSide(ICoreClientAPI)

Minor convenience method to save yourself the check for/cast to ICoreClientAPI in Start()

Declaration
public virtual void StartClientSide(ICoreClientAPI api)
Parameters
Type Name Description
ICoreClientAPI api

StartPre(ICoreAPI)

Called during intial mod loading, called before any mod receives the call to Start()

Declaration
public virtual void StartPre(ICoreAPI api)
Parameters
Type Name Description
ICoreAPI api

StartServerSide(ICoreServerAPI)

Minor convenience method to save yourself the check for/cast to ICoreServerAPI in Start()

Declaration
public virtual void StartServerSide(ICoreServerAPI api)
Parameters
Type Name Description
ICoreServerAPI api