Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BasePart

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is not browsable. It is not visible in Studio's object browser.
Tags: [NotCreatable, NotBrowsable]

Member index 117

HistoryMember
553Anchored: bool
553AssemblyAngularVelocity: Vector3
553AssemblyCenterOfMass: Vector3
553AssemblyLinearVelocity: Vector3
553AssemblyMass: float
553AssemblyRootPart: BasePart
553BackSurface: SurfaceType
553BottomSurface: SurfaceType
553BrickColor: BrickColor
553CFrame: CFrame
553CanCollide: bool
553CanQuery: bool
553CanTouch: bool
553CastShadow: bool
553CenterOfMass: Vector3
553CollisionGroup: string
574CollisionGroupId: int
553Color: Color3
553CurrentPhysicalProperties: PhysicalProperties
553CustomPhysicalProperties: PhysicalProperties
581EnableFluidForces: bool
553ExtentsCFrame: CFrame
553ExtentsSize: Vector3
553FrontSurface: SurfaceType
553LeftSurface: SurfaceType
553Locked: bool
553Mass: float
553Massless: bool
553Material: Material
553MaterialVariant: string
553PivotOffset: CFrame
553Reflectance: float
553ResizeIncrement: int
553ResizeableFaces: Faces
553RightSurface: SurfaceType
553RootPriority: int
553Rotation: Vector3
553Size: Vector3
553SpecificGravity: float
553TopSurface: SurfaceType
553Transparency: float
553brickColor: BrickColor
603AngularAccelerationToTorque(angAcceleration: Vector3, angVelocity: Vector3 = 0, 0, 0): Vector3
573ApplyAngularImpulse(impulse: Vector3): null
573ApplyImpulse(impulse: Vector3): null
573ApplyImpulseAtPosition(impulse: Vector3, position: Vector3): null
573BreakJoints(): null
557CanCollideWith(part: BasePart): bool
462CanSetNetworkOwnership(): Tuple
576GetClosestPointOnSurface(position: Vector3): Vector3
486GetConnectedParts(recursive: bool = false): Objects
486GetJoints(): Objects
486GetMass(): float
567GetNetworkOwner(): Instance
567GetNetworkOwnershipAuto(): bool
583GetNoCollisionConstraints(): Objects
462GetRenderCFrame(): CFrame
486GetRootPart(): Instance
462GetTouchingParts(): Objects
557GetVelocityAtPosition(position: Vector3): Vector3
564IntersectAsync(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
486IsGrounded(): bool
573MakeJoints(): null
462Resize(normalId: NormalId, deltaAmount: int): bool
573SetNetworkOwner(playerInstance: Player = Player): null
573SetNetworkOwnershipAuto(): null
462SubtractAsync(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
603TorqueToAngularAcceleration(torque: Vector3, angVelocity: Vector3 = 0, 0, 0): Vector3
462UnionAsync(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
573breakJoints(): null
462getMass(): float
573makeJoints(): null
553resize(normalId: NormalId, deltaAmount: int): bool
483LocalSimulationTouched(part: BasePart)
462OutfitChanged()
553StoppedTouching(otherPart: BasePart)
483TouchEnded(otherPart: BasePart)
483Touched(otherPart: BasePart)
inherited from PVInstance
553Origin: CFrame
553Pivot Offset: CFrame
576GetPivot(): CFrame
573PivotTo(targetCFrame: CFrame): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 14

HistoryMember
452BodyAngularVelocity: Vector3
452BodyCenterOfMass: Vector3
452BodyLinearVelocity: Vector3
452BodyMass: float
452LinearVelocity: Vector3
352Negate(): Instance
352Separate(): Objects
352UnionWith(part: Instance): Instance
588subtractAsync2_INTERNAL(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Objects
588unionAsync2_INTERNAL(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Objects
480touched(otherPart: Instance)

History 498

Members 117

Anchored

TypeDefault
bool

History 5

AngularAccelerationToTorque

Parameters (2)Default
angAccelerationVector3
angVelocityVector30, 0, 0
Returns (1)
Vector3

History 1

ApplyAngularImpulse

Parameters (1)
impulseVector3
Returns (1)
null

History 5

ApplyImpulse

Parameters (1)
impulseVector3
Returns (1)
null

History 5

ApplyImpulseAtPosition

Parameters (2)
impulseVector3
positionVector3
Returns (1)
null

History 5

AssemblyAngularVelocity

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated]

AssemblyCenterOfMass

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

AssemblyLinearVelocity

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated]

AssemblyMass

TypeDefault
float
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

AssemblyRootPart

TypeDefault
BasePart
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

BackSurface

TypeDefault
SurfaceType

History 4

BottomSurface

TypeDefault
SurfaceType

History 4

BreakJoints

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

BrickColor

TypeDefault
BrickColor
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

CFrame

TypeDefault
CFrame

History 5

CanCollide

TypeDefault
bool

History 5

CanCollideWith

Parameters (1)
partBasePart
Returns (1)
bool

History 4

CanQuery

TypeDefault
bool

History 3

CanSetNetworkOwnership

Parameters (0)
No parameters.
Returns (1)
Tuple

History 2

CanTouch

TypeDefault
bool

History 6

CastShadow

TypeDefault
bool

History 4

CenterOfMass

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

CollisionGroup

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

CollisionGroupId

TypeDefault
int
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. CollisionGroup should be used instead.
This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated, Deprecated]

Color

TypeDefault
Color3
This property is not replicated. Its interface does not cross the network boundary.

History 5

  • 553 Change Default of Color from to
  • 486 Change ThreadSafety of Color from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Color from to ReadOnly
  • 292 Change Tags of Color from [NotReplicated, Deprecated] to [NotReplicated]
  • 47 Add Color
Tags: [NotReplicated]

CurrentPhysicalProperties

TypeDefault
PhysicalProperties
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

CustomPhysicalProperties

TypeDefault
PhysicalProperties

History 5

EnableFluidForces

TypeDefault
bool

History 1

ExtentsCFrame

TypeDefault
CFrame
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

ExtentsSize

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

FrontSurface

TypeDefault
SurfaceType

History 4

GetClosestPointOnSurface

Parameters (1)
positionVector3
Returns (1)
Vector3

History 1

GetConnectedParts

Parameters (1)Default
recursiveboolfalse
Returns (1)
Objects

History 4

GetJoints

Parameters (0)
No parameters.
Returns (1)
Objects

History 5

GetMass

Parameters (0)
No parameters.
Returns (1)
float

History 5

GetNetworkOwner

Parameters (0)
No parameters.
Returns (1)
Instance

History 3

GetNetworkOwnershipAuto

Parameters (0)
No parameters.
Returns (1)
bool

History 3

GetNoCollisionConstraints

Parameters (0)
No parameters.
Returns (1)
Objects

History 1

GetRenderCFrame

Parameters (0)
No parameters.
Returns (1)
CFrame
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

GetRootPart

Parameters (0)
No parameters.
Returns (1)
Instance

History 3

GetTouchingParts

Parameters (0)
No parameters.
Returns (1)
Objects

History 2

GetVelocityAtPosition

Parameters (1)
positionVector3
Returns (1)
Vector3

History 2

IntersectAsync

Parameters (3)Default
partsObjects
collisionfidelityCollisionFidelityDefault
renderFidelityRenderFidelityAutomatic
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

IsGrounded

Parameters (0)
No parameters.
Returns (1)
bool

History 4

LeftSurface

TypeDefault
SurfaceType

History 4

LocalSimulationTouched

Parameters (1)
partBasePart
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

Locked

TypeDefault
bool

History 5

MakeJoints

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

Mass

TypeDefault
float
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

  • 553 Change Default of Mass from to
  • 520 Change Category of Mass from Data to Part
  • 486 Change ThreadSafety of Mass from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Mass from to ReadOnly
  • 424 Add Mass
Tags: [ReadOnly, NotReplicated]

Massless

TypeDefault
bool

History 5

Material

TypeDefault
Material

History 4

MaterialVariant

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

OutfitChanged

Parameters (0)
No parameters.
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

PivotOffset

TypeDefault
CFrame

History 4

Reflectance

TypeDefault
float

History 4

Resize

Parameters (2)
normalIdNormalId
deltaAmountint
Returns (1)
bool

History 3

ResizeIncrement

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

ResizeableFaces

TypeDefault
Faces
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

RightSurface

TypeDefault
SurfaceType

History 4

RootPriority

TypeDefault
int

History 5

Rotation

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

SetNetworkOwner

Parameters (1)Default
playerInstancePlayerPlayer
Returns (1)
null

History 4

SetNetworkOwnershipAuto

Parameters (0)
No parameters.
Returns (1)
null

History 3

Size

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.

History 6

  • 553 Change Default of Size from to
  • 538 Change Category of Size from Part to Transform
  • 486 Change ThreadSafety of Size from ReadOnly to ReadSafe
  • 476 Change Category of Size from Part to Part
  • 462 Change ThreadSafety of Size from to ReadOnly
  • 47 Add Size
Tags: [NotReplicated]

SpecificGravity

TypeDefault
float
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 8

Tags: [ReadOnly, NotReplicated, Deprecated]

StoppedTouching

Parameters (1)
otherPartBasePart
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. TouchEnded should be used instead.

History 8

Tags: [Deprecated]

SubtractAsync

Parameters (3)Default
partsObjects
collisionfidelityCollisionFidelityDefault
renderFidelityRenderFidelityAutomatic
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

TopSurface

TypeDefault
SurfaceType

History 4

TorqueToAngularAcceleration

Parameters (2)Default
torqueVector3
angVelocityVector30, 0, 0
Returns (1)
Vector3

History 1

TouchEnded

Parameters (1)
otherPartBasePart

History 3

Touched

Parameters (1)
otherPartBasePart

History 3

Transparency

TypeDefault
float

History 4

UnionAsync

Parameters (3)Default
partsObjects
collisionfidelityCollisionFidelityDefault
renderFidelityRenderFidelityAutomatic
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

breakJoints

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. BreakJoints should be used instead.

History 4

Tags: [Deprecated]

brickColor

TypeDefault
BrickColor
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. BrickColor should be used instead.
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated, Deprecated]

getMass

Parameters (0)
No parameters.
Returns (1)
float
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

  • 462 Change ThreadSafety of getMass from to Unsafe
  • 424 Change Tags of getMass from [Deprecated, CustomLuaState] to [Deprecated]
  • 349 Change Tags of getMass from [Deprecated] to [Deprecated, CustomLuaState]
  • 48 Add getMass
Tags: [Deprecated]

makeJoints

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

resize

Parameters (2)
normalIdNormalId
deltaAmountint
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Resize should be used instead.

History 3

Tags: [Deprecated]

Removed members 14

BodyAngularVelocity

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated]

BodyCenterOfMass

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

BodyLinearVelocity

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated]

BodyMass

TypeDefault
float
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

LinearVelocity

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

Negate

Parameters (0)
No parameters.
Returns (1)
Instance

History 2

Separate

Parameters (0)
No parameters.
Returns (1)
Objects

History 2

UnionWith

Parameters (1)
partInstance
Returns (1)
Instance

History 2

subtractAsync2_INTERNAL

Parameters (3)Default
partsObjects
collisionfidelityCollisionFidelityDefault
renderFidelityRenderFidelityAutomatic
Returns (1)
Objects
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

touched

Parameters (1)
otherPartInstance
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

unionAsync2_INTERNAL

Parameters (3)Default
partsObjects
collisionfidelityCollisionFidelityDefault
renderFidelityRenderFidelityAutomatic
Returns (1)
Objects
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Settings