RBX.lua.BasePart (Object)

Derived Classes

CornerWedgePart

FormFactorPart

ParallelRampPart

BasePart (extends PVInstance)

• MakeJoints
• BreakJoints
• GetMass
• Resize
• Clone
• FindFirstChild
• GetChildren
• GetDebugId
• GetFullName
• IsA
• IsAncestorOf
• IsDescendantOf
• Destroy
• ClearAllChildren

• Anchored
• BrickColor
• CFrame
• CanCollide
• Elasticity
• Friction
• Locked
• Material
• Position
• Reflectance
• RotVelocity
• Size
• Transparency
• Velocity
• (side)ParamA
• (side)ParamB
• (side)Surface
• (side)SurfaceInput
• Name
• Parent
• Archivable
• ClassName
• RobloxLocked
• DataCost

• LocalSimulationTouched
• Touched
• TouchEnded
• AncestryChanged
• Changed
• ChildAdded
• ChildRemoved
• DescendantAdded
• DescendantRemoving

A BasePart is a Structural Class type of object that cannot be created. It is the base for all other part objects, it's properties are inherited to it's children.

MakeJoints( )
Returns	nil
Description:	Creates a joint on any side of the object that has a surface ID that can make a joint.
Member of:	BasePart, Model

BreakJoints( )
Returns	nil
Description:	Breaks any surface connection with any adjacent part, including Welds and other JointInstances.
Member of:	BasePart, Model

GetMass( )
Returns	Number object mass
Description:	Returns the Number of the object's mass.
Member of:	BasePart

Resize( NormalId NormalId, Integer DeltaAmount )
Returns	nil
Description:	Changes the size of an object just like using the Studio resize tool. NormalId is a side, DeltaAmount is how much to grow/shrink on that side.
Member of:	BasePart

Clone( )
Returns	Instance
Description:	Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of:	Instance

FindFirstChild( string name, bool recursive = false )
Returns	Instance
Description:	Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of:	Instance

GetChildren( )
Returns	table
Description:	Returns a read-only table of the object's children.
Member of:	Instance

GetDebugId( int scopeLength )
Returns	string
Description:	Returns a coded string of the object's DebugId used internally by Roblox.
Member of:	Instance

GetFullName( )
Returns	String path to object
Description:	Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of:	Instance

IsA( string className )
Returns	bool
Description:	Returns true if the Instance is that class or a subclass.
Member of:	Instance

IsAncestorOf( Instance descendant )
Returns	boolean is ancestor
Description:	Returns true if the object is an ancestor of descendant.
Member of:	Instance

IsDescendantOf( Instance ancestor )
Returns	bool
Description:	Returns true if the object is an descendant of ancestor.
Member of:	Instance

Destroy( )
Returns	nil
Description:	Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of:	Instance

ClearAllChildren( )
Returns	nil
Description:	Removes all descendants of the Instance, but leaves the Instance itself.
Member of:	Instance

Anchored
Type	bool
Description	Sets whether or not the object is frozen in place.
Member of	BasePart

BrickColor
Property	BrickColor BrickColor
Description	Stores the color of the object.
Member of	BasePart

CFrame
Property	CFrame CFrame
Description	The current Position and rotation of an object.
Member of	BasePart, Pose

CanCollide
Property	Bool CanCollide
Description	If true, then the object will collide with other objects.
Member of	BasePart

Elasticity
Property	Number Elasticity
Description	Sets how much the object will rebound against another. a value of 1 is like a superball, and 0 is like a lead block.
Member of	BasePart

Friction
Property	Number Friction
Description	Sets how much friction the object has. A value of 1 is a no-slick grip, 0 is a waxy floor.
Member of	BasePart

Locked
Property	Bool Is Locked
Description	If True, the object will not be selectable.
Member of	BasePart

Material
Property	Meterial
Description	Sets the material that the object is made out of.
Member of	BasePart

Position
Property	Vector3 Position
Description	Stores the current location of the object in world coordinates.
Member of	BasePart, Explosion

Reflectance
Property	Number Reflectance
Description	Sets how reflective the object is. A value of 1 is like chrome, a value of 0 is a concrete wall.
Member of	BasePart

RotVelocity
Property	Vector3 RotVelocity
Description	Stores the rotational velocity of the object.
Member of	BasePart

Size
Property	Vector3 Size
Description	Sets the size of the object in object coordinates.
Member of	BasePart

Transparency
Property	Number Transparency
Description	Sets how see-through the object is. A value of 1 is completely invisible, a value of 0 is completely opaque.
Member of	BasePart

Velocity
Type	Vector3
Description	Stores the speed and movement direction of the object.
Member of	BasePart

ParamA
Property	Number parameter a
Description
Member of	BasePart

ParamB
Property	Number Parameter b
Description	Rotational speed of a Motor joint
Member of	BasePart

Surface
Property	SurfaceType
Description	Sets what the type of the surface is.
Member of	BasePart

SurfaceInput
Property	SurfaceInput SurfaceInput
Description	Sets what the surface's input is.
Member of	BasePart

Name
Type	string
Description	The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of	Instance

Parent
Type	Instance
Description	The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of	Instance

Archivable
Type	bool
Description	Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of	Instance

ClassName
Type	string
Description	A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of	Instance

RobloxLocked
Type	bool
Description	If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
Member of	Instance

DataCost
Type	int
Description	How much saving this instance with SaveInstance will add to DataComplexity
Member of	Instance

LocalSimulationTouched ( Instance part )
Description	Fired when another part comes in contact with another object. This event only sends data to the client notifying it that two parts have collided, whereas Touched sends data to the server.
Member of:	BasePart

Touched ( BasePart otherPart )
Description	Fired when another object comes in contact with this object.
Member of:	BasePart

TouchEnded ( BasePart otherPart )
Description	Fired when otherPart stops touching this object.
Member of:	BasePart

AncestryChanged ( Instance child, Instance parent )
Description	Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of:	Instance

Changed ( Property property )
Description	Fired whenever a property of the object changes.
Member of:	Instance

ChildAdded ( Instance child )
Description	Fired after a child is added.
Member of:	Instance

ChildRemoved ( Instance child )
Description	Fired when a child is removed from the object.
Member of:	Instance

DescendantAdded ( Instance descendant )
Description	Fired when a descendant is added to the object.
Member of:	Instance

DescendantRemoving ( Instance descendant )
Description	Fired when a descendant is being removed.
Member of:	Instance