PhysicsSettings¶
Lets you view debugging features in Roblox's physics engine, found under the Physics tab in Studio's settings menu.
Description¶
The PhysicsSettings is a singleton class, which lets you view debugging features in Roblox's physics engine. You can find it under the Physics tab in Studio's settings menu.
Inheritance¶
Object → Instance → PhysicsSettings
Nova inheritance: Instance → PhysicsSettings
Properties¶
AllowSleep Supported Property When set to true, physically simulated objects will stop being simulated if they have little to no motion for a set period of time.
When set to true, physically simulated objects will stop being simulated if they have little to no motion for a set period of time.
AreAnchorsShown Supported Property When set to true, parts that are BasePart.Anchored will show a gray surface outline on the surface of the part's bounding box that is currently facin…
When set to true, parts that are BasePart.Anchored will show a gray surface outline on the surface of the part's bounding box that is currently facing the ground.
AreAssembliesShown Supported Property When set to true, each physics assembly is assigned a unique color and the Part associated with the assembly are outlined with the color. Parts that…
When set to true, each physics assembly is assigned a unique color and the Part associated with the assembly are outlined with the color. Parts that are attached together by JointInstance will share the same color.
AreAwakePartsHighlighted Supported Property When set to true, parts that are actively being physically simulated will have a red outline.
When set to true, parts that are actively being physically simulated will have a red outline.
AreBodyTypesShown Supported Property When set to true, Part will be outlined with a specific color, depending on the state of its root simulation body.
When set to true, Part will be outlined with a specific color, depending on the state of its root simulation body.
Body Types¶
| Color | Body Type | Description |
|---|---|---|
| Real-Time Body | Physics Body that is always simulated in real time, and is never throttled. Used for Humanoids. | |
| Free-Fall Body | Physics Body that is freely moving with no physical contact. | |
| Joint Body | Physics Body that is being influenced by a physically simulated joint, such as a Motor or a Hinge. | |
| Contact Body | Physics Body that is in contact with another physics body. | |
| Symmetric Contact Body | Physics Body that is experiencing a torquing force, while in contact with another body. | |
| Vertical Contact Body | Physics Body that is moving very little along the Y plane, while in contact with another body. |
AreContactPointsShown Supported Property When set to true, sphere adorns will be drawn at the contact points of each part where physics interactions are occurring.
When set to true, sphere adorns will be drawn at the contact points of each part where physics interactions are occurring. Each sphere also has an arrow drawn in 3D, facing the surface that the contact point is detecting.
Solver Variations¶
The behavior of this property varies depending on whether Roblox's physics
engine is using the PGS Physics Solver, or the Spring Physics Solver.
This is controlled by the Workspace.PGSPhysicsSolverEnabled property.
Spring Physics Solver¶
When Workspace.PGSPhysicsSolverEnabled is set to false, the contact points are color coded as listed below. The length of the arrow extruding from the sphere depends on how much force the contact point is exerting, and what the contact type is.
| Color | Contact Type | Description |
|---|---|---|
| Normal Contact | Contact point with no special conditions. | |
| Resting Contact | Contact point that has been active for at least 4 frames. | |
| Second Pass Contact | Contact point that was made by a kernel joint going through a second pass. Rarely seen. | |
| Real-Time Contact | Contact point that was made with a real-time physics body. This applies to tripped Class.Humanoid. |
|
| Joint Contact | Contact point that was made under the context of a physically simulated joint. This applies to Motors and Hinges. |
PGS Physics Solver
When Workspace.PGSPhysicsSolverEnabled is set to true, the contact points are always colored RED, and the length of the arrow will always be 1 stud. There are no special conditions tracked, because the PGS solver does not keep specific lookup tables for the states listed in the Spring Solver.
| Color | Contact Type | Description |
|---|---|---|
| Normal Contact | Contact point with no special conditions. |
AreJointCoordinatesShown Supported Property When set to true, XYZ axes are rendered at the BasePart.CFrame of every part.
When set to true, XYZ axes are rendered at the BasePart.CFrame of every part.
AreMechanismsShown Supported Property When set to true, every individual mechanism of parts is given a unique color.
When set to true, every individual mechanism of parts is given a unique color.
AreModelCoordsShown Supported Property 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, but the axis renderi…
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, but the axis rendering component doesn't work correctly.
AreOwnersShown Supported Property 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…
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 Supported Property 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, but the ax…
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, but the axis rendering component doesn't work correctly.
AreRegionsShown Supported Property When set to true, a cylinder is drawn around each player's character, representing their Player.SimulationRadius.
When set to true, a cylinder is drawn around each player's character, representing their Player.SimulationRadius. Each physically simulated object will check to see which player is closest to that object, and if they are within the player's simulation radius. If both conditions are met, that player will becomes the network owner of that object.
AreUnalignedPartsShown Supported Property When set to true, parts that aren't aligned on the 1x1x1 grid will be outlined yellow.
When set to true, parts that aren't aligned on the 1x1x1 grid will be outlined yellow.
AreWorldCoordsShown Supported Property 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 r…
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.
IsReceiveAgeShown Supported Property This property is supposed to show the BasePart.ReceiveAge of a part, but it does not work correctly.
This property is supposed to show the BasePart.ReceiveAge of a part, but it does not work correctly.
IsTreeShown Supported Property When set to true, the joint connections of each part, and the states of their underlying primitive components are visualized as a spanning tree.
When set to true, the joint connections of each part, and the states of their underlying primitive components are visualized as a spanning tree.
Spanning Tree Table¶
There are several visualizations made available when this property is set to true:
| Color | Adorn Type | Description |
|---|---|---|
| Box | Root Primitive of a Mechanism that is currently anchored, or connected to an anchored primitive. See Class.BasePart:IsGrounded(). |
|
| Box | Root Primitive of a Mechanism that is free to be physically simulated. | |
| Box | Root Primitive of a Mechanism that has moving components. | |
| Sphere | Root Primitive of an Assembly. | |
| Line | Connection between two Primitives that share the same Assembly. | |
| Line | Connection between two Primitives. |
ParallelPhysics Supported Property
PhysicsAnalyzerEnabled Supported Property
No description available.
PluginSecurityPhysicsEnvironmentalThrottle Supported Property Controls the throttle rate of Roblox's physics engine.
Controls the throttle rate of Roblox's physics engine. By default, the physics engine will adjust the physics environment throttle depending on how much work the physics engine is doing, and the current framerate. See the enum page for EnviromentalPhysicsThrottle for more information.
ShowDecompositionGeometry Supported Property When set to true, the underlying collision geometry for PartOperation and MeshPart is rendered.
When set to true, the underlying collision geometry for PartOperation and MeshPart is rendered.
ThrottleAdjustTime Supported Property If the PhysicsSettings.PhysicsEnvironmentalThrottle is set to DefaultAuto, this specifies the maximum time that the physics environmental throttle ha…
If the PhysicsSettings.PhysicsEnvironmentalThrottle 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¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
35 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's PhysicsSettings class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AreAssemblyCentersOfMassShown |
AreAssemblyCentersOfMassShown: bool |
Not yet | When set to true, shows the center of mass for each physics assembly. | RobloxScriptSecurity |
AreCollisionCostsShown |
AreCollisionCostsShown: bool |
Not yet | When set to true, displays collision cost annotations for parts. | RobloxScriptSecurity |
AreConstraintForcesShownForSelectedOrHoveredInstances |
AreConstraintForcesShownForSelectedOrHoveredInstances: bool |
Not yet | When set to true, draws force vectors for constraints on selected or hovered instances. | RobloxScriptSecurity |
AreConstraintTorquesShownForSelectedOrHoveredInstances |
AreConstraintTorquesShownForSelectedOrHoveredInstances: bool |
Not yet | When set to true, draws torque vectors for constraints on selected or hovered instances. | RobloxScriptSecurity |
AreContactForcesShownForSelectedOrHoveredAssemblies |
AreContactForcesShownForSelectedOrHoveredAssemblies: bool |
Not yet | When set to true, draws contact force vectors for selected or hovered assemblies. | RobloxScriptSecurity |
AreContactIslandsShown |
AreContactIslandsShown: bool |
Not yet | When set to true, each contact island will render SelectionBox adorns on the parts in contact islands, where each contact island is assigned a random… | PluginSecurity |
AreGravityForcesShownForSelectedOrHoveredAssemblies |
AreGravityForcesShownForSelectedOrHoveredAssemblies: bool |
Not yet | When set to true, draws gravity force vectors for selected or hovered assemblies. | RobloxScriptSecurity |
AreMagnitudesShownForDrawnForcesAndTorques |
AreMagnitudesShownForDrawnForcesAndTorques: bool |
Not yet | When set to true, displays magnitude labels alongside drawn force and torque vectors. | RobloxScriptSecurity |
AreNonAnchorsShown |
AreNonAnchorsShown: bool |
Not yet | When set to true, parts that are not BasePart.Anchored will be highlighted. | PluginSecurity |
AreSolverIslandsShown |
AreSolverIslandsShown: bool |
Not yet | When set to true, each solver island is highlighted with a unique color. | RobloxScriptSecurity |
AreTerrainReplicationRegionsShown |
AreTerrainReplicationRegionsShown: bool |
Not yet | When set to true, shows terrain replication streaming regions. | PluginSecurity |
AreTimestepsShown |
AreTimestepsShown: bool |
Not yet | When set to true, shows physics timestep information for assemblies. | RobloxScriptSecurity |
CollisionGeomDrawOriginalParts |
CollisionGeomDrawOriginalParts: bool |
Not yet | — | RobloxScriptSecurity |
CollisionGeomMatchPartTransparency |
CollisionGeomMatchPartTransparency: bool |
Not yet | — | RobloxScriptSecurity |
CollisionGeomOverlayTransparency |
CollisionGeomOverlayTransparency: float |
Not yet | — | RobloxScriptSecurity |
CollisionGeomShowCollidableParts |
CollisionGeomShowCollidableParts: bool |
Not yet | — | RobloxScriptSecurity |
CollisionGeomShowCollisionGroup |
CollisionGeomShowCollisionGroup: string |
Not yet | — | RobloxScriptSecurity |
CollisionGeomShowQueryableParts |
CollisionGeomShowQueryableParts: bool |
Not yet | — | RobloxScriptSecurity |
CollisionGeomShowTouchableParts |
CollisionGeomShowTouchableParts: bool |
Not yet | — | RobloxScriptSecurity |
DisableCSGv2 |
DisableCSGv2: bool |
Not yet | When set to true, Roblox will fall back to using its legacy CSG solver when performing solid model operations. | PluginSecurity |
DisableCSGv3ForPlugins |
DisableCSGv3ForPlugins: bool |
Not yet | When set to true, disables CSGv3 for plugin solid modeling operations. | PluginSecurity |
DrawConstraintsNetForce |
DrawConstraintsNetForce: bool |
Not yet | When set to true, draws the net force from all constraints on selected or hovered assemblies. | RobloxScriptSecurity |
DrawContactsNetForce |
DrawContactsNetForce: bool |
Not yet | When set to true, draws the net force from all contacts on selected or hovered assemblies. | RobloxScriptSecurity |
DrawTotalNetForce |
DrawTotalNetForce: bool |
Not yet | When set to true, draws the total net force on selected or hovered assemblies. | RobloxScriptSecurity |
EnableForceVisualizationSmoothing |
EnableForceVisualizationSmoothing: bool |
Not yet | When set to true, enables temporal smoothing for force and torque visualizations. | RobloxScriptSecurity |
FluidForceDrawScale |
FluidForceDrawScale: float |
Not yet | Sets the scale of arrows drawn for aerodynamic force visualization. | RobloxScriptSecurity |
ForceDrawScale |
ForceDrawScale: float |
Not yet | Sets the scale of arrows drawn for force visualization. | RobloxScriptSecurity |
ForceVisualizationSmoothingSteps |
ForceVisualizationSmoothingSteps: int |
Not yet | Controls the number of frames used for force visualization smoothing. | RobloxScriptSecurity |
IsInterpolationThrottleShown |
IsInterpolationThrottleShown: bool |
Not yet | When set to true, shows physics interpolation throttle information. | PluginSecurity |
ShowFluidForcesForSelectedOrHoveredMechanisms |
ShowFluidForcesForSelectedOrHoveredMechanisms: bool |
Not yet | When set to true, enables aerodynamic visualization for selected or hovered mechanisms in Studio's play and run modes. | RobloxScriptSecurity |
ShowInstanceNamesForDrawnForcesAndTorques |
ShowInstanceNamesForDrawnForcesAndTorques: bool |
Not yet | When set to true, displays instance names alongside drawn force and torque vectors. | RobloxScriptSecurity |
SolverConvergenceMetricType |
SolverConvergenceMetricType: SolverConvergenceMetricType |
Not yet | Controls which metric is used for solver convergence visualization. | RobloxScriptSecurity |
SolverConvergenceVisualizationMode |
SolverConvergenceVisualizationMode: SolverConvergenceVisualizationMode |
Not yet | Controls the visualization mode for solver convergence. | RobloxScriptSecurity |
TorqueDrawScale |
TorqueDrawScale: float |
Not yet | Sets the scale of arrows drawn for torque visualization. | RobloxScriptSecurity |
UseCSGv2 |
UseCSGv2: bool |
Not yet | If set to true, version 2 of Roblox's CSG solver will be used instead of version 1. | PluginSecurity |
Roblox reference: PhysicsSettings
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.