| nav_order |
|---|
4 |
The Mod base class is the class that allows the Modloader (Modding Api) to load your mod into the game, as such, the class deriving from this class is the one that will serve as the entry point of your mod, where you can :
- Set your load priority
- Set your Mod's Name
- Set your Mod's Version
- Request for preloads
- Initialize your mod
you can also use additional features of the base class, by implementing optional interfaces
By default Mods are loaded in an unspecified order, if for some reason you need to ensure that your mod loads earlier or later than some other mods, you can use the load priority to denote that.
To do this add the following method to your Mod class :
public override int LoadPriority() => PRIORITY;Where PRIORITY is an int, higher values of priority will load your mod later and lower values will load your mod earlier in relation to other mods. i.e any Mod with priority 5 loads after any Mods priority 4 or lower.
Note: if no priority is specified, then the default priority of
0is used
By "load" order we strictly mean the order in which the Initialize method is called, the Mod class constructors may be called out of this order, do not rely on constructor order.
The Default name of your mod is the name of the Mod class, if you need to change that, you can do so by passing the name to the base class constructor, like so :
public MyFirstMod() : base("My 1st Mod") { }To allow user's to tell your mod versions apart and to allow you to debug issues, you can set the version
public override string GetVersion() => "v0.1";Note: it is advisable to always change your version before publishing a new release to make sure that people are able to use the right version when installing / reporting bugs.
The Mod base class allows your mod to request the Modding Api to preload game objects from a particular scene. for more information see Preloading game objects .
The Mod base class allows your mod to receive the Preloaded objects, and work with setting up your mod code in Initialize. This method is called after your mod class is constructed, but beware that it is called more than once, especially if your mod is toggled on and off. refer to Mod Lifecycle for more details on the order of execution.
Todo
Global settings are the way mods can save settings that should persist across save games
refer to creating global settings
Local settings are the way mods can save data per save game, this may be settings but for more involved mods this may include saving play state for example : if a player has acquired a custom item or not in this save, could be saved here.
refer to creating local settings
Mod menu is the way for mods to give the player an interactive UI to change their settings as opposed to editing settings files manually. Instead of using custom UI to handle this, it is recommended to use the Mod menu so that players can have a consistent experience and the pause menu is not cluttered, wherever possible.
for more about creating menus, head over to the dedicated page that covers the different types of Mod menus