Workspace
Contains rendered and physically simulated instances.
- Service
game:GetService("Workspace")- Inherits
- WorldRootModelPVInstanceInstance
- Replication
- Never
Behavior
Workspace contains the instances used for world rendering and physics. The
workspace global references this service.
Summary
Whether the default baseplate is enabled.
The active camera for the current client.
The elapsed time since the place started, in seconds.
The world Y coordinate below which parts are removed.
The world-space wind vector used by wind-aware simulation and rendering.
The default gravity acceleration magnitude in studs per second squared.
The default gravity direction as a Vector3.
Whether the place uses distance-based world streaming.
The minimum streaming radius around a player's viewing origin, in studs.
The target streaming radius around a player's viewing origin, in studs.
Returns whether the supplied Parts are touching other Parts within the supplied tolerance.
Blockcast(cframe: CFrame, size: Vector3, direction: Vector3, params: RaycastParams?): RaycastResult?parallel readCasts a box through the world and returns the first hit.
Returns the gravity acceleration at the supplied world-space position.
Returns Parts overlapping the supplied Part, subject to optional OverlapParams.
Returns parts overlapping the specified box.
OverlapSphere(position: Vector3, radius: number, overlapParams: OverlapParams?): { BasePart }parallel readReturns parts overlapping a sphere.
Raycast(origin: Vector3, direction: Vector3, raycastParams: RaycastParams?): RaycastResult?parallel readCasts a finite ray and returns the first hit.
Casts a shape through the world and returns the first hit.
Spherecast(position: Vector3, radius: number, direction: Vector3, params: RaycastParams?): RaycastResult?parallel readCasts a sphere through the world and returns the first hit.
Properties
BaseplateEnabled
Workspace.BaseplateEnabled: booleanWhether the default baseplate is enabled.
CurrentCamera
Workspace.CurrentCamera: Camera?The active camera for the current client. Access it from a LocalScript.
DistributedGameTime
Workspace.DistributedGameTime: numberThe elapsed time since the place started, in seconds.
FallenPartsDestroyHeight
Workspace.FallenPartsDestroyHeight: numberThe world Y coordinate below which parts are removed.
GlobalWind
Workspace.GlobalWind: Vector3The world-space wind vector used by wind-aware simulation and rendering.
Gravity
Workspace.Gravity: numberThe default gravity acceleration magnitude in studs per second squared. Defaults to 196.2; assignments clamp to 0 through 1000. GravityDirection selects the default direction. Local gravity configurations can override the default.
GravityDirection
Workspace.GravityDirection: Vector3The default gravity direction as a Vector3. Assignments are normalized. Zero or non-finite vectors produce an error.
StreamingEnabled
Workspace.StreamingEnabled: booleanWhether the place uses distance-based world streaming.
StreamingMinRadius
Workspace.StreamingMinRadius: numberThe minimum streaming radius around a player's viewing origin, in studs.
StreamingTargetRadius
Workspace.StreamingTargetRadius: numberThe target streaming radius around a player's viewing origin, in studs.
Methods
ArePartsTouchingOthers
Workspace:ArePartsTouchingOthers(table, number?): booleanReturns whether the supplied Parts are touching other Parts within the supplied tolerance.
Blockcast
Workspace:Blockcast(cframe: CFrame, size: Vector3, direction: Vector3, params: RaycastParams?): RaycastResult?Casts a box through the world and returns the first hit.
GetGravityAt
Returns the gravity acceleration at the supplied world-space position.
GetPartsInPart
Workspace:GetPartsInPart(part: BasePart, overlapParams: OverlapParams?): { BasePart }Returns Parts overlapping the supplied Part, subject to optional OverlapParams.
OverlapBox
Workspace:OverlapBox(cframe: CFrame, size: Vector3, overlapParams: OverlapParams?): { BasePart }Returns parts overlapping the specified box.
OverlapSphere
Workspace:OverlapSphere(position: Vector3, radius: number, overlapParams: OverlapParams?): { BasePart }Returns parts overlapping a sphere.
Raycast
Workspace:Raycast(origin: Vector3, direction: Vector3, raycastParams: RaycastParams?): RaycastResult?Casts a finite ray and returns the first hit. The direction vector length specifies the cast distance.
Shapecast
Workspace:Shapecast(part: BasePart, direction: Vector3, params: RaycastParams?): RaycastResult?Casts a shape through the world and returns the first hit.
Spherecast
Workspace:Spherecast(position: Vector3, radius: number, direction: Vector3, params: RaycastParams?): RaycastResult?Casts a sphere through the world and returns the first hit.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying
Example
print(workspace.Gravity)
workspace.GravityDirection = Vector3.new(0, -1, 0)