Class SpriteLibraryAsset
A custom Asset that stores Sprites grouping
Namespace: UnityEngine.Experimental.U2D.Animation
Syntax
public class SpriteLibraryAsset : ScriptableObjectMethods
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 |
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 |
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 |
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, Boolean)
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 |
| Boolean | deleteCategory | Indicate to remove the Category if it is empty |