Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UserInputService.yaml #1026

Merged
merged 3 commits into from
Feb 14, 2025
+3 −2
Merged

Update UserInputService.yaml #1026

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e3f5f3
Update UserInputService.yaml
lack-of-gravity-jack Feb 13, 2025
005f239
Update content/en-us/reference/engine/classes/UserInputService.yaml
IgnisRBX Feb 14, 2025
6d76167
Apply suggestions from code review
IgnisRBX Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions content/en-us/reference/engine/classes/UserInputService.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1176,8 +1176,9 @@ methods:
to the top left corner of the screen.
description: |
This function returns a `Datatype.Vector2` representing the current screen
location of the player's `Class.Mouse` in pixels relative to the top left
corner. This does not account for the `Class.GuiObject` inset.
location of the player's `Class.Mouse` in pixels relative to the top‑left
corner. This does not account for the `Enum.ScreenInsets`; to get the
top‑left and bottom‑right insets, call `Class.GuiService:GetGuiInset()`.

If the location of the mouse pointer is offscreen or the player's device
does not have a mouse, the returned value will be undetermined.
Expand Down