Project:Class documentation

= Instance =

The Instance class is the base class of the object system. All other classes inherit, either directly or indirectly, from this class. The members that are common to all the classes belong to the  class, which is why many of the most important and most used members belong to this class.

Properties
This class has eight properties.

Determines whether or not an Instance can be saved when the game closes/attempts to save the game. Note: this only applies to games that use Data Persistence, or SavePlaceAsync.

The string name of this Instance's most derived class.

The Instance that is directly above this Instance in the tree.

Methods
This class has twenty-one methods.

Removes all children (but not this object) from the workspace.

Returns a copy of this Object and all its children. The copy's Parent is nil

Removes object and all of its children from the workspace. Disconnects object and all children from open connections. Object and children may not be usable after calling Destroy.

Returns the first child of this Instance that matches the first argument 'name'. The second argument 'recursive' is an optional boolean (defaults to false) that will force the call to traverse down thru all of this Instance's descendants until it finds an object with a name that matches the 'name' argument. The function will return nil if no Instance is found.

Returns a read-only table of this Object's children

This function is for internal testing. Don't use in production code

Returns a string that shows the path from the root node (DataModel) to this Instance. This string does not include the root node (DataModel).

Returns a boolean if this Instance is of type 'className' or a is a subclass of type 'className'. If 'className' is not a valid class type in ROBLOX, this function will always return false. More info

Deprecated. Use ClearAllChildren to get rid of all child objects, or Destroy to invalidate this object and its descendants

Use GetChildren instead

Use Clone instead

Use FindFirstChild instead

Use GetChildren instead

Use IsA instead

Use Remove instead

Events
This class has seven events.

Fired when any of this object's ancestors change. First argument 'child' is the object whose parent changed. Second argument 'parent' is the first argument's new parent.

Fired after a property changes value. The property argument is the name of the property

Fired after an Instance is parented to this object, or any of this object's descendants. The 'descendant' argument is the Instance that is being added.

Fired after an Instance is unparented from this object, or any of this object's descendants. The 'descendant' argument is the Instance that is being added.

= AnalyticsService =

The AnalyticsService class, added in version 0.268, inherits from. It cannot be instantiated.

Methods
This class has five methods.

= Hopper =

Use StarterPack instead. This class is deprecated.

= BindableFunction =

Allow functions defined in one script to be called by another script. This class was added in version 0.51.

Methods
This class has one method.

Causes the function assigned to OnInvoke to be called. Arguments passed to this function get passed to OnInvoke function.

Callbacks
This class has one callback.

Should be defined as a function. This function is called when Invoke is called. Number of arguments is variable.

= Part =

A plastic building block - the fundamental component of ROBLOX.

Properties
This class has one property.

= BasePart =

A structural class, not creatable.

Properties
This class has forty-seven properties.

Determines whether or not physics acts upon the Part. If true, part stays 'Anchored' in space, not moving regardless of any collision/forces acting upon it. If false, physics works normally on the part.

Contains information regarding the Part's position and a matrix that defines the Part's rotation. Can read/write. More info

Determines whether physical interactions with other Parts are respected. If true, will collide and react with physics to other Parts. If false, other parts will pass thru instead of colliding

Deprecated. Use BrickColor instead

A float value ranging from 0.0f to 1.0f. Sets how much the Part will rebound against another. a value of 1 is like a superball, and 0 is like a lead block.

A float value ranging from 0.0f to 1.0f. Sets how much the Part will be able to slide. a value of 1 is no sliding, and 0 is no friction, so infinite sliding.

Determines whether building tools (in-game and studio) can manipulate this Part. If true, no editing allowed. If false, editing is allowed.

Specifies the look and feel the Part should have. Note: this does not define the color the Part is, see BrickColor for that. More info

Specifies how shiny the Part is. A value of 1 is completely reflective (chrome), while a value of 0 is no reflectance (concrete wall)

Sets the value for the smallest change in size allowable by the Resize(NormalId, int) function.

Sets the value for the faces allowed to be resized by the Resize(NormalId, int) function.

Sets how visible an object is. A value of 1 makes the object invisible, while a value of 0 makes the object opaque.

How fast the Part is traveling in studs/second. This property is NOT recommended to be modified directly, unless there is good reason. Otherwise, try using a BodyForce to move a Part.

Methods
This class has eighteen methods.

Destroys SurfaceJoints with all parts that are touching this Instance (including internal joints in the Instance, as in a Model).

Returns a number that is the mass of this Instance. Mass of a Part is immutable, and is changed only by the size of the Part.

Creates the appropriate SurfaceJoints with all parts that are touching this Instance (including internal joints in the Instance, as in a Model). This uses the SurfaceTypes defined on the surfaces of parts to create the appropriate welds. More info

Resizes a Part in the direction of the face defined by 'NormalId', by the amount specified by 'deltaAmount'. If the operation will expand the part to intersect another Instance, the part will not resize at all. Return true if the call is successful, false otherwise.

Use GetMass instead

Use MakeJoints instead

Events
This class has six events.

Deprecated. Use Touched instead

Deprecated. Use TouchEnded instead

Fired when the part stops touching another part

= DataModel =

The root of ROBLOX's parent-child hierarchy (commonly known as game after the global variable used to access it).

Properties
This class has thirteen properties.

Deprecated. Use Workspace

Methods
This class has forty-two methods.

Returns true if the game has finished loading, false otherwise. Check this before listening to the Loaded signal to ensure a script knows when a game finishes loading.

Use SetCreatorId instead

Use SetPlaceId instead

Events
This class has four events.

Fires when the game finishes loading. Use this to know when to remove your custom loading gui. It is best to check IsLoaded before connecting to this event, as the game may load before the event is connected to.

Callbacks
This class has two callbacks.

Deprecated. Use DataModel.BindToClose

= RemoteFunction =

Allow functions defined in one script to be called by another script across client/server boundary. This class was added in version 0.123.

Methods
This class has two methods.

Callbacks
This class has two callbacks.