PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. Workspace

Workspace

Show deprecated
Hide content
  1. apireference
  2. workspace

Workspace

Show deprecated

The Workspace is the service in which any objects that are to be rendered in the 3D world exist. Objects not descending from Workspace will not be rendered or physically interact with the world.

What does the Workspace do?

The core job of the Workspace is to hold objects that exist in the 3D world, BasePart|BaseParts and Attachment|Attachments. Whilst such objects are descendant of Workspace, they will be active. For BaseParts this means they will be rendered, and physically interact with other parts and the world. For Attachments this means objects adorned to them, such as ParticleEmitter|ParticleEmitters, Beam|Beams and BillboardGui|BillboardGuis will render.

Understanding this behavior is important, as it means objects can be removed from the Workspace when they are not needed. For example, map Model|Models can be removed from the Workspace when a different map is being played on. Objects that are not immediately needed in the Workspace are generally stored in ReplicatedStorage or ServerStorage.

In its role as the holder of active 3D objects, Workspace includes a number of useful functions related to parts, their positions and joints between them.

Accessing the Workspace

The Workspace can be accessed several ways, all of which are valid.

workspace -- a global variable
game.Workspace -- a property of the DataModel
game:GetService("Workspace") -- Workspace is a service

Notes

  • Objects that require adornment, such as ParticleEmitters and BillboardGuis will be adorned to the 0, 0, 0 position when adorned to the Workspace (parented to it without an adornee otherwise being set)
  • The Model/MakeJoints and Model/BreakJoints functions inherited from the Model class are overridden by the Workspace’s own Workspace/MakeJoints and Workspace/BreakJoints functions, which can only be used in plugins
  • It is impossible to delete the Workspace
  • The Workspace will also clean up BaseParts that fall beneath Workspace/FallenPartsDestroyHeight
  • A client’s current Camera object can be accessed using the Workspace/CurrentCamera property
  • The Terrain object can be accessed using the Workspace/Terrain property

Properties

bool

AllowThirdPartySales

[NotReplicated]

Determines whether assets created by other uses can be sold in the game.
NewAnimationRuntimeSetting

AnimationWeightedBlendFix

[NotScriptable]
ClientAnimatorThrottlingMode

ClientAnimatorThrottling

Camera

CurrentCamera

[NotReplicated]

The Camera object being used by the local player.
double

DistributedGameTime

[NotReplicated]

The amount of time, in seconds, that the game has been running.
float

FallenPartsDestroyHeight

Determines the height at which falling BasePart|BaseParts (and their ancestor Model|Models) are destroyed
bool

FilteringEnabled

[Hidden] [NotReplicated] [Deprecated]

Determines whether changes made from the client will replicate to the server or not.
Vector3

GlobalWind

float

Gravity

Determines the acceleration due to gravity applied to falling BaseParts.
HumanoidOnlySetCollisionsOnStateChange

HumanoidOnlySetCollisionsOnStateChange

[NotScriptable]
InterpolationThrottlingMode

InterpolationThrottling

MeshPartHeadsAndAccessories

MeshPartHeadsAndAccessories

[NotScriptable]
PhysicsSimulationRate

PhysicsSimulationRate

[Hidden] [NotReplicated]
PhysicsSteppingMethod

PhysicsSteppingMethod

[NotScriptable]

Sets how the solver will advance the physics simulation forward in time.
AnimatorRetargetingMode

Retargeting

SignalBehavior

SignalBehavior

[NotScriptable]
StreamOutBehavior

StreamOutBehavior

[NotScriptable]
bool

StreamingEnabled

Whether content streaming is enabled for the place
int

StreamingMinRadius

[NotScriptable]

Minimum distance that content will be streamed to players with high priority
StreamingPauseMode

StreamingPauseMode

[NotScriptable]

Whether streaming physics pause mode is active
int

StreamingTargetRadius

[NotScriptable]

Maximum distance that content will be streamed to players
Terrain

Terrain

[ReadOnly] [NotReplicated]

A reference to the Terrain object parented to the Workspace
bool

TouchesUseCollisionGroups

[NotScriptable]

Determines whether BasePart|parts in different groups set to not collide will ignore collisions and touch events

Inherited from Model: Show Hide

ModelLevelOfDetail

LevelOfDetail

BasePart

PrimaryPart

Points to the primary part of the Model.
Vector3

World Pivot Orientation

[NotReplicated] [NotScriptable]

Editor-only property to set the orientation of the pivot. Scripts must use Model/WorldPivot instead.
Vector3

World Pivot Position

[NotReplicated] [NotScriptable]

Editor-only property to set the position of the pivot. Scripts must use Model/WorldPivot instead.
CFrame

WorldPivot

[NotReplicated]

Determines where the pivot of a Model which does not have a set Model/PrimaryPart is located.

Inherited from PVInstance: Show Hide

Vector3

Origin Orientation

[NotReplicated] [NotScriptable]

Editor-only property used to rotate the object around its pivot. Scripts must use PVInstance/PivotTo instead.
Vector3

Origin Position

[NotReplicated] [NotScriptable]

Editor-only property used to move the object. Scripts must use PVInstance/PivotTo instead.
Vector3

Pivot Offset Orientation

[NotReplicated] [NotScriptable]

Editor-only property to set the orientation of the pivot relative to a part. Scripts must use BasePart/PivotOffset instead.
Vector3

Pivot Offset Position

[NotReplicated] [NotScriptable]

Editor-only property to set the position of the pivot relative to a part. Scripts must use BasePart/PivotOffset instead.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

BreakJoints ( Objects objects )

Goes through all BaseParts given, breaking any joints connected to these parts.
float

CalculateJumpDistance ( float gravity , float jumpPower , float walkSpeed )

float

CalculateJumpHeight ( float gravity , float jumpPower )

float

CalculateJumpPower ( float gravity , float jumpHeight )

bool

ExperimentalSolverIsEnabled ( )

Returns true if the game has the PGS Physics solver enabled.
int

GetNumAwakeParts ( )

Returns the number of BaseParts that are deemed physically active, due to being recently under the influence of physics.
int

GetPhysicsThrottling ( )

Returns an integer, between 0 and 100, representing the percentage of real-time that physics simulation is currently being throttled to.
double

GetRealPhysicsFPS ( )

Returns the number of frames per second that physics is currently being simulated at.
double

GetServerTimeNow ( )

Returns the server epoch time in seconds.
void

JoinToOutsiders ( Objects objects , JointCreationMode jointType )

Creates joints between the specified BasePart|Parts and any touching parts depending on the parts’ surfaces and the specified joint creation mode.
void

MakeJoints ( Objects objects )

Goes through all BaseParts given. If any part’s side has a Enum/SurfaceType that can make a joint it will create a joint with any adjacent parts.
bool

PGSIsEnabled ( )

Returns true if the game has the PGS Physics solver enabled.
void

SetMeshPartHeadsAndAccessories ( MeshPartHeadsAndAccessories value )

void

SetPhysicsThrottleEnabled ( bool value )

Determines whether physics throttling is enabled
void

UnjoinFromOutsiders ( Objects objects )

Breaks all joints between the specified BaseParts and other BaseParts.
void

ZoomToExtents ( )

Positions and zooms the Workspace/CurrentCamera to show the extent of BaseParts currently in the Workspace.

Inherited from Model: Show Hide

void

BreakJoints ( )

Breaks connections between BaseParts, including surface connections with any adjacent parts, WeldConstraints and all Welds and other JointInstances.
Tuple

GetBoundingBox ( )

Returns a description of a volume that contains all parts of a Model
Vector3

GetExtentsSize ( )

Returns the size of the smallest bounding box that contains all of the BaseParts in the Model, aligned with the Model/PrimaryPart if it is set.
CFrame

GetModelCFrame ( )

[Deprecated]

This value historically returned the CFrame of a central position in the model. It has been deprecated as it did not provide reliable results.
Vector3

GetModelSize ( )

[Deprecated]

Returns the Vector3 size of the Model.
CFrame

GetPrimaryPartCFrame ( )

Returns the CFrame of the Model’s Model/PrimaryPart. This function will throw an error if no primary part exists for the Model.
void

MakeJoints ( )

Goes through all BaseParts in the Model. If any part’s side has a SurfaceType that can make a joint it will create a joint with any adjacent parts
void

MoveTo ( Vector3 position )

Moves the Model/PrimaryPart to the given position. If a primary part has not been specified then the root part of the model will be used.
void

ResetOrientationToIdentity ( )

[Deprecated]

Resets the rotation of the model’s parts to the previously set identity rotation, which is done through the Model/SetIdentityOrientation method.
void

SetIdentityOrientation ( )

[Deprecated]

Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of the ResetOrientationToIdentity method.
void

SetPrimaryPartCFrame ( CFrame cframe )

Sets the BasePart/CFrame of the Model’s Model/PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the Model/PrimaryPart.
void

TranslateBy ( Vector3 delta )

Shifts a Model by the given Vector3 offset, preserving the Model’s orientation. If another BasePart or Terrain already exists at the new position then the Model will overlap said object.
void

breakJoints ( )

[Deprecated]
void

makeJoints ( )

[Deprecated]
void

move ( Vector3 location )

[Deprecated]
void

moveTo ( Vector3 location )

[Deprecated]

Inherited from PVInstance: Show Hide

CFrame

GetPivot ( )

Gets the pivot of a PVInstance.
void

PivotTo ( CFrame targetCFrame )

Transforms the PVInstance along with all of its descendant PVInstance|PVInstances such that the pivot is now located at the specified datatype/CFrame.

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples

ServerStorage Map Rotation

This is a very simple example of how a multiple map system can be made using ServerStorage.

It creates three dummy models (to take the place of maps), that are parented to ServerStorage. Then, it will load a random map (different to the previous map) and wait a specified duration on a loop.

Developers wishing to integrate something similar into their games should consider measures to ensure players respawn correctly, or go to a lobby during intermission periods.

Copy Code Light Theme
Tool BillboardGui