Skip to content

FIX: Avoid making new created assets dirty when opened #1761

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Oct 6, 2023
Merged

FIX: Avoid making new created assets dirty when opened #1761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
276b253
Avoid new created assets to be dirty when opened
jfreire-unity Sep 29, 2023
b0bcfbf
Add methods to check asset for default json layout and being empty
jfreire-unity Oct 4, 2023
0134b98
Improve dirty asset detection when new asset is first created
jfreire-unity Oct 4, 2023
0683ea9
Remove default json layout check method
jfreire-unity Oct 4, 2023
a1ac19f
Update renamed constant
jfreire-unity Oct 4, 2023
ae22e23
Merge branch 'develop' into isx-1591-make-new-empty-assets-not-dirty
jfreire-unity Oct 5, 2023
067d3f1
Merge branch 'develop' into isx-1591-make-new-empty-assets-not-dirty
jfreire-unity Oct 5, 2023
96d0a03
Merge branch 'develop' into isx-1591-make-new-empty-assets-not-dirty
jfreire-unity Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Packages/com.unity.inputsystem/InputSystem/Actions/InputActionAsset.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ public class InputActionAsset : ScriptableObject, IInputActionCollection2
/// InputActionAssets.
/// </remarks>
public const string Extension = "inputactions";
////REVIEW: actually pre-populate with some stuff?
Copy link
Collaborator

@ekcoh ekcoh Oct 4, 2023

Choose a reason for hiding this comment

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

What is the content after a save of an empty asset? Not sure why do not initialise it like that when its created? Then we wouldn't need these checks at all and the equality check would solve that for us

Copy link
Collaborator Author

@jfreire-unity jfreire-unity Oct 4, 2023

Choose a reason for hiding this comment

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

Check #1761 (comment)

internal const string kDefaultAssetLayoutJson = "{}";

/// <summary>
/// True if any action in the asset is currently enabled.
Expand Down Expand Up @@ -872,6 +874,11 @@ internal void MarkAsDirty()
#endif
}

internal bool IsEmpty()
{
return actionMaps.Count == 0 && controlSchemes.Count == 0;
}

internal void OnWantToChangeSetup()
{
if (m_ActionMaps.LengthSafe() > 0)
Expand Down
5 changes: 1 addition & 4 deletions Packages/com.unity.inputsystem/InputSystem/Editor/AssetImporter/InputActionImporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,15 +212,12 @@ public override void OnImportAsset(AssetImportContext ctx)
InputActionEditorWindow.RefreshAllOnAssetReimport();
}

////REVIEW: actually pre-populate with some stuff?
private const string kDefaultAssetLayout = "{}";

// Add item to plop an .inputactions asset into the project.
[MenuItem("Assets/Create/Input Actions")]
public static void CreateInputAsset()
{
ProjectWindowUtil.CreateAssetWithContent("New Controls." + InputActionAsset.Extension,
kDefaultAssetLayout, (Texture2D)EditorGUIUtility.Load(kAssetIcon));
InputActionAsset.kDefaultAssetLayoutJson, (Texture2D)EditorGUIUtility.Load(kAssetIcon));
}
}
}
Expand Down
8 changes: 8 additions & 0 deletions ...ages/com.unity.inputsystem/InputSystem/Editor/UITKAssetEditor/InputActionsEditorWindow.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,14 @@ private void DirtyInputActionsEditorWindow(InputActionsEditorState newState)
private bool HasAssetChanged(SerializedObject serializedAsset)
{
var asset = (InputActionAsset)serializedAsset.targetObject;

// Checks if the asset being edited is a new asset that was never saved before.
// If it is, there's nothing to save.
// At the moment, an asset only has the default asset layout content on disk when it is first created.
// So in this case we cannot go through the normal path and compare what's on disk with what has been serialized.
if (m_AssetJson == InputActionAsset.kDefaultAssetLayoutJson && asset.IsEmpty())
return false;

var newAssetJson = asset.ToJson();
return newAssetJson != m_AssetJson;
}
Expand Down