Document Tweens v2 to v3 API update

[hsandt]

Is your feature request related to a problem? Please describe. I'm upgrading from Tweens v2 to v3 and there is almost no documentation about the changes.

I checked the Release page change log and despite the important API compatibility breaking, I don't see any information about how to update code.

I would really like a changelog like SceneReference (https://github.com/starikcetin/Eflatun.SceneReference/releases) which was very easy to follow.

In addition, the latest document doesn't mention what "using namespace" is needed, which was one of the things that changed.

Describe the solution you'd like Describe all the changes in the doc. This is what I found so far:

• install openupm add nl.jeffreylanters.tweens instead of openupm add nl.elraccoone.tweens
• replace using ElRaccoone.Tweens; with using Tweens;
• static method helpers have been removed. You now need to AddTween of a given type (eg new PositionTween instead of .TweenPosition()). This is longer though, I wonder if static helpers have been removed for a strong architectural reason or if they will come back, would make it much easier for me to update my project.
• call gameObject.CancelTweens instead of TweenCancelAll
• generally speaking, extensions apply to GameObject only, not components, so you may need to add .gameObject add different places

Describe alternatives you've considered Explanations could be in a separate doc, but changelog looks like a good place

Additional context I may end up not upgrading to v3 if it's too complicated.

[hsandt]

Also, I noticed that the openupm page for nl.elraccoone.tweens has disappeared, yet the command-line openupm add nl.elraccoone.tweens works to provide 2.1.0. But since the README on tag 2.1.0 still show the old command-line, people will be able to find out how to use it. Maybe there should still be an openupm page for the old version pointing to the new one so devs are not lost though?

[github-actions[bot]]

This issue is stale because it has been open for 30 days with no activity.

[github-actions[bot]]

This issue was closed because it has been inactive for 14 days since being marked as stale.