Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
PhysicsSettings
Inherits from: Instance → Object
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.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, Service, NotReplicated
Properties
| Name | Type / Returns | Description |
|---|---|---|
| PhysicsSettings.AllowSleep | boolean | When set to true, physically simulated objects will stop being simulated if they have little to no motion for a set period of time. |
| PhysicsSettings.AreAnchorsShown | boolean | 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. |
| PhysicsSettings.AreAssembliesShown | boolean | 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. |
| PhysicsSettings.AreAssemblyCentersOfMassShown | boolean | When set to true, shows the center of mass for each physics assembly. |
| PhysicsSettings.AreAwakePartsHighlighted | boolean | When set to true, parts that are actively being physically simulated will have a red outline. |
| PhysicsSettings.AreBodyTypesShown | boolean | When set to true, Part will be outlined with a specific color, depending on the state of its root simulation body. |
| PhysicsSettings.AreCollisionCostsShown | boolean | When set to true, displays collision cost annotations for parts. |
| PhysicsSettings.AreConstraintForcesShownForSelectedOrHoveredInstances | boolean | When set to true, draws force vectors for constraints on selected or hovered instances. |
| PhysicsSettings.AreConstraintTorquesShownForSelectedOrHoveredInstances | boolean | When set to true, draws torque vectors for constraints on selected or hovered instances. |
| PhysicsSettings.AreContactForcesShownForSelectedOrHoveredAssemblies | boolean | When set to true, draws contact force vectors for selected or hovered assemblies. |
| PhysicsSettings.AreContactIslandsShown | boolean | 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 color. |
| PhysicsSettings.AreContactPointsShown | boolean | When set to true, sphere adorns will be drawn at the contact points of each part where physics interactions are occurring. |
| PhysicsSettings.AreGravityForcesShownForSelectedOrHoveredAssemblies | boolean | When set to true, draws gravity force vectors for selected or hovered assemblies. |
| PhysicsSettings.AreJointCoordinatesShown | boolean | When set to true, XYZ axes are rendered at the BasePart.CFrame of every part. |
| PhysicsSettings.AreMagnitudesShownForDrawnForcesAndTorques | boolean | When set to true, displays magnitude labels alongside drawn force and torque vectors. |
| PhysicsSettings.AreMechanismsShown | boolean | When set to true, every individual mechanism of parts is given a unique color. |
| PhysicsSettings.AreModelCoordsShown | boolean | 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. |
| PhysicsSettings.AreNonAnchorsShown | boolean | When set to true, parts that are not BasePart.Anchored will be highlighted. |
| PhysicsSettings.AreOwnersShown | boolean | 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. |
| PhysicsSettings.ArePartCoordsShown | boolean | 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. |
| PhysicsSettings.AreRegionsShown | boolean | When set to true, a cylinder is drawn around each player's character, representing their Player.SimulationRadius. |
| PhysicsSettings.AreSolverIslandsShown | boolean | When set to true, each solver island is highlighted with a unique color. |
| PhysicsSettings.AreTerrainReplicationRegionsShown | boolean | When set to true, shows terrain replication streaming regions. |
| PhysicsSettings.AreTimestepsShown | boolean | When set to true, shows physics timestep information for assemblies. |
| PhysicsSettings.AreUnalignedPartsShown | boolean | When set to true, parts that aren't aligned on the 1x1x1 grid will be outlined yellow. |
| PhysicsSettings.AreWorldCoordsShown | boolean | 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. |
| PhysicsSettings.DisableCSGv2 | boolean | When set to true, Roblox will fall back to using its legacy CSG solver when performing solid model operations. |
| PhysicsSettings.DisableCSGv3ForPlugins | boolean | When set to true, disables CSGv3 for plugin solid modeling operations. |
| PhysicsSettings.DrawConstraintsNetForce | boolean | When set to true, draws the net force from all constraints on selected or hovered assemblies. |
| PhysicsSettings.DrawContactsNetForce | boolean | When set to true, draws the net force from all contacts on selected or hovered assemblies. |
| PhysicsSettings.DrawTotalNetForce | boolean | When set to true, draws the total net force on selected or hovered assemblies. |
| PhysicsSettings.EnableForceVisualizationSmoothing | boolean | When set to true, enables temporal smoothing for force and torque visualizations. |
| PhysicsSettings.FluidForceDrawScale | float | Sets the scale of arrows drawn for aerodynamic force visualization. |
| PhysicsSettings.ForceCSGv2 | boolean | When set to true, forces the use of CSGv2 for solid modeling operations. |
| PhysicsSettings.ForceDrawScale | float | Sets the scale of arrows drawn for force visualization. |
| PhysicsSettings.ForceVisualizationSmoothingSteps | int | Controls the number of frames used for force visualization smoothing. |
| PhysicsSettings.IsInterpolationThrottleShown | boolean | When set to true, shows physics interpolation throttle information. |
| PhysicsSettings.IsReceiveAgeShown | boolean | This property is supposed to show the BasePart.ReceiveAge of a part, but it does not work correctly. |
| PhysicsSettings.IsTreeShown | boolean | When set to true, the joint connections of each part, and the states of their underlying primitive components are visualized as a spanning tree. |
| PhysicsSettings.PhysicsEnvironmentalThrottle | EnviromentalPhysicsThrottle | Controls the throttle rate of Roblox's physics engine. |
| PhysicsSettings.ShowDecompositionGeometry | boolean | When set to true, the underlying collision geometry for PartOperation and MeshPart is rendered. |
| PhysicsSettings.ShowFluidForcesForSelectedOrHoveredMechanisms | boolean | When set to true, enables aerodynamic visualization for selected or hovered mechanisms in Studio's play and run modes. |
| PhysicsSettings.ShowInstanceNamesForDrawnForcesAndTorques | boolean | When set to true, displays instance names alongside drawn force and torque vectors. |
| PhysicsSettings.SolverConvergenceMetricType | SolverConvergenceMetricType | Controls which metric is used for solver convergence visualization. |
| PhysicsSettings.SolverConvergenceVisualizationMode | SolverConvergenceVisualizationMode | Controls the visualization mode for solver convergence. |
| PhysicsSettings.ThrottleAdjustTime | double | 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. |
| PhysicsSettings.TorqueDrawScale | float | Sets the scale of arrows drawn for torque visualization. |
| PhysicsSettings.UseCSGv2 | boolean | If set to true, version 2 of Roblox's CSG solver will be used instead of version 1. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
PhysicsSettings.AllowSleep
When set to true, physically simulated objects will stop being simulated if they have little to no motion for a set period of time.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Performance |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreAnchorsShown
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.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreAssembliesShown
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.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreAssemblyCentersOfMassShown
When set to true, shows the center of mass for each physics assembly. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreAwakePartsHighlighted
When set to true, parts that are actively being physically simulated will have a red outline.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreBodyTypesShown
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. |
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreCollisionCostsShown
When set to true, displays collision cost annotations for parts. This property is not scriptable.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreConstraintForcesShownForSelectedOrHoveredInstances
When set to true, draws force vectors for constraints on selected or hovered instances. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreConstraintTorquesShownForSelectedOrHoveredInstances
When set to true, draws torque vectors for constraints on selected or hovered instances. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreContactForcesShownForSelectedOrHoveredAssemblies
When set to true, draws contact force vectors for selected or hovered assemblies. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreContactIslandsShown
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 color.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreContactPointsShown
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. |
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. |
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreGravityForcesShownForSelectedOrHoveredAssemblies
When set to true, draws gravity force vectors for selected or hovered assemblies. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreJointCoordinatesShown
When set to true, XYZ axes are rendered at the BasePart.CFrame of every part.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreMagnitudesShownForDrawnForcesAndTorques
When set to true, displays magnitude labels alongside drawn force and torque vectors. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreMechanismsShown
When set to true, every individual mechanism of parts is given a unique color.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
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.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreNonAnchorsShown
When set to true, parts that are not BasePart.Anchored will be highlighted. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreOwnersShown
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.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
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.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreRegionsShown
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.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreSolverIslandsShown
When set to true, each solver island is highlighted with a unique color. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreTerrainReplicationRegionsShown
When set to true, shows terrain replication streaming regions. This property is not scriptable.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreTimestepsShown
When set to true, shows physics timestep information for assemblies. This property is not scriptable.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.AreUnalignedPartsShown
When set to true, parts that aren't aligned on the 1x1x1 grid will be outlined yellow.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
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.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.DisableCSGv2
When set to true, Roblox will fall back to using its legacy CSG solver when performing solid model operations.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.DisableCSGv3ForPlugins
When set to true, disables CSGv3 for plugin solid modeling operations. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.DrawConstraintsNetForce
When set to true, draws the net force from all constraints on selected or hovered assemblies. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.DrawContactsNetForce
When set to true, draws the net force from all contacts on selected or hovered assemblies. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.DrawTotalNetForce
When set to true, draws the total net force on selected or hovered assemblies. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.EnableForceVisualizationSmoothing
When set to true, enables temporal smoothing for force and torque visualizations. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.FluidForceDrawScale
Sets the scale of arrows drawn for aerodynamic force visualization. The default value is 1.0; smaller values draw smaller arrows and vice versa. The default value is a good starting point for a wide range of aerodynamic mechanisms.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.ForceCSGv2
When set to true, forces the use of CSGv2 for solid modeling operations. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| tags | ["Hidden","NotReplicated"] |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.ForceDrawScale
Sets the scale of arrows drawn for force visualization. This property is not scriptable.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.ForceVisualizationSmoothingSteps
Controls the number of frames used for force visualization smoothing. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | int |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.IsInterpolationThrottleShown
When set to true, shows physics interpolation throttle information. This property is not scriptable.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.IsReceiveAgeShown
This property is supposed to show the BasePart.ReceiveAge of a part, but it does not work correctly.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.IsTreeShown
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. |
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.PhysicsEnvironmentalThrottle
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.
| Field | Value |
|---|---|
| type | EnviromentalPhysicsThrottle |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Performance |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.ShowDecompositionGeometry
When set to true, the underlying collision geometry for PartOperation and MeshPart is rendered.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.ShowFluidForcesForSelectedOrHoveredMechanisms
When set to true, enables aerodynamic visualization for selected or hovered mechanisms in Studio's play and run modes. This visualization shows aerodynamic force, torque, and center of pressure for the hovered or selected mechanisms.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.ShowInstanceNamesForDrawnForcesAndTorques
When set to true, displays instance names alongside drawn force and torque vectors. This property must be set in the Physics tab of Studio's settings menu.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.SolverConvergenceMetricType
Controls which metric is used for solver convergence visualization. This property is not scriptable.
| Field | Value |
|---|---|
| type | SolverConvergenceMetricType |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.SolverConvergenceVisualizationMode
Controls the visualization mode for solver convergence. This property is not scriptable.
| Field | Value |
|---|---|
| type | SolverConvergenceVisualizationMode |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.ThrottleAdjustTime
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.
| Field | Value |
|---|---|
| type | double |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Performance |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.TorqueDrawScale
Sets the scale of arrows drawn for torque visualization. This property is not scriptable.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
PhysicsSettings.UseCSGv2
If set to true, version 2 of Roblox's CSG solver will be used instead of version 1.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"PluginSecurity","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
Methods
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |