Skip to content

Note

Studio's property groups and the scripting component API are different. A label shown in the Properties panel is not automatically a component name or a Luau field.

RigidBody

RigidBody is a (case-sensitive) built-in component name that stores an Instance's physical material properties. You can use it with game.World.Query, Query:With, Query:Without, game.World.Each, and the Instance component methods.

Script access

While this component can be used as a filter in Queries, it currently does not expose any of its fields to Queries. However, it can be accessed via Instance.Density, Friction, Restitution, LinearDamping, and AngularDamping.

Inspector fields are serialization/editor metadata and are not automatically available as Luau fields. See Components for that distinction and Instances for fixed property types and write scope.

Stored fields

Note

Currently, these fields are not directly available as editable Luau. As such, they are reported as the types they are stored as in the engine itself instead of Luau types.

Field Stored type Notes
friction f32
restitution f32
density f32
linearDamping f32
angularDamping f32