Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

SortingLayer.GetLayerValueFromID

public static int GetLayerValueFromID(int id);

Parameters

id The unique value of the sorting layer as returned by any renderer's sortingLayerID property.

Returns

int The final sorting value of the layer relative to other layers.

Description

Returns the final sorting layer value. To determine the sorting order between the various sorting layers, use this method to retrieve the final sorting value and use CompareTo to determine the order.

public class ExampleClass : MonoBehaviour
{
    int CompareLayer(GameObject rhs, Gameobject lhs)
    {
        int rval = SortingLayer.GetLayerValueFromID(rhs.GetComponent<SpriteRenderer>().sortingLayerID);
        int lval = SortingLayer.GetLayerValueFromID(lhs.GetComponent<SpriteRenderer>().sortingLayerID);
        return rval.CompareTo(lval);
    }
}