We use cookies on this site to enhance your user experience
Collapse Sidebar

PhysicsSettings

Deprecated

PhysicsSettings

Deprecated

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


Properties

bool

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.

bool

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.

bool

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.

bool

AreAwakePartsHighlighted

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

bool

AreBodyTypesShown

When set to true, Part will be outlined with a specific color, depending on the state of its root simulation body.

bool

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.

bool

AreContactPointsShown

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

bool

AreJointCoordinatesShown

When set to true, XYZ axes are rendered at the BasePart/CFrame of every part.

bool

AreMechanismsShown

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

bool

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.

bool

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.

bool

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.

bool

AreRegionsShown

When set to true, a cylinder is drawn around each Player's character, representing their Player/SimulationRadius.

bool

AreUnalignedPartsShown

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

bool

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.

bool

DisableCSGv2

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

bool

IsReceiveAgeShown

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

bool

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.

bool

PhysicsAnalyzerEnabled

[ReadOnly] [NotReplicated]

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.

EnviromentalPhysicsThrottle

PhysicsEnvironmentalThrottle

Controls the throttle rate of Roblox’s physics engine.

bool

ShowDecompositionGeometry

When set to true, the underlying collision geometry for PartOperation and MeshPart is rendered.

double

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.

bool

UseCSGv2

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

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
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.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.