Version: 2023.1
LanguageEnglish
  • C#

Physics2D.simulationLayers

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

public static LayerMask simulationLayers;

Description

The Rigidbody2D and Collider2D layers to simulate.

By default, All Layers are simulated, however if you specify layers in this property then only the Rigidbody2D on those layers will be simulated. Along with this, only contacts for Collider2D on the specified layer(s) will be handled. Finally, only joints or effectors on the specified layer(s) will be handled.

This property is only used when the Physics2D.SimulationMode is in one of the automatic simulation modes i.e. SimulationMode2D.FixedUpdate or SimulationMode2D.Update. When using SimulationMode2D.Script and calling Physics2D.Simulate, the simulation layers are pass as an argument.

See Also: Physics2D.simulationMode and Physics2D.Simulate.