API:Class/PhysicsSettings

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Settings: This object has been marked as a settings object. It is used to hold persistent settings, which may be accessible by Roblox Studio's settings menu, or the in-game menu. This object cannot be created.

Configuration icon.pngPhysicsSettings : Object Icon.pngInstance

The PhysicsSettings is a singleton class, which lets you test debugging features with Roblox's physics engine. It can be found under the Physics tab in Roblox Studio's settings menu.

Properties

PropertiesmemberhiddenProperties [toggle]

boolAllowSleep

When true, physically simulated objects that are awake will stop moving if the velocity slows down to a certain point. This is meant to improve performance, and by default is true.

|RMD member="API:Class/PhysicsSettings/AllowSleep"|When true, physically simulated objects that are awake will stop moving if the velocity slows down to a certain point. This is meant to improve performance, and by default is true.|/RMD|
boolAreAnchorsShown

When true, anchored parts will render a gray SurfaceSelection on the face currently facing downward.

|RMD member="API:Class/PhysicsSettings/AreAnchorsShown"|When true, anchored parts will render a gray SurfaceSelection on the face currently facing downward.|/RMD|
boolAreAssembliesShown

When true, individual physically simulated objects will be given a unique outline. Parts that are connected and unanchored will share the same outline color.

|RMD member="API:Class/PhysicsSettings/AreAssembliesShown"|When true, individual physically simulated objects will be given a unique outline. Parts that are connected and unanchored will share the same outline color.|/RMD|
boolAreAwakePartsHighlighted

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

|RMD member="API:Class/PhysicsSettings/AreAwakePartsHighlighted"|When true, parts that are actively being physically simulated will have a red outline.|/RMD|
boolAreBodyTypesShown

When true, Parts will show SelectionBoxes, with specific colors depending on what type of physics simulation it's simulation body is going through.

|RMD member="API:Class/PhysicsSettings/AreBodyTypesShown"|When true, Parts will show SelectionBoxes, with specific colors depending on what type of physics simulation it's simulation body is going through.|/RMD|
boolAreContactPointsShown

When true, small spheres will be drawn at points of contact between active parts. Arrows will also be shown at these points of contact with a certain size, if a small part is struggling to push away a larger part weighing it down.

|RMD member="API:Class/PhysicsSettings/AreContactPointsShown"|When true, small spheres will be drawn at points of contact between active parts. Arrows will also be shown at these points of contact with a certain size, if a small part is struggling to push away a larger part weighing it down.|/RMD|
boolAreJointCoordinatesShown

Renders dark XYZ axes at the C0 and C1 points of JointInstances.

|RMD member="API:Class/PhysicsSettings/AreJointCoordinatesShown"|Renders dark XYZ axes at the C0 and C1 points of JointInstances.|/RMD|
boolAreMechanismsShown

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

|RMD member="API:Class/PhysicsSettings/AreMechanismsShown"|If set to true, every individual mechanism of parts is given a unique color.|/RMD|
boolAreModelCoordsShown

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.

|RMD member="API:Class/PhysicsSettings/AreModelCoordsShown"|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.|/RMD|

boolAreOwnersShown

When true, each player is assigned a unique SelectionBox color, representing their network ownership. If a player has network ownership over a physically simulated object, that object will have a SelectionBox outline with the same color as the player.

|RMD member="API:Class/PhysicsSettings/AreOwnersShown"|When true, each player is assigned a unique SelectionBox color, representing their network ownership. If a player has network ownership over a physically simulated object, that object will have a SelectionBox outline with the same color as the player.|/RMD|
boolArePartCoordsShown

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.

|RMD member="API:Class/PhysicsSettings/ArePartCoordsShown"|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.|/RMD|

boolAreRegionsShown

When true, a brown cylinder is drawn around each player, representing their simulation radius.

|RMD member="API:Class/PhysicsSettings/AreRegionsShown"|When true, a brown cylinder is drawn around each player, representing their simulation radius.|/RMD|
boolAreUnalignedPartsShown

When true, parts that aren't perfectly aligned to a 1x1x1 grid will have a yellow SelectionBox outline.

|RMD member="API:Class/PhysicsSettings/AreUnalignedPartsShown"|When true, parts that aren't perfectly aligned to a 1x1x1 grid will have a yellow SelectionBox outline.|/RMD|
boolAreWorldCoordsShown

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.

|RMD member="API:Class/PhysicsSettings/AreWorldCoordsShown"|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.|/RMD|

boolIsReceiveAgeShown

This property is supposed to show the ReceiveAge of a part, but it does not work correctly.

|RMD member="API:Class/PhysicsSettings/IsReceiveAgeShown"|This property is supposed to show the ReceiveAge of a part, but it does not work correctly.|/RMD|
boolIsTreeShown

When true, shows a tree of joint connections.

|RMD member="API:Class/PhysicsSettings/IsTreeShown"|When true, shows a tree of joint connections.|/RMD|
boolParallelPhysics

Toggles whether physics should be computed in parallel rather than one at a time.

|RMD member="API:Class/PhysicsSettings/ParallelPhysics"|Toggles whether physics should be computed in parallel rather than one at a time.|/RMD|
EnviromentalPhysicsThrottlePhysicsEnvironmentalThrottle

Controls the throttle rate of Roblox's physics engine.

|RMD member="API:Class/PhysicsSettings/PhysicsEnvironmentalThrottle"|Controls the throttle rate of Roblox's physics engine.|/RMD|
boolShowDecompositionGeometry

When true, shows the collision geometry of a solid model.

|RMD member="API:Class/PhysicsSettings/ShowDecompositionGeometry"|When true, shows the collision geometry of a solid model.|/RMD|
doubleThrottleAdjustTime

If the PhysicsEnvironmentalThrottle is set to DefaultAuto, this specifies the maximum time that the physics environmental throttle has to wait before it is allowed to change the operation load of the physics engine.

|RMD member="API:Class/PhysicsSettings/ThrottleAdjustTime"|If the PhysicsEnvironmentalThrottle is set to DefaultAuto, this specifies the maximum time that the physics environmental throttle has to wait before it is allowed to change the operation load of the physics engine.|/RMD|
boolUseCSGv2

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

|RMD member="API:Class/PhysicsSettings/UseCSGv2"|If set to true, version 2 of Roblox's CSG solver will be used instead of version 1.|/RMD|
boolPhysicsAnalyzerEnabled [PluginSecurity] [readonly]

Allows you to read the toggle state of the Physics Analyzer. When the Physics button under Test - Analyze in Roblox Studio is pressed, this property will toggle between true and false.

|RMD member="API:Class/PhysicsSettings/PhysicsAnalyzerEnabled"|Allows you to read the toggle state of the Physics Analyzer. When the Physics button under Test - Analyze in Roblox Studio is pressed, this property will toggle between true and false.|/RMD|
When true, physically simulated objects that are awake will stop moving if the velocity slows down to a certain point. This is meant to improve performance, and by default is true.
When true, anchored parts will render a gray SurfaceSelection on the face currently facing downward.
When true, individual physically simulated objects will be given a unique outline. Parts that are connected and unanchored will share the same outline color.
When true, parts that are actively being physically simulated will have a red outline.
When true, Parts will show SelectionBoxes, with specific colors depending on what type of physics simulation it's simulation body is going through.
When true, small spheres will be drawn at points of contact between active parts. Arrows will also be shown at these points of contact with a certain size, if a small part is struggling to push away a larger part weighing it down.
Renders dark XYZ axes at the C0 and C1 points of JointInstances.
If set to true, every individual mechanism of parts is given a unique color.
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.
When true, each player is assigned a unique SelectionBox color, representing their network ownership. If a player has network ownership over a physically simulated object, that object will have a SelectionBox outline with the same color as the player.
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.
When true, a brown cylinder is drawn around each player, representing their simulation radius.
When true, parts that aren't perfectly aligned to a 1x1x1 grid will have a yellow SelectionBox outline.
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.
This property is supposed to show the ReceiveAge of a part, but it does not work correctly.
When true, shows a tree of joint connections.
Toggles whether physics should be computed in parallel rather than one at a time.
Controls the throttle rate of Roblox's physics engine.
When true, shows the collision geometry of a solid model.
If the PhysicsEnvironmentalThrottle is set to DefaultAuto, this specifies the maximum time that the physics environmental throttle has to wait before it is allowed to change the operation load of the physics engine.
If set to true, version 2 of Roblox's CSG solver will be used instead of version 1.
PhysicsAnalyzerEnabled [PluginSecurity] [readonly]
Allows you to read the toggle state of the Physics Analyzer. When the Physics button under Test - Analyze in Roblox Studio is pressed, this property will toggle between true and false.



|RMD member="API:Class/PhysicsSettings"|The PhysicsSettings is a singleton class, which lets you test debugging features with Roblox's physics engine. It can be found under the Physics tab in Roblox Studio's settings menu. |/RMD|