GetLayerOrdinal(string)
Get a layer ordinal (index) for the specified layer name. This is not a 32-bit mask but simply the layer ordinal (index) associated with the specified layer name.
Read time 1 minuteLast updated 3 days ago
Definition
- Type: Method
- Namespace: Unity.U2D.Physics
- Assembly: UnityEngine.PhysicsCore2DModule
public static int GetLayerOrdinal(string layerName)
Parameters
The layer name (case sensitive) to find the layer ordinal for.
Returns
Type | Description |
|---|---|
| int | The layer ordinal associated with the specified layer name or, if not found, PhysicsLayers.InvalidLayerOrdinal will be returned in which case a console warning will also be produced. |
Remarks
When physics layers are active and more than one layer has the same name, only the lowest-numbered layer with that name is found, so the ordinal of any other layer with that name is never returned.