DOCS: Update documentation for MonoBehaviour OnMouse events (ISX-2383) #2301
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
🤖 Helpful? Please react with 👍/👎 | Questions❓Please reach out in Slack #ask-u-pr-agent |
PR Code Suggestions ✨No code suggestions found for the PR. |
Codecov ReportAll modified and coverable lines are covered by tests ✅ @@ Coverage Diff @@
## develop #2301 +/- ##
===========================================
- Coverage 77.95% 77.94% -0.01%
===========================================
Files 477 476 -1
Lines 97419 97436 +17
===========================================
+ Hits 75943 75948 +5
- Misses 21476 21488 +12 Flags with carried forward coverage won't be shown. Click here to find out more. see 7 files with indirect coverage changes 🚀 New features to boost your workflow:
|
| ## Features Supported by Old Input Manager | ||
|
|
||
| * `MonoBehaviour` mouse methods (`OnMouseEnter`, `OnMouseDrag`, etc) will not be called by the Input System. |
There was a problem hiding this comment.
IMO this line should be kept with a mention that it is true up to 6.4
|
|
||
| ### Mouse | ||
|
|
||
| The MonoBehaviour.OnMouse events such as [MonoBehaviour.OnMouseDown()](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnMouseDown.html) are supported using the Unity Editor 6.4 or newer. |
There was a problem hiding this comment.
Slight, very subjective, rewording suggestion:
The MonoBehaviour.OnMouse events (for example, MonoBehaviour.OnMouseDown()) are only supported in Unity Editor 6.4 and later.
Or
The MonoBehaviour.OnMouse events (for example, MonoBehaviour.OnMouseDown()) are supported in Unity Editor 6.4 and later.
Also, not sure if calling them methods or events is better here
Pauliusd01
left a comment
Pauliusd01
left a comment
There was a problem hiding this comment.
Left subjective comments but would be fine if It's unchanged
Co-authored-by: JonMUnity <98557365+JonMUnity@users.noreply.github.com>
Co-authored-by: JonMUnity <98557365+JonMUnity@users.noreply.github.com>
Description
This PR updates documentation around the MonoBehaviour.OnMouse events. Now that the events are supported by the InputSystem package this should be visible in the documentation. I added a new hint to this in the migration page and removed the remark of "it not being supported" in the Known Limitations section.
Ticket: ISX-2383
Testing status & QA
No testing
Overall Product Risks
Comments to reviewers
Please check wording, and if you think the place of mentioning the OnMouse events is appropiate.
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.