-
Notifications
You must be signed in to change notification settings - Fork 322
DOCS: How to use processors #2171
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
base: develop
Are you sure you want to change the base?
Conversation
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.
I did my first pass on the PR. Please fix the note formatting and replace the placeholder image alt text with something more descriptive. Also, there are quite a few sentences written in passive voice—please rewrite them in active voice where appropriate. You can refer to the Unity style guide for reference: https://docs-style-guide.unity.com/style/use-active-voice.
Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
…sors.md Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
…sors.md Co-authored-by: lilisha-unity <[email protected]>
…sors.md Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Co-authored-by: lilisha-unity <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅ @@ Coverage Diff @@
## develop #2171 +/- ##
===========================================
- Coverage 67.81% 67.78% -0.03%
===========================================
Files 367 367
Lines 53513 53513
===========================================
- Hits 36288 36276 -12
- Misses 17225 17237 +12
Flags with carried forward coverage won't be shown. Click here to find out more. see 3 files with indirect coverage changes 🚀 New features to boost your workflow:
|
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.
Finished my review with some suggestions.
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Co-authored-by: lilisha-unity <[email protected]>
…es/InputSystem into docs-processors
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.
Looks good to me, added some minor comments
Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
|
||
#### Example: Racing game speend control | ||
|
||
In a case where the player is not supposed to fall below a certain base speed, but also cannot exceed a certain maximum speed, the Clamp Processor is the one you may want to use. |
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.
Generally, IMO this to be game-logic and not input logic, but its fine as-is to show as example.
Looks like there is some CI issues that needs attention |
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.
Thanks, an important improvement for our docs!
I added some minor suggestions.
Mostly nitpicks around using "Processors" and "processors". I probably didn't catch them all, but it would be good to always use the same.
Packages/com.unity.inputsystem/Documentation~/ActionBindings.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
"invert,normalize(min=0,max=10)" | ||
``` | ||
|
||
## Choose the right Processor |
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.
Great section 👏
Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md
Outdated
Show resolved
Hide resolved
The [Scale Processor](ProcessorTypes.md#scale) multiplies the input value by a given factor X. This applies to float values as well as vectors, where each axis is multiplied by the corresponding factor specified for that axis. | ||
This allows you to assign weight to input values, which can, for example, make a particular type of control easier to use. | ||
|
||
#### Example: Horizontally aligned Camera |
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.
I don't think it makes sense to add now but I feel it can be mentioned. This example would be a great shout out to another package users might not be aware of, such as Cinemachine!
Co-authored-by: João Freire <[email protected]>
Co-authored-by: João Freire <[email protected]>
Co-authored-by: João Freire <[email protected]>
Co-authored-by: João Freire <[email protected]>
Co-authored-by: João Freire <[email protected]>
Description
This adds more documentation on how to use processors.
Testing status & QA
No testing
Overall Product Risks
Comments to reviewers
Checklist
Before review:
Changed
,Fixed
,Added
sections.Area_CanDoX
,Area_CanDoX_EvenIfYIsTheCase
,Area_WhenIDoX_AndYHappens_ThisIsTheResult
.During merge:
NEW: ___
.FIX: ___
.DOCS: ___
.CHANGE: ___
.RELEASE: 1.1.0-preview.3
.After merge: