| name | unity-physicscore2d-layers-api |
| description | Authoritative Unity 6000.5 PhysicsCore2D API reference for Layers & Masks. Lists every type, property, field, method (with signatures, params, returns) for: PhysicsLayers, PhysicsMask. Use whenever working with these types in code. |
Unity PhysicsCore2D API — Layers & Masks
This skill is the auto-generated API surface for the listed types. It pre-dates Claude's training data on Unity 6000.5, so it should be treated as the source of truth for member names, signatures, and documentation strings.
Generated from Unity 6000.5.0b9 UnityEngine.PhysicsCore2DModule.xml.
Top-level types in this file: PhysicsLayers, PhysicsMask.
PhysicsLayers
This provides a common method to retrieving layer information. If a asset is assigned then the full layers ( ) will be used if is also active. If no asset is assigned then the global layers (See ) will be used.
Full name: Unity.U2D.Physics.PhysicsLayers
Docs: Unity.U2D.Physics.PhysicsLayers
Fields
| Name | Summary |
|---|
InvalidLayerOrdinal | Indicates an invalid layer ordinal. This is typically used when retrieving a layer ordinal but a name could not be found. |
Methods
GetBitNamesAndMasks(Collections.Generic.List{System.String}, Collections.Generic.List{System.UInt64})
GetLayerMask(string[])
Get a for the specified layer name(s).
Params:
layerNames — The layer names (case sensitive) to find a combined physics mask for.
Returns: The combined physics mask associated with the specified layer names or, if not found, will be returned in which case a console warning will also be produced.
GetLayerName(int)
Get a layer name for the specified layer ordinal (index).
Params:
layerOrdinal — The layer ordinal (index). When using the full layers this should be within the range [0, 63] however if not then the range must be [0, 31].
Returns: The layer name. If no layer name is present then is returned.
GetLayerNamesAndMasks(Collections.Generic.List{System.String}, Collections.Generic.List{System.UInt64})
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.
Params:
layerName — The layer name (case sensitive) to find the layer ordinal for.
Returns: The layer ordinal associated with the specified layer name or, if not found, will be returned in which case a console warning will also be produced.
Nested Types
LayerNames
Full name: Unity.U2D.Physics.PhysicsLayers.LayerNames
Properties
| Name | Summary |
|---|
DefaultLayerNames | — |
Methods
GetLayerMask(string)
GetLayerName(int)
GetLayerOrdinal(string)
OnAfterDeserialize()
OnBeforeSerialize()
PhysicsMask
A 64-bit mask, effectively 64 flags. The default enumerator will iterate all the bits that are set (1).
Full name: Unity.U2D.Physics.PhysicsMask
Docs: Unity.U2D.Physics.PhysicsMask
Fields
| Name | Summary |
|---|
All | All 64 bits set (1) in the PhysicsMask. |
bitMask | A 64-bit mask, effectively 64 flags. |
None | No bits set in the PhysicsMask, effectively zero. |
One | Bit #0 set (1) in the PhysicsMask. The remaining bits are reset (0). |
Properties
| Name | Summary |
|---|
resetBits | Gets an enumerable group of bits that are currently reset (0). The bits are returned in ascending bit-index order. This uses . |
setBits | Gets an enumerable group of bits that are currently set (1). The bits are returned in ascending bit-index order. This uses . |
Methods
new(int[])
Create a PhysicsMask by specifying multiple bits to set (1).
Params:
bitIndicies — The indices of the bits to set in the mask. An index must be in the range [0, 63].
new(LayerMask)
Create a PhysicsMask from a LayerMask. A is only 32-bits wide so the PhysicsMask will have the upper 32-bits set to zero.
Params:
layerMask — The LayerMask to use.
AreAnyBitsSet(PhysicsMask)
Checks if any of the provided PhysicsMask set bits are also set in this PhysicsMask.
Params:
physicsMask — The PhysicsMask bits to compare to this PhysicsMask. If this is zero, false will always be returned.
Returns: True if any set bits in the specified PhysicsMask are also set in this PhysicsMask, false otherwise.
AreBitsSet(PhysicsMask)
Checks if all the provided PhysicsMask set bits are also set in this PhysicsMask.
Params:
physicsMask — The PhysicsMask bits to compare to this PhysicsMask. If this is zero, false will always be returned.
Returns: True if all bits in the specified PhysicsMask are also set in this PhysicsMask, false otherwise.
GetEnumerator()
IsBitSet(int)
Is the specified bit set.
Params:
bitIndex — The bit index in the range [0, 63].
Returns: Whether the specified bit is set or not.
operator &(PhysicsMask, PhysicsMask)
Bitwise AND operator for PhysicsMask.
Params:
bitMaskA — The first PhysicsMask to perform the operation with.bitMaskB — The second PhysicsMask to perform the operation with.
Returns: The bit-wise operation using both BitMasks.
operator |(PhysicsMask, PhysicsMask)
Bitwise OR operator for PhysicsMask.
Params:
bitMaskA — The first PhysicsMask to perform the operation with.bitMaskB — The second PhysicsMask to perform the operation with.
Returns: The bit-wise operation using both BitMasks.
operator ^(PhysicsMask, PhysicsMask)
Bitwise XOR operator for PhysicsMask.
Params:
bitMaskA — The first PhysicsMask to perform the operation with.bitMaskB — The second PhysicsMask to perform the operation with.
Returns: The bit-wise operation using both BitMasks.
operator implicit()
operator implicit()
operator <<(PhysicsMask, int)
Bitwise LEFT-SHIFT operator for PhysicsMask.
Params:
bitMask — The PhysicsMask to perform the operation with.bitShift — The number of bits to shift the bitmask.
Returns: The bit-wise operation using both BitMasks.
operator ~(PhysicsMask)
Bitwise COMPLEMENT operator for PhysicsMask.
Params:
bitMask — The PhysicsMask to perform the operation with.
Returns: The bit-wise operation using both BitMasks.
operator >>(PhysicsMask, int)
Bitwise RIGHT-SHIFT operator for PhysicsMask.
Params:
bitMask — The PhysicsMask to perform the operation with.bitShift — The number of bits to shift the bitmask.
Returns: The bit-wise operation using both BitMasks.
ResetBit(int)
Reset (0) the specified bit.
Params:
bitIndex — The bit index in the range [0, 63].
SetBit(int)
Set (1) the specified bit.
Params:
bitIndex — The bit index in the range [0, 63].
System#Collections#IEnumerable#GetEnumerator()
ToLayerMask()
Convert the lower 32-bits of the 64-bit mask to the 32-bit . A is only 32-bits wide so the upper 32-bits of the PhysicsMask will be ignored.
Returns: A 32-bit layer-mask converted from the lower 32-bits of the 64-bit mask.
ToString()
Nested Types
- ResetBitIterator — An iterator that will iterate only the bits that are reset (0) in a
- SetBitIterator — An iterator that will iterate only the bits that are set (1) in a
- ShowAsPhysicsMaskAttribute — When applied to a field/property of type , the field/property drawer will not be display it as . Instead, the field/property will be displayed as bit numbers only i.e. a raw 64-bit mask allowing each bit to be (de)selected. This is only used when physics layers are active (see ).
ResetBitIterator
An iterator that will iterate only the bits that are reset (0) in a
Full name: Unity.U2D.Physics.PhysicsMask.ResetBitIterator
Properties
| Name | Summary |
|---|
System#Collections#Generic#IEnumerator{System#Int32}#Current | — |
System#Collections#IEnumerator#Current | — |
Methods
new(PhysicsMask)
GetEnumerator()
System#Collections#IEnumerable#GetEnumerator()
System#Collections#IEnumerator#MoveNext()
System#Collections#IEnumerator#Reset()
System#IDisposable#Dispose()
SetBitIterator
An iterator that will iterate only the bits that are set (1) in a
Full name: Unity.U2D.Physics.PhysicsMask.SetBitIterator
Properties
| Name | Summary |
|---|
System#Collections#Generic#IEnumerator{System#Int32}#Current | — |
System#Collections#IEnumerator#Current | — |
Methods
new(PhysicsMask)
GetEnumerator()
System#Collections#IEnumerable#GetEnumerator()
System#Collections#IEnumerator#MoveNext()
System#Collections#IEnumerator#Reset()
System#IDisposable#Dispose()
ShowAsPhysicsMaskAttribute
When applied to a field/property of type , the field/property drawer will not be display it as . Instead, the field/property will be displayed as bit numbers only i.e. a raw 64-bit mask allowing each bit to be (de)selected. This is only used when physics layers are active (see ).
Full name: Unity.U2D.Physics.PhysicsMask.ShowAsPhysicsMaskAttribute
Methods
new()
Generated by ~/.claude/physicscore2d-api-generator/_generate.py from Unity 6000.5.0b9 UnityEngine.PhysicsCore2DModule.xml. Do not hand-edit; re-run the generator.
