Workspace

Workspace
Not creatableThis class cannot be instantiated. ServiceThis class is a service.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Memory category	PhysicsParts
Inheritance
Instance PVInstance Model WorldRoot Workspace

Properties of the class per category.

The Workspace class represents the physical area in which a game mostly takes place. It has no actual physical boundaries, but there are technical boundaries, as heading too far away from the origin (0, 0, 0) will cause floating-point inaccuracies to occur, and rendering will get shaky. Heading too far away will not render anything at all, and players at this distance will be left with a black screen. The Workspace is mostly used for housing the environment of a game. Other objects that may appear later may be stored in ServerStorage or ReplicatedStorage, the latter of which being used for server-only storage. All the visible BaseParts in a game must be placed in the Workspace in order for players to see and interact with them. Scripts, while usually put in ServerScriptService, will also run if they are placed in the Workspace. The Workspace class inherits from WorldRoot.

Properties

AirDensity: float

This class member is missing documentation. Create or add to its subpage at Class:Workspace/AirDensity.

• Category: AirProperties.
• Serialization: can save and load.
• Thread safety: read safe

AllowThirdPartySales: bool

• Not replicatedThis member is not replicated across the network boundary.

When enabled, assets created by other users can be purchased in-game using MarketplaceService. This property does not impact developer products, which can only be sold in the experience they were created under.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

AvatarUnificationMode: AvatarUnificationMode

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/AvatarUnificationMode.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

ClientAnimatorThrottling: ClientAnimatorThrottlingMode

This class member is missing documentation. Create or add to its subpage at Class:Workspace/ClientAnimatorThrottling.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

CurrentCamera: Camera

• Not replicatedThis member is not replicated across the network boundary.

On the client, this property's value is the Camera object currently tied to the local Player. This property can be set to another Camera, which will also delete any other Cameras present in the Workspace on the client. When set to nil, all Cameras present in the Workspace are deleted and a new one is created and set as the new CurrentCamera, but this can have unexpected consequences.

This value will always be nil on the server. As a result, a LocalScript (or a ModuleScript running on the client) must be used to reference it.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

DistributedGameTime: double

• Not replicatedThis member is not replicated across the network boundary.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/DistributedGameTime.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

EditorLiveScripting: EditorLiveScripting

• Not scriptableThis member cannot be accessed by Lua code.

Indicates whether or not live scripting is enabled in studio. Enabling live scripting allows multiple people to edit one script simultaneously, with their changes shown to other editors in real time.

• Category: Scripting.
• Serialization: can save and load.
• Thread safety: read safe

FallenPartsDestroyHeight: float

This property determines at what vertical height, or Y-coordinate, any BasePart is parented to nil. If a removed part is the last part in a Model, the Model is also removed. The value of this property is clamped between -50,000 and 50,000 studs.

• Category: Behavior.
• Write security: PluginSecurity.
• Serialization: can save and load.
• Thread safety: read safe

FilteringEnabled: bool

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This property previously toggled replication filtering for an experience, but no longer has any effect because replication filtering is forced on in all experiences.

• Category: Behavior.
• Write security: PluginSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

FluidForces: FluidForces

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/FluidForces.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

GlobalWind: Vector3

This class member is missing documentation. Create or add to its subpage at Class:Workspace/GlobalWind.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

Gravity: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/Gravity.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

IKControlConstraintSupport: IKControlConstraintSupport

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/IKControlConstraintSupport.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

InterpolationThrottling: InterpolationThrottlingMode

This class member is missing documentation. Create or add to its subpage at Class:Workspace/InterpolationThrottling.

• Category: Behavior.
• Write security: PluginSecurity.
• Serialization: can save and load.
• Thread safety: read safe

MeshPartHeadsAndAccessories: MeshPartHeadsAndAccessories

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/MeshPartHeadsAndAccessories.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

ModelStreamingBehavior: ModelStreamingBehavior

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/ModelStreamingBehavior.

• Category: Streaming.
• Serialization: can save and load.
• Thread safety: read safe

PhysicsSteppingMethod: PhysicsSteppingMethod

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/PhysicsSteppingMethod.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

PlayerCharacterDestroyBehavior: PlayerCharacterDestroyBehavior

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/PlayerCharacterDestroyBehavior.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

PrimalPhysicsSolver: PrimalPhysicsSolver

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/PrimalPhysicsSolver.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

RejectCharacterDeletions: RejectCharacterDeletions

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/RejectCharacterDeletions.

• Category: Networking.
• Serialization: can save and load.
• Thread safety: read safe

ReplicateInstanceDestroySetting: ReplicateInstanceDestroySetting

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/ReplicateInstanceDestroySetting.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

Retargeting: AnimatorRetargetingMode

This class member is missing documentation. Create or add to its subpage at Class:Workspace/Retargeting.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

SignalBehavior: SignalBehavior

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/SignalBehavior.

• Category: Behavior.
• Serialization: cannot load or save.
• Thread safety: read safe

StreamOutBehavior: StreamOutBehavior

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/StreamOutBehavior.

• Category: Streaming.
• Serialization: can save and load.
• Thread safety: read safe

StreamingEnabled: bool

This class member is missing documentation. Create or add to its subpage at Class:Workspace/StreamingEnabled.

• Category: Streaming.
• Write security: PluginSecurity.
• Serialization: can save and load.
• Thread safety: read safe

StreamingIntegrityMode: StreamingIntegrityMode

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/StreamingIntegrityMode.

• Category: Streaming.
• Serialization: can save and load.
• Thread safety: read safe

StreamingMinRadius: int

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/StreamingMinRadius.

• Category: Streaming.
• Serialization: can save and load.
• Thread safety: read safe

StreamingTargetRadius: int

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/StreamingTargetRadius.

• Category: Streaming.
• Serialization: can save and load.
• Thread safety: read safe

Terrain: Terrain

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This property is the Terrain object that is currently parented to the Workspace.

• Category: Behavior.
• Serialization: cannot load or save.
• Thread safety: read safe

TouchesUseCollisionGroups: bool

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/TouchesUseCollisionGroups.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

Methods

BreakJoints(objects: Objects): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
objects	Objects

• Security: PluginSecurity.
• Thread safety: unsafe

CalculateJumpDistance(gravity: float, jumpPower: float, walkSpeed: float): float

Parameters

Name	Type
gravity	float
jumpPower	float
walkSpeed	float

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

CalculateJumpHeight(gravity: float, jumpPower: float): float

Parameters

Name	Type
gravity	float
jumpPower	float

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

CalculateJumpPower(gravity: float, jumpHeight: float): float

Parameters

Name	Type
gravity	float
jumpHeight	float

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ExperimentalSolverIsEnabled(): bool

This class member is missing documentation. Create or add to its subpage at Class:Workspace/ExperimentalSolverIsEnabled.

• Security: LocalUserSecurity.
• Thread safety: unsafe

GetNumAwakeParts(): int

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Workspace/GetNumAwakeParts.

• Thread safety: safe

GetPhysicsThrottling(): int

This class member is missing documentation. Create or add to its subpage at Class:Workspace/GetPhysicsThrottling.

• Thread safety: safe

GetRealPhysicsFPS(): double

This class member is missing documentation. Create or add to its subpage at Class:Workspace/GetRealPhysicsFPS.

• Thread safety: safe

GetServerTimeNow(): double

This class member is missing documentation. Create or add to its subpage at Class:Workspace/GetServerTimeNow.

• Thread safety: safe

JoinToOutsiders(objects: Objects, jointType: JointCreationMode): null

Parameters

Name	Type
objects	Objects
jointType	JointCreationMode

• Thread safety: unsafe

MakeJoints(objects: Objects): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
objects	Objects

• Security: PluginSecurity.
• Thread safety: unsafe

PGSIsEnabled(): bool

This class member is missing documentation. Create or add to its subpage at Class:Workspace/PGSIsEnabled.

• Thread safety: unsafe

SetAvatarUnificationMode(value: AvatarUnificationMode): null

This class member is missing documentation. Create or add to its subpage at Class:Workspace/SetAvatarUnificationMode.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetMeshPartHeadsAndAccessories(value: MeshPartHeadsAndAccessories): null

Parameters

Name	Type
value	MeshPartHeadsAndAccessories

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetPhysicsThrottleEnabled(value: bool): null

Parameters

Name	Type
value	bool

• Security: LocalUserSecurity.
• Thread safety: unsafe

UnjoinFromOutsiders(objects: Objects): null

Parameters

Name	Type
objects	Objects

• Thread safety: unsafe

ZoomToExtents(): null

This class member is missing documentation. Create or add to its subpage at Class:Workspace/ZoomToExtents.

• Security: PluginSecurity.
• Thread safety: unsafe

Events

PersistentLoaded(player: Player)

Parameters

Name	Type	Description
player	Player	The Player who was received all persistent models.

This event is fired when all persistent models or atomic models without any BaseParts have been sent to a player.

• Thread safety: unsafe

Removed members

Methods

• findPartOnRay
• FindPartOnRay
• FindPartOnRayWithIgnoreList
• FindPartOnRayWithWhitelist
• findPartsInRegion3
• FindPartsInRegion3
• FindPartsInRegion3WithIgnoreList
• FindPartsInRegion3WithWhiteList
• GetPhysicsAnalyzerBreakOnIssue
• GetPhysicsAnalyzerIssue
• InsertContent
• IsRegion3Empty
• IsRegion3EmptyWithIgnoreList
• SetMeshPartHeads
• SetPhysicsAnalyzerBreakOnIssue

Properties

• AnimationWeightedBlendFix
• AutoJointsMode
• EnableFluidForces
• HumanoidOnlySetCollisionsOnStateChange
• IsMouseCursorShown
• MeshPartHeads
• NewPhysicsSolver
• PGSPhysicsSolverEnabled
• PhysicsInertiaAndVolumeFix
• PhysicsSimulationRate
• SkinnedMeshEnabled
• StreamingPauseMode
• TemporaryLegacyPhysicsSolverOverride
• UnionsScaleNonuniformly

Events

• PhysicsAnalyzerIssuesFound

External links

• Workspace in the Roblox Creator Documentation
• Workspace in the Roblox API Reference