Skip to content

Document instance labels and update README issue guidance #115

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

Open
mackysoft wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document instance labels and update README issue guidance #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ public class DebugCommand : ICommand {
public void Execute () {
Debug.Log(m_Message);
}

public override string ToString () {
return m_Message;
}
}

[Serializable]
Expand Down Expand Up @@ -139,6 +143,17 @@ public struct StructCommand : ICommand {
}
```

### Customize field labels

Set `UseToStringAsLabel = true` to use the selected instance's `ToString()` result as the field label:

```cs
[SerializeReference, SubclassSelector(UseToStringAsLabel = true)]
ICommand m_Command;
```

For example, `DebugCommand` above returns its message from `ToString()`. The option also applies to individual array and `List<T>` elements. Null references and mixed values in a multi-object selection keep the default field label.

### Copy and paste managed references

Right-click a managed-reference field or an individual collection element and choose **Copy**. The copied snapshot remains available across script reloads during the current Editor session. To preserve unresolved reference data, copying null fields is disabled on objects that contain missing managed-reference types.
Expand Down Expand Up @@ -231,7 +246,7 @@ Also, [this thread](https://forum.unity.com/threads/serializereference-data-loss

# <a id="help-and-contribute" href="#help-and-contribute"> ✉ Help & Contribute </a>

I welcome feature requests and bug reports in [issues](https://github.com/mackysoft/XPool/issues) and [pull requests](https://github.com/mackysoft/XPool/pulls).
I welcome feature requests and bug reports in [issues](https://github.com/mackysoft/Unity-SerializeReferenceExtensions/issues).

If you feel that my works are worthwhile, I would greatly appreciate it if you could sponsor me.

Expand Down