[HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.animation@7.0/manual/SLAsset.html")]
[MovedFrom("UnityEngine.Experimental.U2D.Animation")]
public class SpriteLibraryAsset : ScriptableObject

Methods

AddCategoryLabel(Sprite, string, string)

Add or replace and existing Sprite into the given Category and Label

Declaration

public void AddCategoryLabel(Sprite sprite, string category, string label)

Parameters

Type	Name	Description
Sprite	sprite	Sprite to add
string	category	Category to add the Sprite to
string	label	Label of the Category to add the Sprite to. If this parameter is null or an empty string, it will attempt to add a empty category

GetCategoryLabelNames(string)

Returns the labels' name for the given name

Declaration

public IEnumerable<string> GetCategoryLabelNames(string category)

Parameters

Type	Name	Description
string	category	Category name

Returns

Type	Description
IEnumerable<string>	A Enumerable string representing labels' name

GetCategoryNames()

Return all the Category names of the Sprite Library Asset that is associated.

Declaration

public IEnumerable<string> GetCategoryNames()

Returns

Type	Description
IEnumerable<string>	A Enumerable string value representing the name

GetCategorylabelNames(string)

(Obsolete) Returns the labels' name for the given name

Declaration

[Obsolete("GetCategorylabelNames has been deprecated. Please use GetCategoryLabelNames (UnityUpgradable) -> GetCategoryLabelNames(*)")]
public IEnumerable<string> GetCategorylabelNames(string category)

Parameters

Type	Name	Description
string	category	Category name

Returns

Type	Description
IEnumerable<string>	A Enumerable string representing labels' name

GetSprite(string, string)

Returns the Sprite registered in the Asset given the Category and Label value

Declaration

public Sprite GetSprite(string category, string label)

Parameters

Type	Name	Description
string	category	Category string value
string	label	Label string value

Returns

Type	Description
Sprite

RemoveCategoryLabel(string, string, bool)

Remove a Label from a given Category

Declaration

public void RemoveCategoryLabel(string category, string label, bool deleteCategory)

Parameters

Type	Name	Description
string	category	Category to remove from
string	label	Label to remove
bool	deleteCategory	Indicate to remove the Category if it is empty