Modding:Modder Guide/APIs/Input - Revision history

imported>Pathoschild: update for SMAPI 4.4.0 release

2026-01-11T03:50:22Z

update for SMAPI 4.4.0 release

← Older revision		Revision as of 03:50, 11 January 2026
Line 58:		Line 58:

	===Send input===		===Send input===
	~~{{SMAPI upcoming\|4.4.0}}~~
	You can send [[#SButton\|controller/keyboard/mouse button input]] programmatically, which is equivalent to the player physically pressing the button.		You can send [[#SButton\|controller/keyboard/mouse button input]] programmatically, which is equivalent to the player physically pressing the button.

imported>Margotbean: ru link

2026-01-07T18:52:25Z

ru link

← Older revision		Revision as of 18:52, 7 January 2026
Line 240:		Line 240:
	* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values		* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values

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

imported>Sunbeam135: /* See also */

2026-01-02T12:51:12Z

imported>Pathoschild: /* APIs */ + send input in SMAPI 4.4.0

2025-12-28T23:56:37Z

APIs: + send input in SMAPI 4.4.0

@@ Line 56: / Line 56: @@
 Game1.spriteBatch.DrawString(Game1.smallFont, "some text", cursorPos.ScreenPixels, Color.Black);
 </syntaxhighlight>
 ===Suppress input===

imported>Pathoschild: /* Suppress input */ remove {{SMAPI upcoming}} for released version

2025-05-31T17:51:37Z

Suppress input: remove {{SMAPI upcoming}} for released version

← Older revision		Revision as of 17:51, 31 May 2025
Line 72:		Line 72:
	\|-		\|-
	\| <code>SuppressScrollWheel</code>		\| <code>SuppressScrollWheel</code>
	~~\| {{SMAPI upcoming\|4.1.0~~\|Suppress a mouse wheel scroll.}}		\| Suppress a mouse wheel scroll.
	\|-		\|-
	\| <code>IsSuppressed</code>		\| <code>IsSuppressed</code>

imported>Pathoschild: /* Suppress input */ + SuppressScrollWheel in SMAPI 4.1.0

2024-11-04T00:08:41Z

Suppress input: + SuppressScrollWheel in SMAPI 4.1.0

← Older revision		Revision as of 00:08, 4 November 2024
Line 66:		Line 66:
	\|-		\|-
	\| <code>Suppress</code>		\| <code>Suppress</code>
	\| Suppress ~~the~~ specified [[#SButton\|<samp>SButton</samp>]] value.		\| Suppress a specified [[#SButton\|<samp>SButton</samp>]] value.
	\|-		\|-
	\| <code>SuppressActiveKeybinds</code>		\| <code>SuppressActiveKeybinds</code>
	\| ~~For the given~~ [[#KeybindList\|<samp>KeybindList</samp>]]~~, suppress every button that~~'s ~~part of an~~ activated ~~keybind~~.		\| Suppress every button that's part of a specified [[#KeybindList\|<samp>KeybindList</samp>]]'s activated keybinds.
			\|-
			\| <code>SuppressScrollWheel</code>
			\| {{SMAPI upcoming\|4.1.0\|Suppress a mouse wheel scroll.}}
	\|-		\|-
	\| <code>IsSuppressed</code>		\| <code>IsSuppressed</code>
	\| Get whether ~~the~~ specified [[#SButton\|<samp>SButton</samp>]] value is currently suppressed.		\| Get whether a specified [[#SButton\|<samp>SButton</samp>]] value is currently suppressed.
	\|}		\|}

imported>Margotbean: ZH link

2023-07-10T18:19:00Z

ZH link

← Older revision		Revision as of 18:19, 10 July 2023
Line 215:		Line 215:
	* [[../Events#Input\|Input events]]		* [[../Events#Input\|Input events]]
	* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values		* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values

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

imported>Pathoschild: /* Check cursor position */ fix typo

2023-02-07T22:09:19Z

Check cursor position: fix typo

← Older revision		Revision as of 22:09, 7 February 2023
Line 48:		Line 48:

	===Check cursor position===		===Check cursor position===
	The <samp>GetCursorPosition()</samp> method provides the [[#ICursorPosition\|cursor position in three coordinate systems~~\|ICursorPosition~~]].		The <samp>GetCursorPosition()</samp> method provides the [[#ICursorPosition\|cursor position in three coordinate systems]].

	For example:		For example:

imported>Erinthe: fixed keybind Shift to LeftShift

2022-01-14T11:42:17Z

fixed keybind Shift to LeftShift

← Older revision		Revision as of 11:42, 14 January 2022
Line 143:		Line 143:
	class ModConfig		class ModConfig
	{		{
	public KeybindList ToggleKey { get; set; } = KeybindList.Parse("~~Shift~~ + F2");		public KeybindList ToggleKey { get; set; } = KeybindList.Parse("LeftShift + F2");
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Line 149:		Line 149:
	\| <syntaxhighlight lang="json">		\| <syntaxhighlight lang="json">
	{		{
	"ToggleKey": "~~Shift~~ + F2"		"ToggleKey": "LeftShift + F2"
	}		}
	</syntaxhighlight>		</syntaxhighlight>

imported>Margotbean: Text replacement - "i.e. " to "''i.e.,'' "

2021-11-08T01:06:35Z

Text replacement - "i.e. " to "''i.e.,'' "

← Older revision		Revision as of 01:06, 8 November 2021
Line 186:		Line 186:
	\|-		\|-
	\| <code>IsDown()</code>		\| <code>IsDown()</code>
	\| Get whether any keybind in the list is currently down (i.e. the player pressed or is holding down the keys).		\| Get whether any keybind in the list is currently down (''i.e.,'' the player pressed or is holding down the keys).
	\|-		\|-
	\| <code>JustPressed()</code>		\| <code>JustPressed()</code>
	\| Get whether the player just activated the keybind during the current tick (i.e. <code>GetState()</code> returns <samp>Pressed</samp> instead of <samp>Held</samp>).		\| Get whether the player just activated the keybind during the current tick (''i.e.,'' <code>GetState()</code> returns <samp>Pressed</samp> instead of <samp>Held</samp>).
	\|-		\|-
	\| <code>GetKeybindCurrentlyDown()</code>		\| <code>GetKeybindCurrentlyDown()</code>
Line 210:		Line 210:
	This is returned by the <samp>this.Helper.Input.GetCursorPosition()</samp> method and in the event args for some input events.		This is returned by the <samp>this.Helper.Input.GetCursorPosition()</samp> method and in the event args for some input events.

	'''The pixel positions are ''not'' adjusted for [[Modding:Modder Guide/Game Fundamentals#UI scaling\|UI scaling]]''' (i.e. they're non-UI mode). Whether you need UI or non-UI positions depends how you're using them, so you can use <samp>cursorPos.GetScaledAbsolutePixels()</samp> or <samp>cursorPos.GetScaledScreenPixels()</samp> to adjust them automatically for the current mode or <samp>Utility.ModifyCoordinatesForUIScale</samp> to always get UI mode coordinates.		'''The pixel positions are ''not'' adjusted for [[Modding:Modder Guide/Game Fundamentals#UI scaling\|UI scaling]]''' (''i.e.,'' they're non-UI mode). Whether you need UI or non-UI positions depends how you're using them, so you can use <samp>cursorPos.GetScaledAbsolutePixels()</samp> or <samp>cursorPos.GetScaledScreenPixels()</samp> to adjust them automatically for the current mode or <samp>Utility.ModifyCoordinatesForUIScale</samp> to always get UI mode coordinates.

	==See also==		==See also==
	* [[../Events#Input\|Input events]]		* [[../Events#Input\|Input events]]
	* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values		* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values

← Older revision		Revision as of 12:51, 2 January 2026
Line 240:		Line 240:
	* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values		* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values

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