Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

PhysicsLayers.GetLayerMask

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static LowLevelPhysics2D.PhysicsMask GetLayerMask(params string[] layerNames);

Parameters

Parameter Description
layerNames The layer names (case sensitive) to find a combined physics mask for.

Returns

PhysicsMask The combined physics mask associated with the specified layer names or, if not found, PhysicsMask.None will be returned in which case a console warning will also be produced.

Description

Get a PhysicsMask for the specified layer name(s).