Unity-Technologies / Unity-Technologies/UnityDataTools

Analyze command - track "SerializeReference" usage

Open
#53 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
821
Forks
71
Avg merge
3h 13m
Merged PRs (30d)
9

Description

The SerializeReference feature of Unity Serialization means that additional C# classes can be serialized directly inside MonoBehaviours and ScriptableObjects. They do not use MonoScripts to managed the C# type - instead the C# type info is serialized directly into the serialized reference registry of the MonoBehaviour. So the information about what types are actually used is spread all over the place in the built content.

Management of these objects can be a challenge, often we have to do text searching of the YAML format in the project assets to find them. In binary data its quite hard to "find" them without actually loading the content.

One example for wanting to find them is if you want to rename a class and need to confirm that the old name is not present anywhere in your assetbundles.

This feature idea is to add another table similar to the recently introduced mono_script table.

When we enumerate MonoBehaviour objects when we discover a SerializeReference instance we will add a row to the new table that has the assembly name, namespace and class, the riid, and the id of the MonoBehaviour. Ideally we would also capture the size of the serialized data for that object.

This code will automatically code ScriptableObjects because they are represented as MonoBehaviours in serialized data.

This implementation should be somewhat similar to how references are captured and recorded in the refs table, so it should be possible to implement in UnityDataTools without introducing any new concepts or complexity.

  • As part of this task also introduce one or more views that shows information from the new table, similar to the new script_object_view.
    E.g. a view that shows all SerializeReference objects with

monobehaviour object id, name, assetbundle/serialized fie, riid, size, Class, NameSpace, Assembly Name

  • Also update documentation to talk about the new table / view and use case for using it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Analyze command and inspect the existing mono_script table, refs table, and script_object_view implementations. Define the new SerializeReference table and one or more views around the requested MonoBehaviour object, asset, riid, size, class, namespace, and assembly fields, then update the documentation with the table, view, and class-renaming use case.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, unity
Domain
data, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.