https://github.com/pereviader/manualreserialization

Reserialization tools for the Unity3d engine. Refactor the scripts in your project quicker.
https://github.com/pereviader/manualreserialization

developer-tool developer-tools tool tools unity3d unity3d-plugin

Last synced: 5 months ago
JSON representation

Reserialization tools for the Unity3d engine. Refactor the scripts in your project quicker.

• Host: GitHub
• URL: https://github.com/pereviader/manualreserialization
• Owner: PereViader
• License: mit
• Created: 2022-04-08T09:32:41.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-28T22:47:55.000Z (about 1 year ago)
• Last Synced: 2025-06-06T23:11:27.748Z (about 1 year ago)
• Topics: developer-tool, developer-tools, tool, tools, unity3d, unity3d-plugin
• Language: C#
• Homepage:
• Size: 87.9 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![Publish Release](https://github.com/PereViader/ManualReserialization/actions/workflows/PublishRelease.yml/badge.svg)](https://github.com/PereViader/ManualReserialization/actions/workflows/PublishRelease.yml) ![Unity version 2021.3](https://img.shields.io/badge/Unity-2021.3-57b9d3.svg?style=flat&logo=unity) [![openupm](https://img.shields.io/npm/v/com.pereviader.manualreserialization?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.pereviader.manualreserialization/) [![openupm](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fcom.pereviader.manualreserialization)](https://openupm.com/packages/com.pereviader.manualreserialization/)

# ManualReserialization

This library allows you to programatically update the all assets in your project when the structure of your serialized fields change.

Regardless of where those assets are found within your asset database* the reserialization will be applied to them allowing you to programatically update the shape of your objects.

*`SerializeReference` is not compatible but could be implemented

```csharp

public class SomeClass : MonoBehaviour

{

    [Obsolete] public int someField;

    public bool newField;

    [MenuItem("Tools/Reserialize the class")] //You can add a menu item to be able to run this snippet of code from the UnityEditor

    public static void Reserialize()

    {

        Reserializer.Reserialize((x, metadata) => x.newField = x.someField == 1);

    }

}

```

The metadata provided can be inspected to see if the instance of the type comes from either a prefab, scriptable object or a scene

When implementing the delegate, make sure that it is [idempotent](https://en.wikipedia.org/wiki/Idempotence). This is necessary because if the reserialization is applied to a root prefab and also to prefab variants, it should only produce overrides when actually necessary.

This is an example of non idempotent implementation

```csharp

//Before running

//RootPrefab: someField == 1

//PrefabVariant: without override thus value == 1

Reserializer.Reserialize((x, metadata) => x.someField++);

//After running

//RootPrefab: someField == 2

//PrefabVariant override with someField == 3

```

The variant ends up with an override of value 3 because the delegate will run after the original prefab has had the delegate run on it. Thus the root prefab is updated from 1 to 2 and then the variant is updated from 2 to 3.