Workspace is the root of the place hierarchy.
Parts, Models, and other Instances live under Workspace.
Inherits Instance.
Available as the globals workspace and Workspace.
On LocalScripts, lookup is read-only: child Models/Parts by name, plus FindFirstChild, GetChildren, and WaitForChild. GetPlayers and AutoTween are server-only.
Overview
Properties
- .Name readonly : string
- .ClassName readonly : string
- .Parent readonly : nil
- .AutoTween : bool
- .AllowMelee : bool
- .AllowRanged : bool
- .AllowDestructive : bool
- .AllowStealth : bool
- .AllowBuilding : bool
- .AllowConsumable : bool
Methods
- :GetPlayers() : List of Players
- :FindByName(name: string) : Instance? deprecated
Also inherits Instance methods.
Events
Inherits Instance events.
API
Properties
Name
Name readonly : string
Always "Workspace".
ClassName
ClassName readonly : string
Always "Workspace".
Parent
Parent readonly : nil
Workspace has no parent.
AutoTween
AutoTween : bool
When true, small direct writes to Part Position, Color, Size, and Transparency tween to clients instead of snapping.
Defaults to true on places created before the TweenModule cutoff, and false on newer places.
Set workspace.AutoTween = false on an older place to opt into TweenModule-only interpolation.
Setting this true on a newer place has no effect.
AllowMelee
AllowMelee : bool
When false, catalog Melee gears (Sword) are not given on join. Place starter tools and Player:GiveTool are unchanged. Default true.
AllowRanged
AllowRanged : bool
When false, catalog Ranged gears (Superball, Slingshot, Paintball Gun) are not given on join. Default true.
AllowDestructive
AllowDestructive : bool
When false, catalog Destructive gears (Rocket Launcher, Time Bomb) are not given on join. Default true.
AllowStealth
AllowStealth : bool
When false, catalog Stealth gears (Invisiball) are not given on join. Default true.
AllowBuilding
AllowBuilding : bool
When false, catalog Building gears (Trowel) are not given on join. Default true.
AllowConsumable
AllowConsumable : bool
When false, catalog Consumable gears (Poly Soda, Cheeseburger) are not given on join. Default true.
workspace.AllowDestructive = false
workspace.AllowMelee = false
-- Ranged and Stealth catalog gears still come in with the player.These also exist on game. Studio Game properties persist them in place XML.
Methods
GetPlayers
GetPlayers() : List of Players
Returns every player currently in the place.
Prefer `Players:GetPlayers`. This method remains for compatibility.
FindByName
FindByName(name: string) : Instance? deprecated
Searches the whole place for an Instance with the given name.
Prefer `FindFirstChild` on a known parent.
No longer recommended for use.
