com.unity.perception icon indicating copy to clipboard operation
com.unity.perception copied to clipboard

Upgrade Guide for new release of perception package

Open enickel00 opened this issue 2 years ago • 1 comments

Hello,

First off, thanks for releasing the new perception package. Looking forward to 2022.2 support.

When upgrading existing packages to the new version I noticed that most of my scripts broke because of differences in parameter names in the new release. I think I have most of my stuff working now, but it took some searching and I'm wondering if it's worthwhile putting these changes into a 'Upgrade Guide' and also modifying parts of the FAQ which are out of date.

Scripting changes I noticed:

  • ColorRgbCategoricalParameter is now ColorRgbParameter
  • MaterialParameter is now CategoricalParameter<Material>
  • GameObjectParameter is now CategoricalParameter<GameObject>

I also noticed that the 'Randomization' section of the FAQ still shows the old method of using 'GameObjectParameter' which doesn't seem to work in the new release. I understand that this is still pretty new software, so likely no rush on this, but at some point it'd be good to update these things. I'm also posting this in hopes of guiding others like myself searching for ways to make old code work with the new release. If any of the changes I've posted above are incorrect please let me know.

Thanks again,

enickel00 avatar Jan 03 '23 17:01 enickel00

Thank you for the recommendations, and I agree with your comments. We will try to update our documentation.

StevenBorkman avatar Jan 27 '23 20:01 StevenBorkman