Returns a `Datatype.PhysicalProperties` container, with the density, friction, and elasticity specified for this Material.

PhysicalProperties.new

material

Returns a `Datatype.PhysicalProperties` with the default properties for the given material.

Returns a `Datatype.PhysicalProperties` container, with the specified density,
friction, and elasticity.

density

friction

elasticity

Returns a `Datatype.PhysicalProperties` with the specified density, friction, and
elasticity.

Creates a `Datatype.PhysicalProperties` container, with the specified density,
friction, elasticity, weight of friction, and weight of elasticity.

frictionWeight

elasticityWeight

The `Datatype.PhysicalProperties` data type describes several physical
properties of a part: `Density`, `Elasticity`, and `Friction`. It is used in
the similarly-named `Class.BasePart.CustomPhysicalProperties` property.

## Weighting Behavior

`Datatype.PhysicalProperties` also provides weightings properties,
`ElasticityWeight` and `FrictionWeight`. When two parts interact, the
`Friction` and `Elasticity` between them are determined in the same way by the
following pairwise weighted average function:

![(Friction_a * FrictionWeight_a + Friction_b * FrictionWeight_b) / (FrictionWeight_a + FrictionWeight_b)](/assets/legacy/FrictionWeight.png)

Although the formula above refers to the Friction and FrictionWeight of two
parts, `A` and `B`, the formula is used in the same manner when determining
`Elasticity`. Generally, when the weight of `A` is much greater than that of
`B`, the actual value will be closer to `A`. If the weights are similar, then
the actual value will be close to the midpoint between their individual
values.

## History

`Datatype.PhysicalProperties` was released in
[November 2015](https://blog.roblox.com/2015/11/announcing-new-physical-material-properties/).
Previously, `Class.BasePart` had individual `Friction` and `Elasticity`
properties. This was changed so that all physical properties of a part will
replicate as one, among other reasons. Its release was done over the course of
three months.


PhysicalProperties

The density set for the custom physical properties. Density is defined as
the amount of mass per unit volume. The more dense a part is, the more
force it takes to accelerate it.


PhysicalProperties.Density

The friction set for the custom physical properties. Friction is defined
as the force that opposes the relative lateral motion of two solid
surfaces in contact. The greater the friction on a part, the quicker it
will decelerate when it rubs against another part with friction.


PhysicalProperties.Friction

The deceleration of the part when rubbing against another part.


The elasticity set for the custom physical properties. On Roblox,
`Elasticity` refers to a part's tendency to retain energy when colliding
with another part. An `Elasticity` of `1` indicates that the part bounces
with the same energy it had before a collision.


PhysicalProperties.Elasticity

The amount of energy retained when colliding with another part.


The friction weight set for the custom physical properties. The
`FrictionWeight` of two parts rubbing together creates a ratio used to
calculate the actual friction between the two parts: the higher a part's
`FrictionWeight` is, the more its `Friction` is used.


PhysicalProperties.FrictionWeight

The importance of the part's `Friction` property when calculating the
friction with the colliding part.


The elasticity weight set for the custom physical properties. The
`ElasticityWeight` of two parts colliding creates a ratio used to
calculate the actual elasticity between the two parts: the higher a part's
`ElasticityWeight` is, the more its `Elasticity` is used.


PhysicalProperties.ElasticityWeight

The importance of the part's `Elasticity` property when calculating the
elasticity with the colliding part.


Describes properties that affect the physical behavior of a `Class.BasePart`.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

PhysicalProperties

Summary

Constructors

Properties

Constructors

new

Parameters

new

Parameters

new

Parameters

Properties

Density

Friction

Elasticity

FrictionWeight

ElasticityWeight