Sprite Swap Overview
Sprite Swap is a feature that enables you to change a GameObject’s rendered Sprite, but keep the same skeleton rig and Animation Clips. This enables you to quickly and easily create multiple characters that look different, but have the same animation rigs. You can also use Sprite Swap to switch the displayed Sprite on each frame at run time, to create frame-by-frame animation.
The workflow for implementing Sprite Swap differs if you are following the workflow integrated with 2D Animation, or if you are manually setting up your Sprites.
Below is the general workflow for implementing Sprite Swapping:
- Create and set up a Sprite Library Asset.
- Attach a Sprite Library component and Sprite Resolver component to the GameObject you want to use Sprite Swapping on. This GameObject must also contain a Sprite Renderer component.
The Sprite Library component contains the reference to a selected Sprite Library Asset, while the Sprite Resolver component is used to request a Sprite registered to that Sprite Library Asset by providing the Category and Label value of the desired Sprite.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.