Lets you view debugging features in Roblox's physics engine, found under the Physics tab in Studio's settings menu.
- Memory category
- Instances
- Own members
- 56
- Inherited members
- 75
- Subclasses
- 0
- Siblings
- 608
Properties79
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Defined byPhysicsSettings56
Property categoryDisplay
PhysicsSettings.AreAnchorsShown: boolean When set to true, parts that areBasePart.Anchoredwill 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 thePartassociated with the assembly are outlined with the color. Parts that are attached together byJointInstancewill 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,Partwill 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 renderSelectionBoxadorns 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 theBasePart.CFrameof 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 aModel, but the axis rendering component doesn't work correctly.PhysicsSettings.AreNonAnchorsShown: boolean When set to true, parts that are notBasePart.Anchoredwill 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 eachBasePart, 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 theirPlayer.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.CollisionGeomDrawOriginalParts: boolean PhysicsSettings.CollisionGeomMatchPartTransparency: boolean PhysicsSettings.CollisionGeomOverlayTransparency: number PhysicsSettings.CollisionGeomShowCollidableParts: boolean PhysicsSettings.CollisionGeomShowCollisionGroup: string PhysicsSettings.CollisionGeomShowQueryableParts: boolean PhysicsSettings.CollisionGeomShowTouchableParts: boolean 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.DrawShapecast: boolean 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: number 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: number Sets the scale of arrows drawn for force visualization.PhysicsSettings.ForceVisualizationSmoothingSteps: number 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 theBasePart.ReceiveAgeof 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.ShowDecompositionGeometry: boolean When set to true, the underlying collision geometry forPartOperationandMeshPartis 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: Enum.SolverConvergenceMetricType Controls which metric is used for solver convergence visualization.PhysicsSettings.SolverConvergenceVisualizationMode: Enum.SolverConvergenceVisualizationMode Controls the visualization mode for solver convergence.PhysicsSettings.TorqueDrawScale: number 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.
Property categoryPerformance
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.PhysicsEnvironmentalThrottle: Enum.EnviromentalPhysicsThrottle Controls the throttle rate of Roblox's physics engine.PhysicsSettings.ThrottleAdjustTime: number If thePhysicsSettings.PhysicsEnvironmentalThrottleis set toDefaultAuto, this specifies the maximum time that the physics environmental throttle has to wait before it is allowed to automatically change.
No properties match the filters.
Methods42
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
No methods match the filters.
Events10
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
No events match the filters.