Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

SpriteAtlasManager

class in UnityEngine.U2D

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Manages SpriteAtlas during runtime.

A Sprite can be loaded without referencing any Sprite Atlas, thus having no texture. It will be invisible until the user registers an atlas to the Sprite by listening to the SpriteAtlasManager.atlasRequested callback. When triggered, it will pass in the atlas tag and a System.Action which will take in an atlas object.

Events

atlasRegisteredTrigger when a SpriteAtlas is registered via invoking the callback in SpriteAtlasManager.atlasRequested.
atlasRequestedTrigger when any Sprite was bound to SpriteAtlas but couldn't locate the atlas asset during runtime.

Delegates

RequestAtlasCallbackDelegate type for atlas request callback.