-
Notifications
You must be signed in to change notification settings - Fork 120
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.
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
CMCL-0000: Add user manual page for SimplePlayerController sample code #1004
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #1004 +/- ##
=======================================
Coverage 27.16% 27.16%
=======================================
Files 250 250
Lines 27958 27958
=======================================
Hits 7596 7596
Misses 20362 20362 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- A few corrections and suggestions in manual, API docs, and tooltips.
- Requirement: please add an entry to the new file in the TableOfContents.md – I'd say as the last child of the samples-tutorials.md page.
com.unity.cinemachine/Samples~/Shared Assets/Scripts/SimplePlayerController.cs
Outdated
Show resolved
Hide resolved
com.unity.cinemachine/Samples~/Shared Assets/Scripts/SimplePlayerController2D.cs
Outdated
Show resolved
Hide resolved
com.unity.cinemachine/Samples~/Shared Assets/Scripts/SimplePlayerController2D.cs
Outdated
Show resolved
Hide resolved
com.unity.cinemachine/Samples~/Shared Assets/Scripts/SimplePlayerOnSurface.cs
Outdated
Show resolved
Hide resolved
com.unity.cinemachine/Samples~/Shared Assets/Scripts/SimplePlayerShoot.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Sébastien Duverne <[email protected]>
Co-authored-by: Sébastien Duverne <[email protected]>
All issues resolved |
Purpose of this PR
The Cinemachine Samples have received some attention from the field. People like them, and they like the Simple Character Controller code that ships with them.
There is a feeling that CM's controller is easier to use and to customize than Unity's Standard Assets. We want to promote the usage of CM sample code, and for this reason it is interesting to add some user-facing documentation.
This PR is a first pass at that.