Skip to content

Commit

Permalink
Update content/en-us/reference/engine/classes/InputObject.yaml
Browse files Browse the repository at this point in the history
Co-authored-by: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com>
  • Loading branch information
lack-of-gravity-jack and IgnisRBX committed Jul 4, 2024
1 parent 365f826 commit da5498b
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions content/en-us/reference/engine/classes/InputObject.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1920,14 +1920,17 @@ properties:
For `Enum.KeyCode` input, this indicates the position of the player's
`Class.Mouse`.
Note that an InputObject corresponding to MouseButton1 (left click) and
MouseButton2 (right click) supplied from an InputBegan callback will
not have its Position or Delta updated once created, except for when
the mouse input ends. In order to get updated positions for mouse inputs,
you must instead reference an InputObject from an InputChanged callback,
or call GetMouseLocation().
However, any InputObjects corresponding to touch inputs will have its
Delta and Position updated every frame throughout its lifetime.
Note that an `Class.InputObject` corresponding to `Enum.UserInputType.MouseButton1`
(left click) and `Enum.UserInputType.MouseButton2` (right click) supplied from an
`Class.UserInputService.InputBegan|InputBegan` callback will not have its
`Class.InputObject.Delta|Delta` or Class.InputObject.Position|Position` updated once
created, except for when the mouse input ends. In order to get updated positions for
mouse inputs, you must instead reference an `Class.InputObject` from an
`Class.UserInputService.InputChanged|InputChanged` callback, or call
`Class.UserInputService:GetMouseLocation()|GetMouseLocation()`.
However, any `Class.InputObject|InputObjects` corresponding to touch inputs will
have their delta and position updated every frame throughout their lifetime.
See also
Expand Down

0 comments on commit da5498b

Please sign in to comment.