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.

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

DOCS: ISXB-621 input system UI input module enables referenced UI action map #1944

Conversation

smnwttbr
Copy link
Collaborator

@smnwttbr smnwttbr commented May 31, 2024

Description

Addresses confusion when default action map is enabled, and the UI action map is also enabled via the InputSystemUIInputModule. ISXB-621

Changes made

Documentaiion added to UISupport.md

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • FogBugz ticket attached, example ([case %number%](https://issuetracker.unity3d.com/issues/...)).
    • FogBugz is marked as "Resolved" with next release version correctly set.
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

@smnwttbr smnwttbr requested review from ekcoh and duckets May 31, 2024 02:01
@smnwttbr smnwttbr changed the title DOC: ISXB-621 input system UI input module enables referenced UI action map DOCS: ISXB-621 input system UI input module enables referenced UI action map May 31, 2024
Copy link
Collaborator

@ekcoh ekcoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR is all good, but I wonder if this is the expected behavior. Did you compare to behavior with Input System prior to introduction of Project wide Input actions and UI for Input? If not I would recommend this is not a regression relating to the auto-enable functionality of Project-wide input actions.

@simonwittber
Copy link

I have not tested myself, however comments in the Jira ticket indicated this was not a regression.

I believe this should be expected behaviour, IMO it makes sense based on how the InputSystemUIInputModule works and it's us-case.

@smnwttbr smnwttbr force-pushed the isxb-621-doc-InputSystemUIInputModule-enables-referenced-action-maps branch from 9bb1ca9 to 074559b Compare June 6, 2024 01:31
@smnwttbr smnwttbr force-pushed the isxb-621-doc-InputSystemUIInputModule-enables-referenced-action-maps branch from 074559b to 5ffae8a Compare June 6, 2024 01:34
clarified doc text about UI Input Module component
Copy link
Collaborator

@duckets duckets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved with minor amendment

Packages/com.unity.inputsystem/Documentation~/UISupport.md Outdated Show resolved Hide resolved
@ekcoh ekcoh requested review from stefanunity and Pauliusd01 and removed request for stefanunity June 25, 2024 20:48
@ekcoh
Copy link
Collaborator

ekcoh commented Jun 25, 2024

Adding @Pauliusd01 for QA assessment w.r.t. above mentioned auto-enabling

@Pauliusd01

This comment was marked as off-topic.

@Pauliusd01
Copy link
Collaborator

Pauliusd01 commented Jun 26, 2024

I played around a bit more to see what is loaded in and when

For UITK UI it goes like this:

No PWA asset and UI Module exists/doesn't exist - DefaultInputActions is loaded and used
PWA asset and UI Module doesn't exist - only PWA is loaded and used
PWA asset and UI Module exists - PWA and DefaultInputActions loaded in, but DefaultInputActions are used

For IMGUI UI the UI Module has to exist at all times for the UI to work and the PWA asset does not affect it in anyway yet it is loaded in. So I guess the new wording is correct yet the whole thing is a bit confusing still to me, mostly the reasoning behind PWA UI map being loaded in even when not needed

@Pauliusd01 Pauliusd01 merged commit 01326cb into develop Jul 1, 2024
77 of 79 checks passed
@Pauliusd01 Pauliusd01 deleted the isxb-621-doc-InputSystemUIInputModule-enables-referenced-action-maps branch July 1, 2024 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants