NEW: Project-wide Actions by jamesmcgill · Pull Request #1735 · Unity-Technologies/InputSystem

jamesmcgill · 2023-08-22T07:42:49Z

Description

In-built set of Actions which is installed (currently inside InputManager.asset) and is available via InputSystem.actions
New UITK based editor installed in Project Settings provides a UI for editing these Actions

Changes made

New UITK Actions Editor (existing IMGUI editor is still used for normal .inputactions asset files)
New property InputSystem.actions backed by InputManager.asset and EditorBuildSettings for Players

Manual Testing

Testing Document

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.

lyndon-unity

Looks ok overall (some questions in PR), I will check it out and run it too.

Some questions on bindings like we discussed in person. Am following up on those.

Lacks the Documentation .md file addition. Can you add that here too.

lyndon-unity · 2023-08-22T10:04:23Z

+
+            AssetDatabase.AddObjectToAsset(asset, s_AssetPath);
+
+            // Make sure all the elements in the asset have GUIDs and that they are indeed unique.


I'd be tempted to split this out into a support function taking the asset as a parameter.

In part because I think a 'restore defaults' functionality may use this later
https://jira.unity3d.com/browse/ISX-1564

lyndon-unity · 2023-08-22T10:05:33Z

+                }
+            }
+
+            // Create sub-asset for each action. This is so that users can select individual input actions from the asset when they're


Similar to the above chunk of code I think this could be a support function

lyndon-unity · 2023-08-22T10:22:45Z

-            if (InputSystem.settings == null)
-                return;
+            m_OriginalPreloadedAssets = PlayerSettings.GetPreloadedAssets();
+            var preloadedAssets = PlayerSettings.GetPreloadedAssets();


Could do this to avoid calling playersettings function twice as it may have higher cost.

var preloadedAssets = m_OriginalPreloadedAssets;

lyndon-unity · 2023-08-22T10:24:33Z

@@ -1,4 +1,4 @@
-#if UNITY_EDITOR && UNITY_INPUT_SYSTEM_UI_TK_ASSET_EDITOR // We use some UITK controls that are only available in 2022.2 or later (MultiColumnListView for example)
+#if UNITY_EDITOR && UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS


Is it worth keeping the comment?

lyndon-unity · 2023-08-22T10:26:04Z

+                        s_projectWideActions, true);
+                }
+                #else
+                s_projectWideActions = Resources.FindObjectsOfTypeAll<InputActionAsset>().FirstOrDefault();


Is this line valid - could it end up picking up some other input action asset that we don't expect ?

Can the resources areas only contain the pre built one or could a user tuck some in there too ?
Would it be better to iterate over all and match by name.

lyndon-unity · 2023-08-22T10:28:24Z

-            // Hence we ignore adding temporary objects to preloaded assets.
-            if (!EditorUtility.IsPersistent(InputSystem.settings))
+#if UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS
+            EditorBuildSettings.TryGetConfigObject(InputSettingsProvider.kEditorBuildSettingsActionsConfigKey,


Why do we reference config object here. We don't seem to use m_ProjectWideActions for anything

Oh wait InputSystem.actions also pulls from the configobject.
In which case - why don't we just use that reference directly ?

(This might be ok, but it confused me a little, perhaps a little comment here would help if it remains the same)

lyndon-unity · 2023-08-23T16:33:19Z

-
-        public static void SaveAsset(SerializedObject serializedAsset, InputActionsEditorWindow currentWindow = null)
-        {
-            if ((focusedWindow == null || focusedWindow is not InputActionsEditorWindow) && currentWindow == null)


Is it ok this check is removed - I think Joao added this to make sure not used on the Input Asset flow where IMGUI still used. Perhaps its not really needed?

… without any devices attached yet in tests

…her actions

…ation

tidied whitespace in code sample

…de actions API

Next/Previous updated to be more intuative/same axis Names for UI Click* restored to original Added keyboard binding for Attack Added some XR bindings Some reordering too E.g. so crouch/jump next to each other This makes the diff slightly harder

…logies/InputSystem into project-wide-actions-phase1

…auto saving always atm (ISX-1556)

…her actions or controls

…ions are enabled

removed duplicate comment on private member

Pauliusd01

Approving to be mergable to develop. Testing will be continued in develop

jfreire-unity

Approving so we can start testing.

jamesmcgill · 2023-08-29T10:04:14Z

Merging in present state for pre-release testing
Known unrelated issues on trunk and 2023.2 with building player for jobs:

mac_standalone_il2cpp
android il2cpp

jamesmcgill added 5 commits August 21, 2023 17:42

Add InputSystem.actions property

1dfcd48

Add ProjectWideActions Test Sample

428bad8

Rename conditonal compilation flag for project-wide actions

4faa5ce

Merge branch 'develop' into project-wide-actions-phase1

558bd32

Ensure UITK action editor appears in Project Settings

0aa41c6

lyndon-unity reviewed Aug 22, 2023

View reviewed changes

jamesmcgill added 2 commits August 22, 2023 14:52

Fix project settings editor not populating actions

e1919b9

Fix for dupliate editors shown

7c7f918

jfreire-unity mentioned this pull request Aug 23, 2023

FIX: Global Actions UI flickers when user expands actions (ISX-1547) #1738

Merged

4 tasks

FIX: Global Actions UI flickers when user expands actions (#1738)

b17fffd

lyndon-unity reviewed Aug 23, 2023

View reviewed changes

Pauliusd01 self-requested a review August 24, 2023 11:21

jamesmcgill and others added 11 commits August 24, 2023 18:43

Fix for API validation test failure

d8f1d47

Fix ProjectWide Actions Enable/Disable flow for tests

e4731c8

Prevent assertion which may happen if ProjectWide Actions are Enabled…

9861063

… without any devices attached yet in tests

Disable ProjectWide actions in some tests that assume there are no ot…

0b15d94

…her actions

Fixed issue with Input Actions UI becoming blank due to error (ISX-1584)

8b6a4d3

DOCF-3823 - pre release docs

9ecc638

Added stub doc to InputSystem.actions

2c19d07

Added compilation constant to enable global actions during docs gener…

7aca019

…ation

Fixed whitespace typo

3798d37

Update PreReleaseNotes.md

e915142

tidied whitespace in code sample

Updated define for documentation generation to include the project wi…

1294da3

…de actions API

lyndon-unity mentioned this pull request Aug 25, 2023

DOCF-3823 - pre release docs #1733

Closed

lyndon-unity and others added 6 commits August 25, 2023 09:26

Hiding search field while not implemented (ISX-1582)

c8a8535

Fix tests not compiling on older editors

37b5911

Ran formatting script to fix warnings

acd2758

Merge branch 'project-wide-actions-phase1' of github.com:Unity-Techno…

f8704b3

…logies/InputSystem into project-wide-actions-phase1

Hiding save, auto save buttons in project wide input settings as its …

a53c367

…auto saving always atm (ISX-1556)

lyndon-unity and others added 8 commits August 25, 2023 16:34

Fixed delete key mapping to be 'delete' rather than 'space' (ISX-1552)

e93183b

Fix ActionState and StateBuffer going out of sync when entering tests

4a929fc

Disable ProjectWide actions in some tests that assume there are no ot…

8f67506

…her actions or controls

Temporarily disable some tests which have issues when ProjectWide Act…

34196e0

…ions are enabled

fix formatting

3fe972c

Update InputSystem.cs

fce9c6a

removed duplicate comment on private member

Fix broken links

233b651

improve api docs for InputSystem.actions

ab22a19

Pauliusd01 approved these changes Aug 29, 2023

View reviewed changes

jamesmcgill requested a review from jfreire-unity August 29, 2023 08:14

jfreire-unity approved these changes Aug 29, 2023

View reviewed changes

add changelog entry

d359eed

jamesmcgill merged commit a56878c into develop Aug 29, 2023

jamesmcgill deleted the project-wide-actions-phase1 branch August 29, 2023 10:05

jfreire-unity mentioned this pull request Aug 29, 2023

ISX-1551 Make Project-Wide Actions and UITK editor available from 2022.3+ #1729

Closed

4 tasks

jamesmcgill mentioned this pull request Aug 29, 2023

NEW: Project-wide Actions and Device API #1720

Closed

4 tasks

This was referenced Sep 8, 2023

WIP: Global actions. #1507

Closed

Initialize global actions on startup #1634

Closed


		AssetDatabase.AddObjectToAsset(asset, s_AssetPath);

		// Make sure all the elements in the asset have GUIDs and that they are indeed unique.

		@@ -1,4 +1,4 @@
		#if UNITY_EDITOR && UNITY_INPUT_SYSTEM_UI_TK_ASSET_EDITOR // We use some UITK controls that are only available in 2022.2 or later (MultiColumnListView for example)
		#if UNITY_EDITOR && UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS

Conversation

jamesmcgill commented Aug 22, 2023 • edited by Pauliusd01 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes made

Manual Testing

Checklist

Uh oh!

lyndon-unity left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pauliusd01 left a comment

Choose a reason for hiding this comment

Uh oh!

jfreire-unity left a comment

Choose a reason for hiding this comment

Uh oh!

jamesmcgill commented Aug 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jamesmcgill commented Aug 22, 2023 •

edited by Pauliusd01

Loading

lyndon-unity left a comment •

edited

Loading

jamesmcgill commented Aug 29, 2023 •

edited

Loading