# PhysicsSettings

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Not replicated, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/PhysicsSettings/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings

Lets you view debugging features in Roblox's physics engine, found under the Physics tab in Studio's settings menu.

## Properties

### AreAnchorsShown

```luau
PhysicsSettings.AreAnchorsShown: boolean
```

- Tags: Plugin security

When set to true, parts that are [`BasePart.Anchored`](https://rapi.sleaze.dev/classes/BasePart.md) will show a gray surface outline on the surface of the part's bounding box that is currently facing the ground.

### AreAssembliesShown

```luau
PhysicsSettings.AreAssembliesShown: boolean
```

- Tags: Plugin security

When set to true, each physics assembly is assigned a unique color and the [`Part`](https://rapi.sleaze.dev/classes/Part.md) associated with the assembly are outlined with the color. Parts that are attached together by [`JointInstance`](https://rapi.sleaze.dev/classes/JointInstance.md) will share the same color.

### AreAssemblyCentersOfMassShown

```luau
PhysicsSettings.AreAssemblyCentersOfMassShown: boolean
```

- Tags: Roblox script security

When set to true, shows the center of mass for each physics assembly.

### AreAwakePartsHighlighted

```luau
PhysicsSettings.AreAwakePartsHighlighted: boolean
```

- Tags: Plugin security

When set to true, parts that are actively being physically simulated will have a red outline.

### AreBodyTypesShown

```luau
PhysicsSettings.AreBodyTypesShown: boolean
```

- Tags: Plugin security

When set to true, [`Part`](https://rapi.sleaze.dev/classes/Part.md) will be outlined with a specific color, depending on the state of its root simulation body.

### AreCollisionCostsShown

```luau
PhysicsSettings.AreCollisionCostsShown: boolean
```

- Tags: Roblox script security

When set to true, displays collision cost annotations for parts.

### AreConstraintForcesShownForSelectedOrHoveredInstances

```luau
PhysicsSettings.AreConstraintForcesShownForSelectedOrHoveredInstances: boolean
```

- Tags: Roblox script security

When set to true, draws force vectors for constraints on selected or hovered instances.

### AreConstraintTorquesShownForSelectedOrHoveredInstances

```luau
PhysicsSettings.AreConstraintTorquesShownForSelectedOrHoveredInstances: boolean
```

- Tags: Roblox script security

When set to true, draws torque vectors for constraints on selected or hovered instances.

### AreContactForcesShownForSelectedOrHoveredAssemblies

```luau
PhysicsSettings.AreContactForcesShownForSelectedOrHoveredAssemblies: boolean
```

- Tags: Roblox script security

When set to true, draws contact force vectors for selected or hovered assemblies.

### AreContactIslandsShown

```luau
PhysicsSettings.AreContactIslandsShown: boolean
```

- Tags: Plugin security

When set to true, each contact island will render [`SelectionBox`](https://rapi.sleaze.dev/classes/SelectionBox.md) adorns on the parts in contact islands, where each contact island is assigned a random color.

### AreContactPointsShown

```luau
PhysicsSettings.AreContactPointsShown: boolean
```

- Tags: Plugin security

When set to true, sphere adorns will be drawn at the contact points of each part where physics interactions are occurring.

### AreGravityForcesShownForSelectedOrHoveredAssemblies

```luau
PhysicsSettings.AreGravityForcesShownForSelectedOrHoveredAssemblies: boolean
```

- Tags: Roblox script security

When set to true, draws gravity force vectors for selected or hovered assemblies.

### AreJointCoordinatesShown

```luau
PhysicsSettings.AreJointCoordinatesShown: boolean
```

- Tags: Plugin security

When set to true, XYZ axes are rendered at the [`BasePart.CFrame`](https://rapi.sleaze.dev/classes/BasePart.md) of every part.

### AreMagnitudesShownForDrawnForcesAndTorques

```luau
PhysicsSettings.AreMagnitudesShownForDrawnForcesAndTorques: boolean
```

- Tags: Roblox script security

When set to true, displays magnitude labels alongside drawn force and torque vectors.

### AreMechanismsShown

```luau
PhysicsSettings.AreMechanismsShown: boolean
```

- Tags: Plugin security

When set to true, every individual mechanism of parts is given a unique color.

### AreModelCoordsShown

```luau
PhysicsSettings.AreModelCoordsShown: boolean
```

- Tags: Plugin security

An ancient property that hasn't work correctly since late 2007. It's supposed to render an XYZ axis on the root part of a [`Model`](https://rapi.sleaze.dev/classes/Model.md), but the axis rendering component doesn't work correctly.

### AreNonAnchorsShown

```luau
PhysicsSettings.AreNonAnchorsShown: boolean
```

- Tags: Plugin security

When set to true, parts that are not [`BasePart.Anchored`](https://rapi.sleaze.dev/classes/BasePart.md) will be highlighted.

### AreOwnersShown

```luau
PhysicsSettings.AreOwnersShown: boolean
```

- Tags: Plugin security

When set to true, each player's character is outlined with a unique color, and each part that the player has network ownership over is outlined with the same color.

### ArePartCoordsShown

```luau
PhysicsSettings.ArePartCoordsShown: boolean
```

- Tags: Plugin security

An ancient property that hasn't worked correctly since late 2007. It's supposed to render a large XYZ axis in the center of each [`BasePart`](https://rapi.sleaze.dev/classes/BasePart.md), but the axis rendering component doesn't work correctly.

### AreRegionsShown

```luau
PhysicsSettings.AreRegionsShown: boolean
```

- Tags: Plugin security

When set to true, a cylinder is drawn around each player's character, representing their [`Player.SimulationRadius`](https://rapi.sleaze.dev/classes/Player.md).

### AreSolverIslandsShown

```luau
PhysicsSettings.AreSolverIslandsShown: boolean
```

- Tags: Roblox script security

When set to true, each solver island is highlighted with a unique color.

### AreTerrainReplicationRegionsShown

```luau
PhysicsSettings.AreTerrainReplicationRegionsShown: boolean
```

- Tags: Plugin security

When set to true, shows terrain replication streaming regions.

### AreTimestepsShown

```luau
PhysicsSettings.AreTimestepsShown: boolean
```

- Tags: Roblox script security

When set to true, shows physics timestep information for assemblies.

### AreUnalignedPartsShown

```luau
PhysicsSettings.AreUnalignedPartsShown: boolean
```

- Tags: Plugin security

When set to true, parts that aren't aligned on the 1x1x1 grid will be outlined yellow.

### AreWorldCoordsShown

```luau
PhysicsSettings.AreWorldCoordsShown: boolean
```

- Tags: Plugin security

An ancient property that hasn't worked correctly since late 2007. It's supposed to render a large XYZ axis in the center of the world, but the axis rendering component doesn't work correctly.

### CollisionGeomDrawOriginalParts

```luau
PhysicsSettings.CollisionGeomDrawOriginalParts: boolean
```

- Tags: Roblox script security

### CollisionGeomMatchPartTransparency

```luau
PhysicsSettings.CollisionGeomMatchPartTransparency: boolean
```

- Tags: Roblox script security

### CollisionGeomOverlayTransparency

```luau
PhysicsSettings.CollisionGeomOverlayTransparency: number
```

- Tags: Roblox script security

### CollisionGeomShowCollidableParts

```luau
PhysicsSettings.CollisionGeomShowCollidableParts: boolean
```

- Tags: Roblox script security

### CollisionGeomShowCollisionGroup

```luau
PhysicsSettings.CollisionGeomShowCollisionGroup: string
```

- Tags: Roblox script security

### CollisionGeomShowQueryableParts

```luau
PhysicsSettings.CollisionGeomShowQueryableParts: boolean
```

- Tags: Roblox script security

### CollisionGeomShowTouchableParts

```luau
PhysicsSettings.CollisionGeomShowTouchableParts: boolean
```

- Tags: Roblox script security

### DisableCSGv2

```luau
PhysicsSettings.DisableCSGv2: boolean
```

- Tags: Plugin security

When set to true, Roblox will fall back to using its legacy CSG solver when performing solid model operations.

### DisableCSGv3ForPlugins

```luau
PhysicsSettings.DisableCSGv3ForPlugins: boolean
```

- Tags: Plugin security

When set to true, disables CSGv3 for plugin solid modeling operations.

### DrawConstraintsNetForce

```luau
PhysicsSettings.DrawConstraintsNetForce: boolean
```

- Tags: Roblox script security

When set to true, draws the net force from all constraints on selected or hovered assemblies.

### DrawContactsNetForce

```luau
PhysicsSettings.DrawContactsNetForce: boolean
```

- Tags: Roblox script security

When set to true, draws the net force from all contacts on selected or hovered assemblies.

### DrawShapecast

```luau
PhysicsSettings.DrawShapecast: boolean
```

- Tags: Plugin security

### DrawTotalNetForce

```luau
PhysicsSettings.DrawTotalNetForce: boolean
```

- Tags: Roblox script security

When set to true, draws the total net force on selected or hovered assemblies.

### EnableForceVisualizationSmoothing

```luau
PhysicsSettings.EnableForceVisualizationSmoothing: boolean
```

- Tags: Roblox script security

When set to true, enables temporal smoothing for force and torque visualizations.

### FluidForceDrawScale

```luau
PhysicsSettings.FluidForceDrawScale: number
```

- Tags: Roblox script security

Sets the scale of arrows drawn for aerodynamic force visualization.

### ForceCSGv2

```luau
PhysicsSettings.ForceCSGv2: boolean
```

- Tags: Hidden, Not replicated, Plugin security

When set to true, forces the use of CSGv2 for solid modeling operations.

### ForceDrawScale

```luau
PhysicsSettings.ForceDrawScale: number
```

- Tags: Roblox script security

Sets the scale of arrows drawn for force visualization.

### ForceVisualizationSmoothingSteps

```luau
PhysicsSettings.ForceVisualizationSmoothingSteps: number
```

- Tags: Roblox script security

Controls the number of frames used for force visualization smoothing.

### IsInterpolationThrottleShown

```luau
PhysicsSettings.IsInterpolationThrottleShown: boolean
```

- Tags: Plugin security

When set to true, shows physics interpolation throttle information.

### IsReceiveAgeShown

```luau
PhysicsSettings.IsReceiveAgeShown: boolean
```

- Tags: Plugin security

This property is supposed to show the [`BasePart.ReceiveAge`](https://rapi.sleaze.dev/classes/BasePart.md) of a part, but it does not work correctly.

### IsTreeShown

```luau
PhysicsSettings.IsTreeShown: boolean
```

- Tags: Plugin security

When set to true, the joint connections of each part, and the states of their underlying primitive components are visualized as a spanning tree.

### ShowDecompositionGeometry

```luau
PhysicsSettings.ShowDecompositionGeometry: boolean
```

- Tags: Plugin security

When set to true, the underlying collision geometry for [`PartOperation`](https://rapi.sleaze.dev/classes/PartOperation.md) and [`MeshPart`](https://rapi.sleaze.dev/classes/MeshPart.md) is rendered.

### ShowFluidForcesForSelectedOrHoveredMechanisms

```luau
PhysicsSettings.ShowFluidForcesForSelectedOrHoveredMechanisms: boolean
```

- Tags: Roblox script security

When set to true, enables aerodynamic visualization for selected or hovered mechanisms in Studio's play and run modes.

### ShowInstanceNamesForDrawnForcesAndTorques

```luau
PhysicsSettings.ShowInstanceNamesForDrawnForcesAndTorques: boolean
```

- Tags: Roblox script security

When set to true, displays instance names alongside drawn force and torque vectors.

### SolverConvergenceMetricType

```luau
PhysicsSettings.SolverConvergenceMetricType: Enum.SolverConvergenceMetricType
```

- Tags: Roblox script security

Controls which metric is used for solver convergence visualization.

### SolverConvergenceVisualizationMode

```luau
PhysicsSettings.SolverConvergenceVisualizationMode: Enum.SolverConvergenceVisualizationMode
```

- Tags: Roblox script security

Controls the visualization mode for solver convergence.

### TorqueDrawScale

```luau
PhysicsSettings.TorqueDrawScale: number
```

- Tags: Roblox script security

Sets the scale of arrows drawn for torque visualization.

### UseCSGv2

```luau
PhysicsSettings.UseCSGv2: boolean
```

- Tags: Plugin security

If set to true, version 2 of Roblox's CSG solver will be used instead of version 1.

### AllowSleep

```luau
PhysicsSettings.AllowSleep: boolean
```

- Tags: Plugin security

When set to true, physically simulated objects will stop being simulated if they have little to no motion for a set period of time.

### PhysicsEnvironmentalThrottle

```luau
PhysicsSettings.PhysicsEnvironmentalThrottle: Enum.EnviromentalPhysicsThrottle
```

- Tags: Plugin security

Controls the throttle rate of Roblox's physics engine.

### ThrottleAdjustTime

```luau
PhysicsSettings.ThrottleAdjustTime: number
```

- Tags: Plugin security

If the [`PhysicsSettings.PhysicsEnvironmentalThrottle`](https://rapi.sleaze.dev/classes/PhysicsSettings.md) is set to `DefaultAuto`, this specifies the maximum time that the physics environmental throttle has to wait before it is allowed to automatically change.

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`