Difference between revisions of "Modding:Modder Guide/APIs"

Revision as of 04:52, 28 May 2018

Creating SMAPI mods

SMAPI provides a number of APIs for mods to use. Click a section on the right or below for more details.

page	summary
Manifest	A file needed for every mod or content pack which describes the mod, lists dependencies, enables update checks, etc.
Events	Respond when something happens in the game (e.g. when a save is loaded), and often include details about what happened.
Mod configuration	Let players edit a `config.json` file to configure your mod.
Content	Load images/maps/data, and edit or replace the game's images/maps/data.
Logging	Write messages to the SMAPI console and log.
Reflection	Access fields, properties, or methods which are normally inaccessible.
Multiplayer	Provides methods for supporting multiplayer.
Translation	Translate your mod text into any game language.
Utilities	Use constants, contextual information, date logic, and semantic versions.

page	summary
Content packs	Let other modders provide files for your mod to read, which players can install like any other mod.
Console commands	Add custom commands to the SMAPI console.
Mod integrations	Get information about loaded mods, and integrate with mods using mod-provided APIs.

@@ Line 52: / Line 52: @@
 | Get information about loaded mods, and integrate with mods using mod-provided APIs.
 |}
-==Mod APIs==
-===Reflection===
-SMAPI provides an API for robustly accessing fields, properties, or methods you otherwise couldn't access, such as private fields. You can use it from <tt>helper.Reflection</tt> in your entry method, or <tt>this.Helper.Reflection</tt> elsewhere in your entry class.
-Here are a few examples of what this lets you do:
-<source lang="c#">
-// did you pet your pet today?
-bool wasPet = this.Helper.Reflection.GetField<bool>(pet, "wasPetToday").GetValue();
-// what is the spirit forecast today?
-string forecast = this.Helper.Reflection
-   .GetMethod(new TV(), "getFortuneForecast")
-   .Invoke<string>();
-// randomise the mines
-if(Game1.currentLocation is MineShaft)
-   this.Helper.Reflection.GetField<Random>(Game1.currentLocation, "mineRandom").SetValue(new Random());
-</source>
-This works with static or instance fields/methods, caches the reflection to improve performance, and will throw useful errors automatically when reflection fails.
-If you need to do more, you can switch to [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C#'s underlying reflection API]:
-<source lang="c#">
-FieldInfo field = this.Helper.Reflection.GetField<string>(…).FieldInfo;
-MethodInfo method = this.Helper.Reflection.GetMethod(…).MethodInfo;
-</source>