Modding:Modder Guide/APIs/Reflection - Revision history

imported>Margotbean: ru link

2026-01-07T18:54:07Z

ru link

← Older revision		Revision as of 18:54, 7 January 2026
Line 73:		Line 73:
	Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.		Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.

	[[ru:Модификации:Руководство мододела/API/~~Reflection~~]]		[[ru:Модификации:Руководство мододела/API/Рефлексия]]
	[[zh:模组:制作指南/APIs/Reflection]]		[[zh:模组:制作指南/APIs/Reflection]]

imported>Sunbeam135: /* Advanced reflection */

2026-01-02T13:01:51Z

Advanced reflection

← Older revision		Revision as of 13:01, 2 January 2026
Line 73:		Line 73:
	Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.		Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.

			[[ru:Модификации:Руководство мододела/API/Reflection]]
	[[zh:模组:制作指南/APIs/Reflection]]		[[zh:模组:制作指南/APIs/Reflection]]

imported>VulpesLucida: zh link

2025-01-05T14:30:44Z

zh link

← Older revision		Revision as of 14:30, 5 January 2025
Line 72:		Line 72:

	Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.		Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.

			[[zh:模组:制作指南/APIs/Reflection]]

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:48:52Z

Text replacement - "tt>" to "samp>"

← Older revision		Revision as of 18:48, 4 November 2021
Line 1:		Line 1:
	{{../../header}}		{{../../header}}

	The reflection API lets you access fields, properties, or methods you otherwise couldn't access. You can use it from <tt>helper.Reflection</tt> in your entry method, or <tt>this.Helper.Reflection</tt> elsewhere in your entry class.		The reflection API lets you access fields, properties, or methods you otherwise couldn't access. You can use it from <samp>helper.Reflection</samp> in your entry method, or <samp>this.Helper.Reflection</samp> elsewhere in your entry class.

	==Intro==		==Intro==
Line 8:		Line 8:
	==Basic reflection==		==Basic reflection==
	===Overview===		===Overview===
	SMAPI provides three overloaded methods to access code: <tt>GetField</tt>, <tt>GetProperty</tt>, and <tt>GetMethod</tt>. Each one takes three arguments:		SMAPI provides three overloaded methods to access code: <samp>GetField</samp>, <samp>GetProperty</samp>, and <samp>GetMethod</samp>. Each one takes three arguments:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 14:		Line 14:
	! purpose		! purpose
	\|-		\|-
	\| <tt>obj</tt> or <tt>type</tt>		\| <samp>obj</samp> or <samp>type</samp>
	\| The instance (or type if static) which has the private field/property/method you want to access.		\| The instance (or type if static) which has the private field/property/method you want to access.
	\|-		\|-
	\| <tt>name</tt>		\| <samp>name</samp>
	\| The name of the private field/property/method.		\| The name of the private field/property/method.
	\|-		\|-
	\| <tt>required</tt>		\| <samp>required</samp>
	\| Whether to throw a descriptive exception if the field/property/method isn't found. Default true. If set to false, it will return <tt>null</tt> instead and you should validate it yourself.		\| Whether to throw a descriptive exception if the field/property/method isn't found. Default true. If set to false, it will return <samp>null</samp> instead and you should validate it yourself.
	\|}		\|}

Line 27:		Line 27:

	===Fields and properties===		===Fields and properties===
	<tt>GetField</tt> and <tt>GetProperty</tt> are used the same way. Both return an object with two methods: <tt>GetValue</tt> returns the current field/property value, and <tt>SetValue</tt> overrides their value.		<samp>GetField</samp> and <samp>GetProperty</samp> are used the same way. Both return an object with two methods: <samp>GetValue</samp> returns the current field/property value, and <samp>SetValue</samp> overrides their value.

	You can get the value directly:		You can get the value directly:
Line 45:		Line 45:

	===Methods===		===Methods===
	<tt>GetMethod</tt> returns an object with one overloaded method. The <tt>Invoke</tt> comes in two forms:		<samp>GetMethod</samp> returns an object with one overloaded method. The <samp>Invoke</samp> comes in two forms:
	* <tt>Invoke()</tt> calls a method with no return value.		* <samp>Invoke()</samp> calls a method with no return value.
	* <tt>Invoke<T>()</tt> calls a method which returns a value, where <tt>T</tt> is the expected return type.		* <samp>Invoke<T>()</samp> calls a method which returns a value, where <samp>T</samp> is the expected return type.

	For example, this calls the private <tt>TV.getFortuneForecast</tt> method and stores the value it returns:		For example, this calls the private <samp>TV.getFortuneForecast</samp> method and stores the value it returns:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	string forecast = this.Helper.Reflection		string forecast = this.Helper.Reflection
Line 56:		Line 56:
	</syntaxhighlight>		</syntaxhighlight>

	If the method expects arguments, you can just add those to the <tt>Invoke</tt> method:		If the method expects arguments, you can just add those to the <samp>Invoke</samp> method:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	Vector2 spawnTile = new Vector2(25, 25);		Vector2 spawnTile = new Vector2(25, 25);

imported>RetroEdit: Replace deprecated tags with tags

2021-02-19T18:27:05Z

Replace deprecated <source> tags with <syntaxhighlight> tags

← Older revision		Revision as of 18:27, 19 February 2021
Line 30:		Line 30:

	You can get the value directly:		You can get the value directly:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	// get value of instance field		// get value of instance field
	bool wasPet = this.Helper.Reflection.GetField<bool>(pet, "wasPetToday").GetValue();		bool wasPet = this.Helper.Reflection.GetField<bool>(pet, "wasPetToday").GetValue();
	</~~source~~>		</syntaxhighlight>

	Or you can keep a reference to the reflection data, and change the value separately:		Or you can keep a reference to the reflection data, and change the value separately:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	// set value of static field		// set value of static field
	IReflectedField<int> soundTimer = this.Helper.Reflection.GetField<int>(typeof(Junimo), "soundTimer");		IReflectedField<int> soundTimer = this.Helper.Reflection.GetField<int>(typeof(Junimo), "soundTimer");
	soundTimer.SetValue(100);		soundTimer.SetValue(100);
	</~~source~~>		</syntaxhighlight>

	If you need to access the field/property repeatedly, keeping the reflection object will improve performance.		If you need to access the field/property repeatedly, keeping the reflection object will improve performance.
Line 50:		Line 50:

	For example, this calls the private <tt>TV.getFortuneForecast</tt> method and stores the value it returns:		For example, this calls the private <tt>TV.getFortuneForecast</tt> method and stores the value it returns:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	string forecast = this.Helper.Reflection		string forecast = this.Helper.Reflection
	.GetMethod(new TV(), "getFortuneForecast")		.GetMethod(new TV(), "getFortuneForecast")
	.Invoke<string>();		.Invoke<string>();
	</~~source~~>		</syntaxhighlight>

	If the method expects arguments, you can just add those to the <tt>Invoke</tt> method:		If the method expects arguments, you can just add those to the <tt>Invoke</tt> method:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	Vector2 spawnTile = new Vector2(25, 25);		Vector2 spawnTile = new Vector2(25, 25);
	this.helper.Reflection		this.helper.Reflection
	.GetMethod(Game1.getFarm(), "doSpawnCrow")		.GetMethod(Game1.getFarm(), "doSpawnCrow")
	.Invoke(spawnTile);		.Invoke(spawnTile);
	</~~source~~>		</syntaxhighlight>

	==Advanced reflection==		==Advanced reflection==
	If you need to do more, you can access the underlying C# reflection types:		If you need to do more, you can access the underlying C# reflection types:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	FieldInfo field = this.Helper.Reflection.GetField<string>(…).FieldInfo;		FieldInfo field = this.Helper.Reflection.GetField<string>(…).FieldInfo;
	MethodInfo method = this.Helper.Reflection.GetMethod(…).MethodInfo;		MethodInfo method = this.Helper.Reflection.GetMethod(…).MethodInfo;
	</~~source~~>		</syntaxhighlight>

	Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.		Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.

imported>Pathoschild: remove footer (no longer needed with new sidebar)

2019-09-13T18:01:41Z

remove footer (no longer needed with new sidebar)

← Older revision		Revision as of 18:01, 13 September 2019
Line 72:		Line 72:

	Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.		Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.

	~~{{modding guide footer~~
	~~\|prev = [[Modding:Modder Guide/APIs\|SMAPI reference]]~~
	~~\|next =~~
	}}

imported>Pathoschild: + footer nav links

2018-06-07T18:27:39Z

+ footer nav links

← Older revision		Revision as of 18:27, 7 June 2018
Line 72:		Line 72:

	Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.		Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.

			{{modding guide footer
			\|prev = [[Modding:Modder Guide/APIs\|SMAPI reference]]
			\|next =
			}}

imported>Pathoschild: expand

2018-05-28T05:28:30Z

expand

← Older revision		Revision as of 05:28, 28 May 2018
Line 1:		Line 1:
	{{../../header}}		{{../../header}}

	~~===Reflection===~~		The reflection API lets you access fields, properties, or methods you otherwise couldn't access. You can use it from <tt>helper.Reflection</tt> in your entry method, or <tt>this.Helper.Reflection</tt> elsewhere in your entry class.
	~~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:~~		==Intro==
			[https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection ''Reflection''] is a powerful C# feature which lets code analyse and interact with code. SMAPI provides a simplified reflection API focused on accessing private game fields, properties, and methods. SMAPI will automatically handle validation, caching, and performance optimisation.

			==Basic reflection==
			===Overview===
			SMAPI provides three overloaded methods to access code: <tt>GetField</tt>, <tt>GetProperty</tt>, and <tt>GetMethod</tt>. Each one takes three arguments:
			{\| class="wikitable"
			\|-
			! argument
			! purpose
			\|-
			\| <tt>obj</tt> or <tt>type</tt>
			\| The instance (or type if static) which has the private field/property/method you want to access.
			\|-
			\| <tt>name</tt>
			\| The name of the private field/property/method.
			\|-
			\| <tt>required</tt>
			\| Whether to throw a descriptive exception if the field/property/method isn't found. Default true. If set to false, it will return <tt>null</tt> instead and you should validate it yourself.
			\|}

			Each method returns an object you can use to interact further with it — like getting or setting the field/property value, or invoking the method.

			===Fields and properties===
			<tt>GetField</tt> and <tt>GetProperty</tt> are used the same way. Both return an object with two methods: <tt>GetValue</tt> returns the current field/property value, and <tt>SetValue</tt> overrides their value.

			You can get the value directly:
	<source lang="c#">		<source lang="c#">
	// ~~did you pet your pet today?~~		// get value of instance field
	bool wasPet = this.Helper.Reflection.GetField<bool>(pet, "wasPetToday").GetValue();		bool wasPet = this.Helper.Reflection.GetField<bool>(pet, "wasPetToday").GetValue();
			</source>

			Or you can keep a reference to the reflection data, and change the value separately:
			<source lang="c#">
			// set value of static field
			IReflectedField<int> soundTimer = this.Helper.Reflection.GetField<int>(typeof(Junimo), "soundTimer");
			soundTimer.SetValue(100);
			</source>

	// ~~what~~ is the ~~spirit forecast today?~~		If you need to access the field/property repeatedly, keeping the reflection object will improve performance.

			===Methods===
			<tt>GetMethod</tt> returns an object with one overloaded method. The <tt>Invoke</tt> comes in two forms:
			* <tt>Invoke()</tt> calls a method with no return value.
			* <tt>Invoke<T>()</tt> calls a method which returns a value, where <tt>T</tt> is the expected return type.

			For example, this calls the private <tt>TV.getFortuneForecast</tt> method and stores the value it returns:
			<source lang="c#">
	string forecast = this.Helper.Reflection		string forecast = this.Helper.Reflection
	.GetMethod(new TV(), "getFortuneForecast")		.GetMethod(new TV(), "getFortuneForecast")
	.Invoke<string>();		.Invoke<string>();
			</source>

	/~~/ randomise the mines~~		If the method expects arguments, you can just add those to the <tt>Invoke</tt> method:
	if(~~Game1.currentLocation is MineShaft~~)		<source lang="c#">
	this.~~Helper~~.Reflection.~~GetField<Random>~~(Game1.~~currentLocation~~, "~~mineRandom~~").~~SetValue~~(~~new Random()~~);		Vector2 spawnTile = new Vector2(25, 25);
			this.helper.Reflection
			.GetMethod(Game1.getFarm(), "doSpawnCrow")
			.Invoke(spawnTile);
	</source>		</source>

	~~This works with static or instance fields/methods, caches the~~ reflection ~~to improve performance, and will throw useful errors automatically when reflection fails.~~		==Advanced reflection==
			If you need to do more, you can access the underlying C# reflection types:
	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#">		<source lang="c#">
	FieldInfo field = this.Helper.Reflection.GetField<string>(…).FieldInfo;		FieldInfo field = this.Helper.Reflection.GetField<string>(…).FieldInfo;
	MethodInfo method = this.Helper.Reflection.GetMethod(…).MethodInfo;		MethodInfo method = this.Helper.Reflection.GetMethod(…).MethodInfo;
	</source>		</source>

			Or even use [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/reflection C# reflection] directly. Note that SMAPI adds caching and optimisations which you'll need to handle yourself if you do this.

imported>Pathoschild: move content from Modding:Modder Guide/APIs (only author is Pathoschild)

2018-05-28T04:52:27Z

move content from Modding:Modder Guide/APIs (only author is Pathoschild)

New page

{{../../header}}

===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>