summaryrefslogtreecommitdiff
path: root/src/SMAPI/ICursorPosition.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI/ICursorPosition.cs')
-rw-r--r--src/SMAPI/ICursorPosition.cs17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/SMAPI/ICursorPosition.cs b/src/SMAPI/ICursorPosition.cs
new file mode 100644
index 00000000..ddb8eb49
--- /dev/null
+++ b/src/SMAPI/ICursorPosition.cs
@@ -0,0 +1,17 @@
+using Microsoft.Xna.Framework;
+
+namespace StardewModdingAPI
+{
+ /// <summary>Represents a cursor position in the different coordinate systems.</summary>
+ public interface ICursorPosition
+ {
+ /// <summary>The pixel position relative to the top-left corner of the visible screen.</summary>
+ Vector2 ScreenPixels { get; }
+
+ /// <summary>The tile position under the cursor relative to the top-left corner of the map.</summary>
+ Vector2 Tile { get; }
+
+ /// <summary>The tile position that the game considers under the cursor for purposes of clicking actions. This may be different than <see cref="Tile"/> if that's too far from the player.</summary>
+ Vector2 GrabTile { get; }
+ }
+}