PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. PhysicsSettings

PhysicsSettings

Show deprecated
Hide content
Content
  1. apireference
  2. physicssettings

PhysicsSettings

Show 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

AreTerrainReplicationRegionsShown

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

ForceCSGv2

[Hidden] [NotReplicated]
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.
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

bool

Archivable

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

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Deprecated]

A deprecated property that used to protect CoreGui objects
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

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

Clone ( )

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

Destroy ( )

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

FindFirstAncestor ( string name )

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

FindFirstAncestorOfClass ( string className )

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

FindFirstAncestorWhichIsA ( string className )

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

FindFirstChild ( string name , bool recursive )

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

FindFirstChildOfClass ( string className )

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

FindFirstChildWhichIsA ( string className , bool recursive )

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

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Attributes are not currently enabled, so this API member may have no effect, emit a warning or raise an error. Do not use it in new work.

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

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

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance's ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

IsA ( string className )

[CustomLuaState]

Returns true if an Instance's class matches or inherits from a given class
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.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
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.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

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

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

[DetectingPropertyChanges]

Fired immediately after a property of an object changes.
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

childAdded ( Instance child )

[Deprecated]
NetworkSettings RenderSettings