com.matuyuhi.animationpro
v1.1.5
Published
This is a UI and other animation system
Downloads
20
Readme
Animation Pro
AnimationPro is a UI and other animation system for Unity. It provides you with a simple API to add smooth animations to your project with ease.
Switch Language
Installation
To install this package via NPM to your Unity project, follow these steps:
Install from a Git URL
You can install the UPM package via directly Git URL. To load a package from a Git URL:
- Open Unity Package Manager window.
- Click the add + button in the status bar.
- The options for adding packages appear.
- Select Add package from git URL from the add menu. A text box and an Add button appear.
- Enter the
https://github.com/Matuyuhi/AnimationPro.git
Git URL in the text box and click Add. - You may also install a specific package version by using the URL with the specified version.
https://github.com/Matuyuhi/AnimationPro.git#X.Y.Z
- Please note that the version
X.Y.Z
stated here is to be replaced with the version you would like to get. - You can find all the available releases here.
- The latest available release version is
For more information about what protocols Unity supports, see Git URLs.
Install from NPM
- Navigate to the
Packages
directory of your project. - Adjust the project manifest file
manifest.json
in a text editor. - Ensure
https://registry.npmjs.org/
is part ofscopedRegistries
.- Ensure
com.matuyuhi
is part ofscopes
. - Add
com.matuyuhi.animationpro
to thedependencies
, stating the latest version.
- Ensure
A minimal example ends up looking like this. Please note that the version X.Y.Z
stated here is to be replaced
with the latest released version, which is
currently .
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"com.matuyuhi"
]
}
],
"dependencies": {
"com.matuyuhi.animationpro": "X.Y.Z"
}
}
- Save and close the manifest.json file.
- Open the Unity editor. The package manager should automatically install the AnimationPro package.
Usage
Component
Simple animations that can be easily used by adding them to components
- In Playing
- In Setting
Animations Document file
Here's a basic example of how to use AnimationPro:
public class SampleAnimation : AnimationBehaviour
{
// onClick method attach button
public void OnClick()
{
Animation(
this.SlideOutHorizontal(AnimationAPI.DirectionHorizontal.Right, Easings.CircIn(0.8f)) +
this.FadeOut(Easings.CircIn(0.5f, 0.2f)),
new AnimationListener()
{
OnFinished = () =>
{
gameObject.SetActive(false);
// imp animation finished callback
}
}
);
}
}
Contributing
We welcome bug reports and feature requests. Please feel free to make a pull request if you believe you can improve the code.
License
This project is licensed under the MIT license. For more information, please see the LICENSE file.
Author
This project was created by Matuyuhi.
Support or Contact Information
If you have any questions, issues, or want to contribute, feel free to open an issue in this repository or contact me directly.
- Project: https://github.com/Matuyuhi/AnimationPro
- Email: [email protected]
- Github: https://github.com/Matuyuhi