RBX.lua.Workspace (Service)

Up one category:
Class reference

Workspace (extends RootInstance) method FindPartOnRay method FindPartOnRayWithIgnoreList method FindPartsInRegion3 method FindPartsInRegion3WithIgnoreList method InsertContent method SetPhysicsThrottleEnabled method ZoomToExtents method BreakJoints method GetModelCFrame method GetModelSize method MakeJoints method MoveTo method ResetOrientationToIdentity method SetIdentityOrientation method TranslateBy method Clone method FindFirstChild method GetChildren method GetDebugId method GetFullName method IsA method IsAncestorOf method IsDescendantOf method Destroy method ClearAllChildren property CurrentCamera property DistributedGameTime property Terrain property PrimaryPart property Name property Parent property Archivable property ClassName property RobloxLocked property DataCost event AncestryChanged event Changed event ChildAdded event ChildRemoved event DescendantAdded event DescendantRemoving

The Workspace is where any objects which are rendered in the 3D world exist. Anything not located here will not physically interact with the world. The Workspace is the 'world' inside Roblox.

FindPartOnRay( Ray ray, Instance ignoreDescendentsInstance, Bool TerrainCellsAreCubes )
Returns	BasePart object, Vector3 position
Description:	Returns the first part that intersects with a ray.
Member of:	Workspace

FindPartOnRayWithIgnoreList( Ray ray, Table ignoreDescendentsTable, Bool TerrainCellsAreCubes )
Returns	BasePart object, Vector3 position
Description:	Returns the first part that intersects with a ray.
Member of:	Workspace

FindPartsInRegion3( Region3 region, Instance ignoreDescendentsInstance, int maxParts = 20 )
Returns	table
Description:	Returns a table filled with parts inside the Region3.
Member of:	Workspace

FindPartsInRegion3WithIgnoreList( Region3 region, Instance ignoreDescendentsTable, int maxParts = 20 )
Returns	table
Description:	Returns parts in the area defined by the Region3, up to specified maxParts or 100, whichever is less.
Member of:	Workspace

InsertContent( Content url )
Returns	Table
Description:	Inserts a model from the item's URL. Used in group building.
Member of:	Workspace

SetPhysicsThrottleEnabled( bool enabled )
Returns	nil
Description:	Sets whether Physics Throttling is enabled or disabled.
Member of:	Workspace

Protected:This item is protected. Attempting to use it in a Script or LocalScript will cause an error.

ZoomToExtents( )
Returns	nil
Description:	Zooms the CurrentCamera all the way out. It is used in the "Zoom To Extents" button.
Member of:	Workspace

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

GetModelCFrame( )
Returns	CFrame
Description:	Returns the model's CFrame Position.
Member of:	Model

GetModelSize( )
Returns	Vector3 modelSize
Description:	Returns the Vector3 Size of the Model.
Member of:	Model

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

MoveTo( Vector3 destination )
Returns	nil
Description:	Moves the object and all children instantly to the destination.
Member of:	Model

ResetOrientationToIdentity( )
Returns	nil
Description:	Resets the rotation of the model's parts to the previously set identity rotation.
Member of:	Model

SetIdentityOrientation( )
Returns	nil
Description:	Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later.
Member of:	Model

TranslateBy( Vector3 offset )
Returns	nil
Description:	Shifts a model using its offset.
Member of:	Model

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

CurrentCamera
Property	Camera Camera
Description	The Camera object for the local player. This allows a LocalScript to get and modify the camera of a player. When this property is set, it will remove the old camera.
Member of	Workspace

DistributedGameTime
Property	float ServerTime
Description	The amount of time, in seconds, that the game has been running.
Member of	Workspace

Terrain
Property	Type Instance
Description	The Terrain object for the place. Cannot be removed; should always be anchored and locked.
Member of	Workspace

PrimaryPart
Property	Object primary child
Description	The object's primary part.
Member of	Model, Workspace

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

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