Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.- Memory category
- BaseParts
- Own members
- 89
- Inherited members
- 160
- Subclasses
- 0
- Siblings
- 2
Properties115
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Property categoryPivot
- Editor-only property that displays and edits the pivot's
CFramerelative to the instance, moving only the pivot and leaving the instance in place.
Property categoryTransform
- Editor-only property that reads and sets the world
CFrameof thePVInstance's pivot, moving the entire instance when changed from the Studio Properties window.
Property categoryAppearance
- Sets the level of detail on the model for experiences with instance streaming enabled.
Property categoryBehavior
- Controls the model streaming behavior on
Modelswhen instance streaming is enabled.
Property categoryData
Model.ModelMeshCFrame: CFrame = CFrame.identity Model.ModelMeshSize: Vector3 = Vector3.zero Model.NeedsPivotMigration: boolean = false
Property categoryPivot
- The primary part of the
Model, ornilif not explicitly set. - Editor-only property used to scale the model around its pivot. Setting this property will move the scale as though
Model:ScaleTo()was called on it. Model.ScaleFactor: number = 1 Model.WorldPivot: CFrame = CFrame.identity Determines where the pivot of aModelwhich does not have a setModel.PrimaryPartis located.
Defined byWorkspace69
Property categoryAirProperties
Workspace.AirDensity: number The air density at ground level, used in the aerodynamic force model.Workspace.AirTurbulenceIntensity: number Controls the strength of turbulence present in the wind velocity field, affecting the aerodynamic force model.Workspace.GlobalWind: Vector3 Specifies the global wind vector for animated terrain grass, dynamic clouds, and particles.
Property categoryBehavior
Workspace.AllowThirdPartySales: boolean Determines whether assets created by other users can be sold in the game.Workspace.AvatarUnificationMode: Enum.AvatarUnificationMode Enables the R6 to R15 adapter, allowing R15 avatars to join R6 experiences.Workspace.ClientAnimatorThrottling: Enum.ClientAnimatorThrottlingMode Specifies the animation throttling mode for the local client.Workspace.CollisionGroups: string Workspace.DataModelPlaceVersion: number Workspace.ExpandedTerrain: Enum.RolloutState Workspace.ExplicitAutoJoints: boolean Workspace.FallenPartsDestroyHeight: number Determines the height at which fallingBasePartsand their ancestorModelsare removed fromWorkspace.Workspace.FallHeightEnabled: boolean Controls whether parts that fall belowWorkspace.FallenPartsDestroyHeightare automatically destroyed.Workspace.FluidForces: Enum.FluidForces Determines whether the physics engine computes aerodynamic forces onBasePartswhoseEnableFluidForcesproperty is true.Workspace.Gravity: number Determines the acceleration due to gravity applied to fallingBaseParts.Workspace.IKControlConstraintSupport: Enum.IKControlConstraintSupport Enables support for constraints for IKControls. If disabled, IKControls ignore physics constraints.Workspace.ImprovedAnimationConstraint: Enum.RolloutState Controls whether improved behavior is enabled forAnimationConstraints.Workspace.ImprovedPhysicsReplication: Enum.RolloutState Controls whether the experience uses the improved physics replication path between the server and clients.Workspace.LayeredClothingCacheOptimizations: Enum.RolloutState Controls whether layered clothing cache optimizations are enabled.Workspace.MapTVRemoteToGamepadKeycodes: Enum.RolloutState Workspace.MeshPartHeadsAndAccessories: Enum.MeshPartHeadsAndAccessories Sets whether character Heads and Accessories should be downloaded as MeshParts.Workspace.MeshStreamingAndImprovedLods: Enum.RolloutState Controls whether the experience uses the new mesh streaming and improved LOD system.Workspace.NextGenerationReplication: Enum.RolloutState Whentrue, enables an alternate replication system that alters and improves how properties are replicated under the hood.Workspace.PathfindingUseImprovedSearch: Enum.PathfindingUseImprovedSearch Controls whether an improved search algorithm is used byPathfindingService.Workspace.PhysicsSteppingMethod: Enum.PhysicsSteppingMethod Sets how the solver will advance the physics simulation forward in time.Workspace.PlayerCharacterDestroyBehavior: Enum.PlayerCharacterDestroyBehavior Workspace.PlayerScriptsUseInputActionSystem: Enum.RolloutState Controls whether the built-in player scripts are updated to use the Input Action System.Workspace.PrimalPhysicsSolver: Enum.PrimalPhysicsSolver Controls whether the experimental Primal Physics Solver is enabled.Workspace.RenderingCacheOptimizations: Enum.RenderingCacheOptimizationMode Controls whether rendering cache optimizations are enabled.Workspace.ReplicateInstanceDestroySetting: Enum.ReplicateInstanceDestroySetting Controls howInstance:Destroy()calls are replicated from the server to clients.Workspace.ReplicationFrequency: Enum.ReplicationMode Workspace.ReplicationThroughput: Enum.ReplicationMode Workspace.Retargeting: Enum.AnimatorRetargetingMode Controls whether animation retargeting is enabled for character animations.Workspace.SignalBehavior: Enum.SignalBehavior Configures when the engine resumes event handlers.Workspace.SignalBehavior2: Enum.SignalBehavior Workspace.Terrain: Terrain Workspace.TerrainWeldsFixed: boolean Workspace.ThrottleLevel: number Workspace.TouchesUseCollisionGroups: boolean Determines whetherpartsin different groups set to not collide will ignore collisions and touch events.Workspace.TouchEventsUseCollisionGroups: Enum.RolloutState Workspace.UseFixedSimulation: Enum.RolloutState Whentrue, enablesRunService:BindToSimulation()which calls a function at a fixed frequency, updates physics stepping logic, and makes thetime()function return the fixed stepped frame time.Workspace.UseInputSink: Enum.RolloutState Workspace.ValidateEnabledProximityPrompt: Enum.RolloutState Workspace.WatermarkHash: string Workspace.FilteringEnabled: boolean Deprecated: This property is discontinued.
Determines whether changes made from the client will replicate to the server or not.Workspace.InterpolationThrottling: Enum.InterpolationThrottlingMode Deprecated: This property should not be used for new work.
Deprecated setting that configured the interpolation throttling mode; it no longer takes effect.
Property categoryData
Workspace.CurrentCamera: Camera TheCameraobject being used by the local player.Workspace.DistributedGameTime: number The amount of time, in seconds, that the game has been running.Workspace.InsertPoint: Vector3 The world position at which new objects are placed when inserted from the toolbox.Workspace.StreamingEnabledStorage: boolean
Property categoryNetworking
Workspace.RejectCharacterDeletions: Enum.RejectCharacterDeletions Controls whether the server rejects attempts by clients to delete player characters from the workspace.
Property categoryPermissions
Workspace.SandboxedInstanceMode: Enum.SandboxedInstanceMode Controls whether sandboxed instance mode (script capabilities) is enabled.
Property categoryScripting
Workspace.LuauTypeCheckMode: Enum.LuauTypeCheckMode Sets the Luau type checking mode for scripts in the experience.Workspace.UseNewLuauTypeSolver: Enum.RolloutState Controls whether the new Luau type solver is used for type inference.
Property categoryServer Authority
Workspace.AuthorityMode: Enum.AuthorityMode Sets the server authority mode.Workspace.NextGenerationReplicationAlias: Enum.RolloutState Workspace.PlayerScriptsUseInputActionSystemAlias: Enum.RolloutState Workspace.SignalBehaviorAlias: Enum.SignalBehavior Workspace.StreamingEnabledAlias: boolean Workspace.UseFixedSimulationAlias: Enum.RolloutState
Property categoryStreaming
Workspace.EnableSLIMAvatars: Enum.RolloutState Controls whether SLIM rendering is used for avatars in the experience.Workspace.ModelStreamingBehavior: Enum.ModelStreamingBehavior Controls howModelsare replicated in experiences when instance streaming is enabled.Workspace.PredictiveStreamingMode: Enum.PredictiveStreamingMode Controls whether the engine can make predictive streaming decisions.Workspace.StreamingAdaptiveRadius: boolean Workspace.StreamingEnabled: boolean Whether content streaming is enabled for the place.Workspace.StreamingIntegrityMode: Enum.StreamingIntegrityMode Determines whether streaming integrity mode is active.Workspace.StreamingMinRadius: number Minimum distance that content will be streamed to players with high priority.Workspace.StreamingPauseMode: Enum.StreamingPauseMode Workspace.StreamingTargetRadius: number Maximum distance that content will be streamed to players.Workspace.StreamOutBehavior: Enum.StreamOutBehavior Configures how the engine decides when to stream content away from players.
No properties match the filters.
Methods121
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
- Gets the pivot of a
PVInstance. PVInstance:PivotTo( targetCFrame: CFrame) Transforms thePVInstancealong with all of its descendantPVInstancessuch that the pivot is now located at the specifiedCFrame.Parameters Parameter Description targetCFrame: CFrameTheCFramethat thePVInstancepivot should equal after moving it.
Model:AddPersistentPlayer( playerInstance: Player? = nil) Sets this model to be persistent for the specified player.ModelStreamingModemust be set toPersistentPerPlayerfor behavior to be changed as a result of addition.Model:GetBoundingBox( ): (CFrame, Vector3) Returns a description of a volume that contains all parts of a Model.- Returns the size of the smallest bounding box that contains all of the
BasePartsin theModel, aligned with theModel.PrimaryPartif it is set. - Returns all the
Playerobjects that this model object is persistent for. Behavior varies based on whether this method is called from aScriptor aLocalScript.Returns Type Description { Instance }A table with all thePlayerobjects that this model object is persistent for. - Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via
Model:ScaleTo().Returns Type Description numberThe current canonical scale factor of the model. - Moves the
PrimaryPartto the given position. If a primary part has not been specified, the root part of the model will be used. Model:RemovePersistentPlayer( playerInstance: Player? = nil) Makes this model no longer persistent for the specified player.ModelStreamingModemust be set toPersistentPerPlayerfor behavior to be changed as a result of removal.- Sets the scale factor of the model, adjusting the sizing and location of all descendant Instances such that they have that scale factor relative to their initial sizes and locations when scale factor was 1.
Parameters Parameter Description newScaleFactor: numberThe new scale factor for the model, which must be a positive non-zero number. A value of 1 represents the model's original size. Model:TranslateBy( delta: Vector3) - Deprecated:
Breaks connections betweenBaseParts, including surface connections with any adjacent parts,WeldConstraintsand allWeldsand otherJointInstances. - Deprecated: This function has been deprecated as it did not provide reliable results. You can instead use
Model:GetPrimaryPartCFrame()to retrieve theCFrameof the model's primary part.
This value historically returned the CFrame of a central position in the model.Use GetPrimaryPartCFrame instead.
- Deprecated: This item is deprecated. Do not use it for new work. Developers can instead use
Model.GetExtentsSize.
Returns the Vector3 size of the Model.Use GetExtentsSize instead.
- Deprecated:
Returns theCFrameof the model'sModel.PrimaryPart. This function will throw an error if no primary part exists for theModel.Returns Type Description CFrameTheCFrameof the model'sModel.PrimaryPart.Use GetPivot instead.
- Deprecated: This joint type has been deprecated. Don't use it for new work. Use
WeldConstraintsandHingeConstraintsinstead.
Goes through allBasePartsin theModel. If any part's side has a SurfaceType that can make a joint it will create a joint with any adjacent parts. - Deprecated: This function has been deprecated; it remains to prevent legacy scripts from throwing errors, but it does nothing when called.
Resets the rotation of the model's parts to the previously set identity rotation, which is done through theModel:SetIdentityOrientation()method.Use SetPrimaryPartCFrame instead.
- Deprecated: This function has been deprecated; it remains to prevent legacy scripts from throwing errors, but it does nothing when called.
Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of theResetOrientationToIdentitymethod.Use SetPrimaryPartCFrame instead.
Model:SetPrimaryPartCFrame( cframe: CFrame) Deprecated:
Sets theBasePart.CFrameof the model'sModel.PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to theModel.PrimaryPart.Use PivotTo instead.
- Deprecated: This deprecated function is a variant of
Model:BreakJoints()which should be used instead.Use BreakJoints instead.
- Deprecated: This deprecated function is a variant of
Model:MakeJoints()which should be used instead.Use MakeJoints instead.
- Deprecated: This item has been superseded by
Model:MoveTo()which should be used in all new workParameters Parameter location: Vector3Use MoveTo instead.
- Deprecated: This deprecated function is a variant of
Model:MoveTo()which should be used instead.Parameters Parameter location: Vector3Use MoveTo instead.
WorldRoot:ArePartsTouchingOthers(partList: { Instance },overlapIgnored: number? = 0.000199999995,): boolean Returns true if any of the givenBasePartare touching any other parts.Parameters Parameter Description partList: { Instance }A list of parts checks to see if any parts in the list are touching any parts not in the list.overlapIgnored: number? = 0.000199999995The part overlap threshold in studs that is ignored before parts are considered to be touching.Returns Type Description booleanTrue if and only if any of thepartsinpartListare touching any other parts (parts not in the partList). False if no parts are passed.WorldRoot:Blockcast(cframe: CFrame,size: Vector3,direction: Vector3,params: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},): RaycastResult? Casts a block shape in a given direction and returns aRaycastResultif the shape hits aBasePartorTerraincell.Parameters Parameter Description cframe: CFrameThe initial position and rotation of the cast block shape.size: Vector3The size of the cast block shape in studs. The maximum size is 512 studs.direction: Vector3Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs.params: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}An object used to specify hit eligibility in the shapecast operation. If not provided, default values are used where all parts are considered andTerrainwater is not ignored.Returns Type Description RaycastResult?WorldRoot:BulkMoveTo(partList: { Instance },cframeList: { any },eventMode: Enum.BulkMoveMode? = Enum.BulkMoveMode.FireAllEvents,) Moves an array ofBasePartsto an array ofCFrames.Parameters Parameter Description partList: { Instance }An array ofBasePartsto be moved. Each entry is matched by index to the corresponding entry incframeList.cframeList: { any }An array ofCFramesthat the parts will be moved to, matched by index topartList. Both arrays must be the same length.eventMode: Enum.BulkMoveMode? = Enum.BulkMoveMode.FireAllEventsAnBulkMoveModeenum specifying whichChangedevents fire during the move. Default isFireAllEvents.Returns Type stringParameters Parameter id: stringReturns Type booleanWorldRoot:CollisionGroupsAreCollidable( name1: string, name2: string): boolean Returns whether the two groups will collide in this world.Returns Type booleanWorldRoot:CollisionGroupSetCollidable(name1: string,name2: string,collidable: boolean,) Sets the collision status between two groups in this world.Returns Type { any }Returns Type { any }Returns Type { any }Returns Type { Instance }- Returns the maximum number of collision groups in this world.
Returns Type number WorldRoot:GetPartBoundsInBox(cframe: CFrame,size: Vector3,overlapParams: OverlapParams? = OverlapParams{MaxParts=0, Tolerance=0, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},): { Instance } Returns an array of parts whose bounding boxes overlap a given box.Parameters Parameter Description cframe: CFrameThe location of the center of the given box volume to be queried.size: Vector3The size of the given box volume to be queried.overlapParams: OverlapParams? = OverlapParams{MaxParts=0, Tolerance=0, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}Contains reusable portions of the spatial query parameters.Returns Type Description { Instance }An array ofBasePartswhich matched the spatial query.WorldRoot:GetPartBoundsInRadius(position: Vector3,radius: number,overlapParams: OverlapParams? = OverlapParams{MaxParts=0, Tolerance=0, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},): { Instance } Returns an array of parts whose bounding boxes overlap a given sphere.Parameters Parameter Description position: Vector3The location of the center of the given sphere volume to be queried.radius: numberThe radius of the given sphere volume to be queried.overlapParams: OverlapParams? = OverlapParams{MaxParts=0, Tolerance=0, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}Contains reusable portions of the spatial query parameters.Returns Type Description { Instance }An array ofBasePartswhich matched the spatial query.WorldRoot:GetPartsInPart(part: BasePart,overlapParams: OverlapParams? = OverlapParams{MaxParts=0, Tolerance=0, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},): { Instance } Returns an array of parts whose occupied space is shared with the given part.Parameters Parameter Description part: BasePartThe part whose volume is to be checked against other parts.overlapParams: OverlapParams? = OverlapParams{MaxParts=0, Tolerance=0, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}Contains reusable portions of the spatial query parameters.Returns Type Description { Instance }An array ofBasePartswhich matched the spatial query.- Returns a table with info on all of this world's collision groups.
Returns Type { any } WorldRoot:IKMoveTo(part: BasePart,target: CFrame,translateStiffness: number? = 0.5,rotateStiffness: number? = 0.5,collisionsMode: Enum.IKCollisionsMode? = Enum.IKCollisionsMode.OtherMechanismsAnchored,) Moves the specified part to the specified location via inverse kinematics rather than moving it there directly, to ensure any joints, constraints, or collisions that part is participating in remain physically satisfied.Parameters Parameter Description part: BasePartThe part being moved.target: CFrameThe location to move the specified part.translateStiffness: number? = 0.5A number between 0 and 1 specifying how aggressively to match the part's position to the position part of the targetCFrame.rotateStiffness: number? = 0.5A number between 0 and 1 specifying how aggressively to match the part's rotation to the rotation part of the targetCFrame.collisionsMode: Enum.IKCollisionsMode? = Enum.IKCollisionsMode.OtherMechanismsAnchoredAllows you to specify what objects should be effected by the physical resolution.- Checks if a collision group is registered in this world.
Parameters Parameter name: stringReturns Type boolean WorldRoot:Raycast(origin: Vector3,direction: Vector3,raycastParams: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},): RaycastResult? Casts a ray using an origin, direction, and optionalRaycastParams, then returns aRaycastResultif an eligible object or terrain intersects the ray.Parameters Parameter Description origin: Vector3The origin point of the ray.direction: Vector3The directional vector of the ray. Note that the length of this vector matters, as parts/terrain further away than its length will not be tested.raycastParams: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}An object used to specify hit eligibility in the raycast operation. If not provided, default values are used where all parts are considered andTerrainwater is not ignored.Returns Type Description RaycastResult?WorldRoot:RaycastCachedTerrain(id: string,origin: Vector3,direction: Vector3,ignoreWater: boolean,): RaycastResult? Returns Type RaycastResult?- Registers a new collision group in this world with the given name.
Parameters Parameter name: string WorldRoot:RenameCollisionGroup( from: string, to: string) Renames specified collision group in this world.WorldRoot:SetInsertPoint( point: Vector3) Parameters Parameter point: Vector3WorldRoot:Shapecast(part: BasePart,direction: Vector3,params: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},cframeOverride: CFrame? = nil,sizeOverride: Vector3? = nil,): RaycastResult? Casts the shape of a givenBasePartin a direction and returns aRaycastResultif the shape hits aBasePartorTerraincell.Parameters Parameter Description part: BasePartThe part whose shape is cast. The cast uses this part's geometry (block, ball, mesh, and so on) and size; excessively large parts may not be supported, and it cannot be aTerrainpart.direction: Vector3Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs.params: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}An object used to specify hit eligibility in the shapecast operation. If not provided, default values are used where all other parts are considered andTerrainwater is not ignored. The part being cast is always excluded from the results.cframeOverride: CFrame? = nilsizeOverride: Vector3? = nilReturns Type Description RaycastResult?Parameters Parameter dt: numberWorldRoot:Spherecast(position: Vector3,radius: number,direction: Vector3,params: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},): RaycastResult? Casts a spherical shape in a given direction and returns aRaycastResultif the shape hits aBasePartorTerraincell.Parameters Parameter Description position: Vector3The initial position of the cast spherical shape.radius: numberThe radius of the cast spherical shape in studs. The maximum radius is 256 studs.direction: Vector3Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs.params: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}An object used to specify hit eligibility in the shapecast operation. If not provided, default values are used where all parts are considered andTerrainwater is not ignored.Returns Type Description RaycastResult?WorldRoot:StepPhysics( dt: number, parts: { Instance }? = {}) Advances the simulation for parts in the world forward based on a specified time increment and an optional set ofBaseParts.Parameters Parameter Description dt: numberThe amount of time that will be simulated. This argument must be a positive number. Larger values will increase the runtime of this function.parts: { Instance }? = {}Optional array of parts that will be simulated. This set must contain instances that are of typeBasePart; any other types will be ignored.- Unregisters the collision group for the given name in this world.
Parameters Parameter name: string WorldRoot:FindPartOnRay(ray: Ray,ignoreDescendantsInstance: Instance? = nil,terrainCellsAreCubes: boolean? = false,ignoreWater: boolean? = false,): ...any Deprecated: This function has been deprecated. UseWorldRoot:Raycast()along withRaycastParamsfor new work.
Returns the firstBasePartorTerraincell intersecting with the givenRay.Parameters Parameter Description ray: RayARaywhose origin and direction define the raycast.ignoreDescendantsInstance: Instance? = nilAnInstancewhose descendants are ignored in the raycast.terrainCellsAreCubes: boolean? = falseWhetherTerraincells are treated as full cubes when calculating intersection. Default is false.ignoreWater: boolean? = falseWhetherTerrainwater cells are ignored by the ray. Default is false.Returns Type Description ...anyUse Raycast instead.
WorldRoot:FindPartOnRayWithIgnoreList(ray: Ray,ignoreDescendantsTable: { Instance },terrainCellsAreCubes: boolean? = false,ignoreWater: boolean? = false,): ...any Deprecated: This function has been deprecated. UseWorldRoot:Raycast()along withRaycastParamsfor new work.
Returns the firstBasePartorTerraincell intersecting with the givenRaythat isn't in, nor is a descendant of an object in, the given ignore list.Parameters Parameter Description ray: RayARaywhose origin and direction define the raycast.ignoreDescendantsTable: { Instance }An array of objects whose descendants are excluded from the raycast.terrainCellsAreCubes: boolean? = falseWhetherTerraincells are treated as full cubes when calculating intersection. Default is false.ignoreWater: boolean? = falseWhetherTerrainwater cells are ignored by the ray. Default is false.Returns Type Description ...anyUse Raycast instead.
WorldRoot:FindPartOnRayWithWhitelist(ray: Ray,whitelistDescendantsTable: { Instance },ignoreWater: boolean? = false,): ...any Deprecated: This function has been deprecated. UseWorldRoot:Raycast()along withRaycastParamsfor new work.
Returns the firstBasePartorTerraincell intersecting with the givenRaythat is in, or is a descendant of an object in, the given inclusion list.Parameters Parameter Description ray: RayARaywhose origin and direction define the raycast.whitelistDescendantsTable: { Instance }An array of objects whose descendants are the only candidates considered in the raycast.ignoreWater: boolean? = falseWhetherTerrainwater cells are ignored by the ray. Default is false.Returns Type Description ...anyUse Raycast instead.
WorldRoot:FindPartsInRegion3(region: Region3,ignoreDescendantsInstance: Instance? = nil,maxParts: number? = 20,): { Instance } Deprecated: This function has been deprecated. UseWorldRoot:GetPartBoundsInBox()along withOverlapParamsfor new work.
Returns an array ofBasePartsin the givenRegion3.Parameters Parameter Description region: Region3TheRegion3to be checked.ignoreDescendantsInstance: Instance? = nilAnInstanceto be ignored.maxParts: number? = 20The maximum amount ofBasePartsto be returned.Returns Type Description { Instance }An array ofBasePartswithin theRegion3.Use GetPartBoundsInBox instead.
WorldRoot:FindPartsInRegion3WithIgnoreList(region: Region3,ignoreDescendantsTable: { Instance },maxParts: number? = 20,): { Instance } Deprecated: This function has been deprecated. UseWorldRoot:GetPartBoundsInBox()along withOverlapParamsfor new work.
Returns an array ofBasePartsin the givenRegion3that aren't in, or a descendant of an entry in, the given ignore list.Parameters Parameter Description region: Region3TheRegion3to be checked.ignoreDescendantsTable: { Instance }An array of objects to be ignored.maxParts: number? = 20The maximum number ofBasePartsto be returned.Returns Type Description { Instance }An array ofBasePartsfound within theRegion3.Use GetPartBoundsInBox instead.
WorldRoot:FindPartsInRegion3WithWhiteList(region: Region3,whitelistDescendantsTable: { Instance },maxParts: number? = 20,): { Instance } Deprecated: This function has been deprecated. UseWorldRoot:GetPartBoundsInBox()along withOverlapParamsfor new work.
Returns an array ofBasePartsin the givenRegion3that are in, or descendant of an entry in, the given inclusion list.Parameters Parameter Description region: Region3TheRegion3to be checked.whitelistDescendantsTable: { Instance }An array of objects to check.maxParts: number? = 20The maximum number ofBasePartsto be returned.Returns Type Description { Instance }An array ofBasePartswithin theRegion3.Use GetPartBoundsInBox instead.
WorldRoot:IsRegion3Empty(region: Region3,ignoreDescendentsInstance: Instance? = nil,): boolean Deprecated: This function has been deprecated. UseWorldRoot:GetPartBoundsInBox()along withOverlapParamsfor new work.
Returns a bool indicating whether there are noBasePartswithin the givenRegion3.Parameters Parameter Description region: Region3TheRegion3to be checked.ignoreDescendentsInstance: Instance? = nilAnInstanceto be ignored.Use GetPartBoundsInBox instead.
WorldRoot:IsRegion3EmptyWithIgnoreList(region: Region3,ignoreDescendentsTable: { Instance },): boolean Deprecated: This function has been deprecated. UseWorldRoot:GetPartBoundsInBox()along withOverlapParamsfor new work.
Returns a boolean indicating whether there are noBasePartswithin the givenRegion3, ignoring anyBasePartsthat are descendants of the objects within the given ignore list.Parameters Parameter Description region: Region3TheRegion3to be checked.ignoreDescendentsTable: { Instance }An array of objects to be ignored.Use GetPartBoundsInBox instead.
WorldRoot:findPartOnRay(ray: Ray,ignoreDescendantsInstance: Instance? = nil,terrainCellsAreCubes: boolean? = false,ignoreWater: boolean? = false,): ...any Deprecated: This deprecated function is a variant ofWorldRoot:FindPartOnRay()which should be used instead.Parameters Parameter ray: RayignoreDescendantsInstance: Instance? = nilterrainCellsAreCubes: boolean? = falseignoreWater: boolean? = falseReturns Type ...anyUse Raycast instead.
WorldRoot:findPartsInRegion3(region: Region3,ignoreDescendantsInstance: Instance? = nil,maxParts: number? = 20,): { Instance } Deprecated: This deprecated function is a variant ofWorldRoot:FindPartsInRegion3()which should be used instead.Returns Type { Instance }Use GetPartBoundsInBox instead.
Defined byWorkspace18
Workspace:ApplyRecommendedStreamingSettings( ): boolean Applies Roblox's recommended instance streaming settings to theWorkspace.Returns Type Description booleantrueif one or more streaming properties were changed;falseif every value already matched its recommended setting.Returns Type numberReturns Type numberReturns Type numberWorkspace:ExperimentalSolverIsEnabled( ): boolean Returns Type booleanWorkspace:GetNumAwakeParts( ): number Returns the number ofBasePartsthat are deemed physically active, due to being recently under the influence of physics.Returns Type Description numberThe number of awake parts.Workspace:GetPhysicsThrottling( ): number Returns an integer, between 0 and 100, representing the percentage of real time that physics simulation is currently being throttled to.Returns Type Description numberThe percentage of real time that physics simulation is currently being throttled to.Workspace:GetRealPhysicsFPS( ): number Returns the number of frames per second that physics is currently being simulated at.Returns Type Description numberReturns the number of frames per second that physics is currently being simulated at.Workspace:GetServerTimeNow( ): number Returns the server's Unix time in seconds.Returns Type Description numberThe estimated Unix timestamp on the server.Workspace:JoinToOutsiders(objects: { Instance },jointType: Enum.JointCreationMode,) Creates joints between the specifiedPartsand any touching parts depending on the parts' surfaces and the specified joint creation mode.Parameters Parameter Description objects: { Instance }An array ofBasePartsfor whom joints are to be made.jointType: Enum.JointCreationModeTheJointCreationModeto be used. Passing inEnum.JointCreationMode.AllorEnum.JointCreationMode.Surfacehas the same behavior which equates to Join Always.Workspace:PGSIsEnabled( ): boolean Returnstrueif the game has the PGS Physics solver enabled.Returns Type Description booleanTrue if the PGS solver is enabled.Workspace:SetAvatarUnificationMode( value: Enum.AvatarUnificationMode) Parameters Parameter value: Enum.AvatarUnificationModeWorkspace:SetMeshPartHeadsAndAccessories( value: Enum.MeshPartHeadsAndAccessories) Parameters Parameter value: Enum.MeshPartHeadsAndAccessoriesWorkspace:SetPhysicsThrottleEnabled( value: boolean) Parameters Parameter value: booleanWorkspace:UnjoinFromOutsiders( objects: { Instance }) Breaks all joints between the specifiedBasePartsand otherBaseParts.Parameters Parameter Description objects: { Instance }An array ofBasePartsfor whom joints are to be broken.- Positions and zooms the
Workspace.CurrentCamerato show the extent ofBasePartscurrently in theWorkspace. Workspace:BreakJoints( objects: { Instance }) Deprecated: This method is deprecated. Do not use it for new work.
Goes through allBasePartsgiven, breaking any joints connected to these parts.Parameters Parameter Description objects: { Instance }An array ofBasePartsfor whom joints are to be broken.Workspace:MakeJoints( objects: { Instance }) Deprecated: This method is deprecated. Do not use it for new work.
Goes through allBasePartsgiven. If any part's side has aSurfaceTypethat can make a joint it will create a joint with any adjacent parts.Parameters Parameter Description objects: { Instance }An array ofpartsfor whom joints are to be made.
No methods match the filters.
Events13
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
WorldRoot.CollisionGroupCollidableChanged: RBXScriptSignal<(collisionGroupIndex1: number,collisionGroupIndex2: number,)>
Defined byWorkspace2
Workspace.PersistentLoaded: RBXScriptSignal<( player: Player)> Fires when persistent models have been sent to the specified player.Parameters Parameter player: PlayerWorkspace.SendServerTime: RBXScriptSignal<( serverTimeMs: number)> Parameters Parameter serverTimeMs: number
No events match the filters.