API:Class/Workspace

< API:Class(Redirected from Workspace)
This page is about the type "Workspace" and its members. For the property through which such an object can be obtained, see DataModel.Workspace.
Service: This class is a service. It is a top-level singleton which can be obtained with the GetService method.

Workspace icon.pngWorkspace : Model icon.pngModel : Object Icon.pngPVInstance : Object Icon.pngInstance

The Workspace is where any objects which are rendered in the 3D world exist. Any objects outside of the Workspace will not physically interact with the world.

Properties

PropertiesmemberhiddenProperties [toggle]

boolAllowThirdPartySales

Determines whether assets created by other users can be sold.

|RMD member="API:Class/Workspace/AllowThirdPartySales"|Determines whether assets created by other users can be sold.|/RMD|
Ref<Camera>CurrentCamera

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, all camera objects are removed from the Workspace, including the previous CurrentCamera.

|RMD member="API:Class/Workspace/CurrentCamera"|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, all camera objects are removed from the Workspace, including the previous CurrentCamera.|/RMD|
doubleDistributedGameTime

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

|RMD member="API:Class/Workspace/DistributedGameTime"|The amount of time, in seconds, that the game has been running.|/RMD|
floatGravity

Controls the acceleration of falling objects in ROBLOX.

|RMD member="API:Class/Workspace/Gravity"|Controls the acceleration of falling objects in ROBLOX.|/RMD|
boolPGSPhysicsSolverEnabled [NotAccessibleSecurity]

Toggles whether or not the game should use the new Projected Gauss-Seidel physics solver, or the traditional Spring physics engine.

|RMD member="API:Class/Workspace/PGSPhysicsSolverEnabled"|Toggles whether or not the game should use the new Projected Gauss-Seidel physics solver, or the traditional Spring physics engine.|/RMD|
boolStreamingEnabled

Whether or not place streaming is enabled.

|RMD member="API:Class/Workspace/StreamingEnabled"|Whether or not place streaming is enabled.|/RMD|
Ref<Terrain>Terrain [readonly]

A reference to the Terrain object, which is parented to the Workspace. Ensures that this object is what gets indexed, rather than another object in the Workspace named Terrain.

|RMD member="API:Class/Workspace/Terrain"|A reference to the Terrain object, which is parented to the Workspace. Ensures that this object is what gets indexed, rather than another object in the Workspace named Terrain.|/RMD|
floatFallenPartsDestroyHeight [PluginSecurity]

Sets the height at which falling characters and parts are destroyed. This property can be read by scripts, but can only be written to by plugins, the command bar, or the properties window.

|RMD member="API:Class/Workspace/FallenPartsDestroyHeight"|Sets the height at which falling characters and parts are destroyed. This property can be read by scripts, but can only be written to by plugins, the command bar, or the properties window.|/RMD|
boolFilteringEnabled [PluginSecurity]

Decides if changes from the client should be replicated or not.

|RMD member="API:Class/Workspace/FilteringEnabled"|Decides if changes from the client should be replicated or not.|/RMD|
Determines whether assets created by other users can be sold.
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, all camera objects are removed from the Workspace, including the previous CurrentCamera.
The amount of time, in seconds, that the game has been running.
Controls the acceleration of falling objects in ROBLOX.
PGSPhysicsSolverEnabled [NotAccessibleSecurity]
Toggles whether or not the game should use the new Projected Gauss-Seidel physics solver, or the traditional Spring physics engine.
Whether or not place streaming is enabled.
Terrain [readonly]
A reference to the Terrain object, which is parented to the Workspace. Ensures that this object is what gets indexed, rather than another object in the Workspace named Terrain.
FallenPartsDestroyHeight [PluginSecurity]
Sets the height at which falling characters and parts are destroyed. This property can be read by scripts, but can only be written to by plugins, the command bar, or the properties window.
FilteringEnabled [PluginSecurity]
Decides if changes from the client should be replicated or not.
Inherited from Model icon.pngModel:
Ref<BasePart>PrimaryPart

The object's primary part. When used with Models, it is the part which is positioned with MoveTo and SetPrimaryPartCFrame.

|RMD member="API:Class/Model/PrimaryPart"|The object's primary part. When used with Models, it is the part which is positioned with MoveTo and SetPrimaryPartCFrame.|/RMD|
The object's primary part. When used with Models, it is the part which is positioned with MoveTo and SetPrimaryPartCFrame.
Inherited from Object Icon.pngPVInstance:
CFrameCoordinateFrame [deprecated] [unscriptable] [writeonly]

Deprecated. Do not use.

|RMD member="API:Class/PVInstance/CoordinateFrame"|Deprecated. Do not use.|/RMD|
CoordinateFrame [deprecated] [unscriptable] [writeonly]
Deprecated. Do not use.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Cloned or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Cloned or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
intDataCost [RobloxPlaceSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

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.

|RMD member="API:Class/Instance/RobloxLocked"|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.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Cloned or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
DataCost [RobloxPlaceSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
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.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

BasePart, Vector3, Vector3, MaterialFindPartOnRay ( Ray ray, Instance ignoreDescendantsInstance = nil, bool terrainCellsAreCubes = false, bool ignoreWater = false )

Returns the first part that intersects with a ray.

|RMD member="API:Class/Workspace/FindPartOnRay"|Returns the first part that intersects with a ray.|/RMD|
BasePart, Vector3, Vector3, MaterialFindPartOnRayWithIgnoreList ( Ray ray, array<Instance> ignoreDescendantsTable, bool terrainCellsAreCubes = false, bool ignoreWater = false )

Returns the first part that intersects with a ray which isn't on the given ignore list.

|RMD member="API:Class/Workspace/FindPartOnRayWithIgnoreList"|Returns the first part that intersects with a ray which isn't on the given ignore list.|/RMD|
BasePart, Vector3, Vector3, MaterialFindPartOnRayWithWhitelist ( Ray ray, array<Instance> whitelistDescendantsTable, bool ignoreWater = false )

Returns the first part that intersects with a ray which is on the whitelist.

|RMD member="API:Class/Workspace/FindPartOnRayWithWhitelist"|Returns the first part that intersects with a ray which is on the whitelist.|/RMD|
array<BasePart>FindPartsInRegion3 ( Region3 region, Instance ignoreDescendantsInstance = nil, int maxParts = 20 )

Returns a table filled with parts inside the Region3.

|RMD member="API:Class/Workspace/FindPartsInRegion3"|Returns a table filled with parts inside the Region3.|/RMD|
array<BasePart>FindPartsInRegion3WithIgnoreList ( Region3 region, array<Instance> ignoreDescendantsTable, int maxParts = 20 )

Returns parts in the area defined by the Region3 (which aren't in the given IgnoreList), up to the specified maxParts or 100, whichever is less.

|RMD member="API:Class/Workspace/FindPartsInRegion3WithIgnoreList"|Returns parts in the area defined by the Region3 (which aren't in the given IgnoreList), up to the specified maxParts or 100, whichever is less.|/RMD|
array<BasePart>FindPartsInRegion3WithWhiteList ( Region3 region, array<Instance> whitelistDescendantsTable, int maxParts = 20 )

Returns an array of parts in the area defined by the Region3, but only parts that have been defined in the whitelist will be added to the list.

|RMD member="API:Class/Workspace/FindPartsInRegion3WithWhiteList"|Returns an array of parts in the area defined by the Region3, but only parts that have been defined in the whitelist will be added to the list.|/RMD|
intGetNumAwakeParts ( )

The amount of physical active parts.

|RMD member="API:Class/Workspace/GetNumAwakeParts"|The amount of physical active parts.|/RMD|
intGetPhysicsThrottling ( )

The maximum amount of physics FPS.

|RMD member="API:Class/Workspace/GetPhysicsThrottling"|The maximum amount of physics FPS.|/RMD|
doubleGetRealPhysicsFPS ( )

Returns the number of frames per second that physics are being simulated at.

|RMD member="API:Class/Workspace/GetRealPhysicsFPS"|Returns the number of frames per second that physics are being simulated at.|/RMD|
boolIsRegion3Empty ( Region3 region, Instance ignoreDescendentsInstance = nil )

Returns a bool stating if there are no parts inside Region3.

|RMD member="API:Class/Workspace/IsRegion3Empty"|Returns a bool stating if there are no parts inside Region3.|/RMD|
boolIsRegion3EmptyWithIgnoreList ( Region3 region, array<Instance> ignoreDescendentsTable )

Returns a bool stating if there are no parts inside the given Region3 which aren't in the given ignoreDescendentsTable.

|RMD member="API:Class/Workspace/IsRegion3EmptyWithIgnoreList"|Returns a bool stating if there are no parts inside the given Region3 which aren't in the given ignoreDescendentsTable.|/RMD|
voidJoinToOutsiders ( array<Instance> objects, JointCreationMode jointType )

Creates joints between the parts in the table and touching parts based on the touching surface types and JointCreationMode. See Joint creation for which types of joints will be created.

|RMD member="API:Class/Workspace/JoinToOutsiders"|Creates joints between the parts in the table and touching parts based on the touching surface types and JointCreationMode. See Joint creation for which types of joints will be created.|/RMD|
boolPGSIsEnabled ( )

Returns true if the game has the PGS Physics Solver enabled.

|RMD member="API:Class/Workspace/PGSIsEnabled"|Returns true if the game has the PGS Physics Solver enabled.|/RMD|
voidUnjoinFromOutsiders ( array<Instance> objects )

Breaks all joints between the parts in the provided table and parts not in the table. Does not break joints between parts inside the table.

|RMD member="API:Class/Workspace/UnjoinFromOutsiders"|Breaks all joints between the parts in the provided table and parts not in the table. Does not break joints between parts inside the table.|/RMD|
voidBreakJoints ( array<Instance> objects ) [PluginSecurity]

Breaks any surface connection with any adjacent part, including Welds and other JointInstances.

|RMD member="API:Class/Workspace/BreakJoints"|Breaks any surface connection with any adjacent part, including Welds and other JointInstances.|/RMD|
boolExperimentalSolverIsEnabled ( ) [LocalUserSecurity]

Returns true if the experimental physics solver is enabled.

|RMD member="API:Class/Workspace/ExperimentalSolverIsEnabled"|Returns true if the experimental physics solver is enabled.|/RMD|
boolGetPhysicsAnalyzerBreakOnIssue ( ) [PluginSecurity]

Returns true if the game has been paused due to over-constrained parts being detected by the Physics Analyzer.

|RMD member="API:Class/Workspace/GetPhysicsAnalyzerBreakOnIssue"|Returns true if the game has been paused due to over-constrained parts being detected by the Physics Analyzer.|/RMD|
array<BasePart>GetPhysicsAnalyzerIssue ( int index ) [PluginSecurity]

Returns an array of parts that are over-constraining each other.

|RMD member="API:Class/Workspace/GetPhysicsAnalyzerIssue"|Returns an array of parts that are over-constraining each other.|/RMD|
voidMakeJoints ( array<Instance> objects ) [PluginSecurity]

Creates a joint on any side of the object that has a surface ID that can make a joint.

|RMD member="API:Class/Workspace/MakeJoints"|Creates a joint on any side of the object that has a surface ID that can make a joint.|/RMD|
voidSetPhysicsAnalyzerBreakOnIssue ( bool enable ) [PluginSecurity]

Sets whether or not the Physics Analyzer should continue to actively analyze the physics or not.

When using GetPhysicsAnalyzerIssue, you should enable this.

|RMD member="API:Class/Workspace/SetPhysicsAnalyzerBreakOnIssue"|Sets whether or not the Physics Analyzer should continue to actively analyze the physics or not.

When using GetPhysicsAnalyzerIssue, you should enable this.|/RMD|

voidSetPhysicsThrottleEnabled ( bool value ) [LocalUserSecurity]

Sets whether Physics Throttling is enabled or disabled.

|RMD member="API:Class/Workspace/SetPhysicsThrottleEnabled"|Sets whether Physics Throttling is enabled or disabled.|/RMD|
voidZoomToExtents ( ) [PluginSecurity]

Zooms the CurrentCamera all the way out. It is used in the "Zoom To Extents" button.

|RMD member="API:Class/Workspace/ZoomToExtents"|Zooms the CurrentCamera all the way out. It is used in the "Zoom To Extents" button.|/RMD|
TuplefindPartOnRay ( Ray ray, Instance ignoreDescendantsInstance = nil, bool terrainCellsAreCubes = false, bool ignoreWater = false ) [deprecated]

Deprecated in favor of FindPartOnRay.

|RMD member="API:Class/Workspace/findPartOnRay"|Deprecated in favor of FindPartOnRay.|/RMD|
array<Instance>findPartsInRegion3 ( Region3 region, Instance ignoreDescendantsInstance = nil, int maxParts = 20 ) [deprecated]

Deprecated in favor of FindPartsInRegion3.

|RMD member="API:Class/Workspace/findPartsInRegion3"|Deprecated in favor of FindPartsInRegion3.|/RMD|
FindPartOnRay ( Ray ray, Instance ignoreDescendantsInstance = nil, bool terrainCellsAreCubes = false, bool ignoreWater = false )
Returns the first part that intersects with a ray.
FindPartOnRayWithIgnoreList ( Ray ray, array<Instance> ignoreDescendantsTable, bool terrainCellsAreCubes = false, bool ignoreWater = false )
Returns the first part that intersects with a ray which isn't on the given ignore list.
FindPartOnRayWithWhitelist ( Ray ray, array<Instance> whitelistDescendantsTable, bool ignoreWater = false )
Returns the first part that intersects with a ray which is on the whitelist.
FindPartsInRegion3 ( Region3 region, Instance ignoreDescendantsInstance = nil, int maxParts = 20 )
Returns a table filled with parts inside the Region3.
FindPartsInRegion3WithIgnoreList ( Region3 region, array<Instance> ignoreDescendantsTable, int maxParts = 20 )
Returns parts in the area defined by the Region3 (which aren't in the given IgnoreList), up to the specified maxParts or 100, whichever is less.
FindPartsInRegion3WithWhiteList ( Region3 region, array<Instance> whitelistDescendantsTable, int maxParts = 20 )
Returns an array of parts in the area defined by the Region3, but only parts that have been defined in the whitelist will be added to the list.
The amount of physical active parts.
The maximum amount of physics FPS.
Returns the number of frames per second that physics are being simulated at.
IsRegion3Empty ( Region3 region, Instance ignoreDescendentsInstance = nil )
Returns a bool stating if there are no parts inside Region3.
IsRegion3EmptyWithIgnoreList ( Region3 region, array<Instance> ignoreDescendentsTable )
Returns a bool stating if there are no parts inside the given Region3 which aren't in the given ignoreDescendentsTable.
Creates joints between the parts in the table and touching parts based on the touching surface types and JointCreationMode. See Joint creation for which types of joints will be created.
Returns true if the game has the PGS Physics Solver enabled.
Breaks all joints between the parts in the provided table and parts not in the table. Does not break joints between parts inside the table.
BreakJoints ( array<Instance> objects ) [PluginSecurity]
Breaks any surface connection with any adjacent part, including Welds and other JointInstances.
ExperimentalSolverIsEnabled ( ) [LocalUserSecurity]
Returns true if the experimental physics solver is enabled.
GetPhysicsAnalyzerBreakOnIssue ( ) [PluginSecurity]
Returns true if the game has been paused due to over-constrained parts being detected by the Physics Analyzer.
GetPhysicsAnalyzerIssue ( int index ) [PluginSecurity]
Returns an array of parts that are over-constraining each other.
MakeJoints ( array<Instance> objects ) [PluginSecurity]
Creates a joint on any side of the object that has a surface ID that can make a joint.
SetPhysicsAnalyzerBreakOnIssue ( bool enable ) [PluginSecurity]
Sets whether or not the Physics Analyzer should continue to actively analyze the physics or not. When using GetPhysicsAnalyzerIssue, you should enable this.
SetPhysicsThrottleEnabled ( bool value ) [LocalUserSecurity]
Sets whether Physics Throttling is enabled or disabled.
ZoomToExtents ( ) [PluginSecurity]
Zooms the CurrentCamera all the way out. It is used in the "Zoom To Extents" button.
findPartOnRay ( Ray ray, Instance ignoreDescendantsInstance = nil, bool terrainCellsAreCubes = false, bool ignoreWater = false ) [deprecated]
Deprecated in favor of FindPartOnRay.
findPartsInRegion3 ( Region3 region, Instance ignoreDescendantsInstance = nil, int maxParts = 20 ) [deprecated]
Deprecated in favor of FindPartsInRegion3.
Inherited from Model icon.pngModel:
Vector3GetExtentsSize ( )

Returns the size of the smallest bounding box that contains all of the Parts in the Model.

|RMD member="API:Class/Model/GetExtentsSize"|Returns the size of the smallest bounding box that contains all of the Parts in the Model.|/RMD|
CFrameGetPrimaryPartCFrame ( )

Returns the CFrame of the Model's PrimaryPart.

|RMD member="API:Class/Model/GetPrimaryPartCFrame"|Returns the CFrame of the Model's PrimaryPart.|/RMD|
voidMakeJoints ( )

Goes through all parts contained in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint.

|RMD member="API:Class/Model/MakeJoints"|Goes through all parts contained in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint.|/RMD|
voidMoveTo ( Vector3 position )

Moves the center of the PrimaryPart to the given position.

|RMD member="API:Class/Model/MoveTo"|Moves the center of the PrimaryPart to the given position.|/RMD|
voidSetPrimaryPartCFrame ( CFrame cframe )

Sets the CFrame of the PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the PrimaryPart.

|RMD member="API:Class/Model/SetPrimaryPartCFrame"|Sets the CFrame of the PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the PrimaryPart.|/RMD|
voidTranslateBy ( Vector3 delta )

Shifts a model using a given offset.

|RMD member="API:Class/Model/TranslateBy"|Shifts a model using a given offset.|/RMD|
CFrameGetModelCFrame ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/GetModelCFrame"|Deprecated. Do not use.|/RMD|
Vector3GetModelSize ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/GetModelSize"|Deprecated. Do not use.|/RMD|
voidResetOrientationToIdentity ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/ResetOrientationToIdentity"|Deprecated. Do not use.|/RMD|
voidSetIdentityOrientation ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Model/SetIdentityOrientation"|Deprecated. Do not use.|/RMD|
voidbreakJoints ( ) [deprecated]

Deprecated in favor of BreakJoints.

|RMD member="API:Class/Model/breakJoints"|Deprecated in favor of BreakJoints.|/RMD|
voidmakeJoints ( ) [deprecated]

Deprecated in favor of MakeJoints.

|RMD member="API:Class/Model/makeJoints"|Deprecated in favor of MakeJoints.|/RMD|
voidmove ( Vector3 location ) [deprecated]

Deprecated in favor of MoveTo.

|RMD member="API:Class/Model/move"|Deprecated in favor of MoveTo.|/RMD|
voidmoveTo ( Vector3 location ) [deprecated]

Deprecated in favor of MoveTo.

|RMD member="API:Class/Model/moveTo"|Deprecated in favor of MoveTo.|/RMD|
Returns the size of the smallest bounding box that contains all of the Parts in the Model.
Returns the CFrame of the Model's PrimaryPart.
Goes through all parts contained in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint.
MoveTo ( Vector3 position )
Moves the center of the PrimaryPart to the given position.
Sets the CFrame of the PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the PrimaryPart.
Shifts a model using a given offset.
GetModelCFrame ( ) [deprecated]
Deprecated. Do not use.
GetModelSize ( ) [deprecated]
Deprecated. Do not use.
Deprecated. Do not use.
SetIdentityOrientation ( ) [deprecated]
Deprecated. Do not use.
breakJoints ( ) [deprecated]
Deprecated in favor of BreakJoints.
makeJoints ( ) [deprecated]
Deprecated in favor of MakeJoints.
move ( Vector3 location ) [deprecated]
Deprecated in favor of MoveTo.
moveTo ( Vector3 location ) [deprecated]
Deprecated in favor of MoveTo.
Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

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

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
Removes all descendants of the object.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.


Events

EventsmemberhiddenEvents [toggle]

PhysicsAnalyzerIssuesFound ( int count ) [PluginSecurity]

Fires when over-constraint issues are found in the Physics Analyzer.

|RMD member="API:Class/Workspace/PhysicsAnalyzerIssuesFound"|Fires when over-constraint issues are found in the Physics Analyzer.|/RMD|
PhysicsAnalyzerIssuesFound ( int count ) [PluginSecurity]
Fires when over-constraint issues are found in the Physics Analyzer.
Inherited from Object Icon.pngInstance:
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.


Filtered Tag Debug Info:

hidden = 1

LocalUserSecurity = 1

RobloxPlaceSecurity = 1

deprecated = 1

PluginSecurity = 1

RobloxScriptSecurity = 2

RobloxSecurity = 2|RMD member="API:Class/Workspace"|The Workspace is where any objects which are rendered in the 3D world exist. Any objects outside of the Workspace will not physically interact with the world. |/RMD|


Notes

  • It is impossible to delete the Workspace
  • There is a global variable, workspace, which can be used to access the Workspace:
print(workspace)
--> Workspace