Skip to content

Entity

Inherits Physical

Entity represents a physics object that's related to building blocks (inherited by Part and Mesh)

Abstract Object

This object exists only to serve as a foundation for other objects. It cannot be accessed directly, but its properties are documented below.

Additionally, it cannot be created in the creator menu or with Instance.New().

Not newable

This object cannot be created by scripts using Instance.New().

Properties

Color : Color

The color of the entity.

CastShadows : boolean

Determines whether the entity casts shadows.

IsSpawn : boolean

Determines whether the part can be used as a spawn location or not.

UseGravity : boolean

Determines whether the entity is affected by gravity.

Mass : number

Determines the mass of the entity.

Friction : number

Determines the friction of the entity.

Drag : number

Determines the drag (air resistance) of the entity.

AngularDrag : number

Determines the angular drag of the entity.

Bounciness : number

Determines the bounciness of the entity.

Methods

AddForce → nil

Parameters

force [ Vector3 ]

mode [ ForceModeEnum? ]

Applies a force to the entity.

AddTorque → nil

Parameters

force [ Vector3 ]

mode [ ForceModeEnum? ]

Applies a rotational force to the entity.

AddForceAtPosition → nil

Parameters

force [ Vector3 ]

position [ Vector3 ]

mode [ ForceModeEnum? ]

Applies a force to the entity from a specific position.

AddRelativeForce → nil

Parameters

force [ Vector3 ]

mode [ ForceModeEnum? ]

Adds a force to the part relative to its own rotation.

AddRelativeTorque → nil

Parameters

torque [ Vector3 ]

mode [ ForceModeEnum? ]

Adds a rotational force to the part relative to its own rotation.