• Studio

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • API

    Datatypes

    Edit

    LayerMask

    Specifies Layers to use in a Physics.Raycast.

    A GameObject can use up to 32 LayerMasks supported by the Editor. The first 8 of these Layers are specified by Unity; the following 24 are controllable by the user.

    Bitmasks represent the 32 Layers and define them as true or false. Each bitmask describes whether the Layer is used. As an example, bit 5 can be set to 1 (true). This will allow the use of the built-in Water setting.

    Edit->Settings->Tags and Layers option shows the use of the 32 bitmasks. Each Layer is shown with a string setting. As an example Built-in Layer 0 is set as Default; Built-in Layer 1 is set as TransparentFX. New named Layers are added above bitmask layer 8. A selected GameObject will show the chosen Layer at top right of the Inspector. The example below has User Layer 13 set to "Wall". This causes the assigned GameObject to be treated as part of a building.

    In the following script example, Physics.Raycast sends a ray into the world. Camera.main can be rotated around the y-axis and fire a ray. Three GameObjects represent walls that can be hit by the fired ray. Each GameObject has GameObject.label set to the "Wall" layerMask.

    Unity's LayerMask Documentation

    Properties

    Methods

    PocketWorlds Icon

    © 2024 Pocket Worlds. All rights reserved.