Class SpriteResolver

Updates a SpriteRenderer's Sprite reference on the Category and Label value it is set.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
SpriteResolver
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindFirstObjectByType(System.Type)
UnityEngine.Object.FindAnyObjectByType(System.Type)
UnityEngine.Object.FindFirstObjectByType(System.Type, UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType(System.Type, UnityEngine.FindObjectsInactive)
Namespace: UnityEngine.U2D.Animation
Syntax
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("2D Animation/Sprite Resolver")]
[Icon("Packages/com.unity.2d.animation/Editor/Assets/ComponentIcons/Animation.SpriteResolver.png")]
[DefaultExecutionOrder(-2)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.animation@latest/index.html?subfolder=/manual/SLAsset.html%23sprite-resolver-component")]
[MovedFrom("UnityEngine.Experimental.U2D.Animation")]
public class SpriteResolver : MonoBehaviour, ISerializationCallbackReceiver, IPreviewable

Properties

spriteLibrary

Property to get the SpriteLibrary the SpriteResolver is resolving from.

Declaration
public SpriteLibrary spriteLibrary { get; }
Property Value
Type Description
SpriteLibrary

Methods

GetCategory()

Get the Category set for the SpriteResolver.

Declaration
public string GetCategory()
Returns
Type Description
String

The Category's name.

GetLabel()

Get the Label set for the SpriteResolver.

Declaration
public string GetLabel()
Returns
Type Description
String

The Label's name.

OnPreviewUpdate()

Empty method. Implemented for the IPreviewable interface.

Declaration
public void OnPreviewUpdate()

ResolveSpriteToSpriteRenderer()

Set the Sprite in SpriteResolver to the SpriteRenderer component that is in the same GameObject.

Declaration
public bool ResolveSpriteToSpriteRenderer()
Returns
Type Description
Boolean

True if it successfully resolved the Sprite.

SetCategoryAndLabel(String, String)

Set the Category and label to use.

Declaration
public bool SetCategoryAndLabel(string category, string label)
Parameters
Type Name Description
String category

Category to use.
String label

Label to use.
Returns
Type Description
Boolean

True if the Category and Label were successfully set.

Explicit Interface Implementations

ISerializationCallbackReceiver.OnAfterDeserialize()

Called after object is deserialized.

Declaration
void ISerializationCallbackReceiver.OnAfterDeserialize()
Implements

ISerializationCallbackReceiver.OnBeforeSerialize()

Called before object is serialized.

Declaration
void ISerializationCallbackReceiver.OnBeforeSerialize()
Implements