search

CareBoo / Serially

Adds a unity-supported, SerializableType class and an inspector for editing SerializeReference fields.
MIT License
40 stars 0 forks source link

Documentation request: how to use SerializableReference with SerializableType #78

Closed rafaeldolfe closed 1 year ago

rafaeldolfe commented 1 year ago

In a Unity post you show a screenshot of using the reference with a type.

image

I haven't figured out how to do this in my project. Can you show how this is done in more detail?

jasonboukheir commented 1 year ago

Hi, the code for this is found in the documentation: https://careboo.github.io/Serially/2.2/manual/ShowSerializeReference.html

There is no SerializableType in that picture. The ShowSerializeReference and SerializableType share a similar drawer, which is why they look similar 😉.

rafaeldolfe commented 1 year ago

Ah, gotcha.

As a user of this repo, I would personally love for the main parts of the documentation to be available directly in the README. Even better would be to have it showcase the main usages so I don't need to figure out how it can be used. I looked at the docs earlier but thought they might be incomplete not finding anything about the SerializableType interacting with ShowSerializeReference, having thought the Unity forum was hinting at that. Even just copy pasting the docs into the README would be nice. Most repos I've used in the past don't use Github pages.

Hope I don't sound ungrateful - it's a really nice package, thanks for making it available open source.

jasonboukheir commented 1 year ago

good points, I added some basic use cases to the README and updated it with a Table of Contents. Hopefully, it's easy to tell that there is more information available under the Documentation header.