Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Workspace

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 59

HistoryMember
581AirDensity: float
553AllowThirdPartySales: bool
572AvatarUnificationMode: AvatarUnificationMode
615CSGAsyncDynamicCollision: CSGAsyncDynamicCollision
553ClientAnimatorThrottling: ClientAnimatorThrottlingMode
553CurrentCamera: Camera
617DecreaseMinimumPartDensityMode: DecreaseMinimumPartDensityMode
553DistributedGameTime: double
553FallenPartsDestroyHeight: float
587FluidForces: FluidForces
553GlobalWind: Vector3
553Gravity: float
581IKControlConstraintSupport: IKControlConstraintSupport
620InsertPoint: Vector3
553MeshPartHeadsAndAccessories: MeshPartHeadsAndAccessories
580ModelStreamingBehavior: ModelStreamingBehavior
628MoverConstraintRootBehavior: MoverConstraintRootBehaviorMode
553PhysicsSteppingMethod: PhysicsSteppingMethod
603PlayerCharacterDestroyBehavior: PlayerCharacterDestroyBehavior
600PrimalPhysicsSolver: PrimalPhysicsSolver
557RejectCharacterDeletions: RejectCharacterDeletions
624RenderingCacheOptimizations: RenderingCacheOptimizationMode
553ReplicateInstanceDestroySetting: ReplicateInstanceDestroySetting
553Retargeting: AnimatorRetargetingMode
570SignalBehavior: SignalBehavior
553StreamOutBehavior: StreamOutBehavior
553StreamingEnabled: bool
553StreamingIntegrityMode: StreamingIntegrityMode
553StreamingMinRadius: int
553StreamingTargetRadius: int
553Terrain: Terrain
553TouchesUseCollisionGroups: bool
573BreakJoints(objects: Objects): null
462CalculateJumpDistance(gravity: float, jumpPower: float, walkSpeed: float): float
462CalculateJumpHeight(gravity: float, jumpPower: float): float
462CalculateJumpPower(gravity: float, jumpHeight: float): float
462ExperimentalSolverIsEnabled(): bool
566GetNumAwakeParts(): int
566GetPhysicsThrottling(): int
538GetRealPhysicsFPS(): double
566GetServerTimeNow(): double
573JoinToOutsiders(objects: Objects, jointType: JointCreationMode): null
573MakeJoints(objects: Objects): null
462PGSIsEnabled(): bool
603SetAvatarUnificationMode(value: AvatarUnificationMode): null
573SetMeshPartHeadsAndAccessories(value: MeshPartHeadsAndAccessories): null
573SetPhysicsThrottleEnabled(value: bool): null
573UnjoinFromOutsiders(objects: Objects): null
573ZoomToExtents(): null
548PersistentLoaded(player: Player)
inherited from WorldRoot
462ArePartsTouchingOthers(partList: Objects, overlapIgnored: float = 0.000199999995): bool
572Blockcast(cframe: CFrame, size: Vector3, direction: Vector3, params: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): RaycastResult
573BulkMoveTo(partList: Objects, cframeList: Array, eventMode: BulkMoveMode = FireAllEvents): null
552CacheCurrentTerrain(id: string, center: Vector3, radius: float): string
552ClearCachedTerrain(id: string): bool
553FindPartOnRay(ray: Ray, ignoreDescendantsInstance: Instance = Instance, terrainCellsAreCubes: bool = false, ignoreWater: bool = false): Tuple
553FindPartOnRayWithIgnoreList(ray: Ray, ignoreDescendantsTable: Objects, terrainCellsAreCubes: bool = false, ignoreWater: bool = false): Tuple
553FindPartOnRayWithWhitelist(ray: Ray, whitelistDescendantsTable: Objects, ignoreWater: bool = false): Tuple
553FindPartsInRegion3(region: Region3, ignoreDescendantsInstance: Instance = Instance, maxParts: int = 20): Objects
553FindPartsInRegion3WithIgnoreList(region: Region3, ignoreDescendantsTable: Objects, maxParts: int = 20): Objects
553FindPartsInRegion3WithWhiteList(region: Region3, whitelistDescendantsTable: Objects, maxParts: int = 20): Objects
549GetPartBoundsInBox(cframe: CFrame, size: Vector3, overlapParams: OverlapParams = OverlapParams{MaxParts=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): Objects
549GetPartBoundsInRadius(position: Vector3, radius: float, overlapParams: OverlapParams = OverlapParams{MaxParts=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): Objects
549GetPartsInPart(part: BasePart, overlapParams: OverlapParams = OverlapParams{MaxParts=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): Objects
573IKMoveTo(part: BasePart, target: CFrame, translateStiffness: float = 0.5, rotateStiffness: float = 0.5, collisionsMode: IKCollisionsMode = OtherMechanismsAnchored): null
553IsRegion3Empty(region: Region3, ignoreDescendentsInstance: Instance = Instance): bool
553IsRegion3EmptyWithIgnoreList(region: Region3, ignoreDescendentsTable: Objects): bool
549Raycast(origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): RaycastResult
552RaycastCachedTerrain(id: string, origin: Vector3, direction: Vector3, ignoreWater: bool): RaycastResult
573SetInsertPoint(point: Vector3, ignoreGrid: bool = false): null
603Shapecast(part: BasePart, direction: Vector3, params: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): RaycastResult
572Spherecast(position: Vector3, radius: float, direction: Vector3, params: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): RaycastResult
616StepPhysics(dt: float, parts: Objects = {}): null
553findPartOnRay(ray: Ray, ignoreDescendantsInstance: Instance = Instance, terrainCellsAreCubes: bool = false, ignoreWater: bool = false): Tuple
553findPartsInRegion3(region: Region3, ignoreDescendantsInstance: Instance = Instance, maxParts: int = 20): Objects
inherited from Model
553LevelOfDetail: ModelLevelOfDetail
553ModelStreamingMode: ModelStreamingMode
553PrimaryPart: BasePart
562Scale: float
553WorldPivot: CFrame
573AddPersistentPlayer(playerInstance: Player = Player): null
573BreakJoints(): null
607GetBoundingBox(): (CFrame, Vector3)
462GetExtentsSize(): Vector3
553GetModelCFrame(): CFrame
553GetModelSize(): Vector3
576GetPersistentPlayers(): Objects
576GetPrimaryPartCFrame(): CFrame
562GetScale(): float
573MakeJoints(): null
573MoveTo(position: Vector3): null
573RemovePersistentPlayer(playerInstance: Player = Player): null
573ResetOrientationToIdentity(): null
573ScaleTo(newScaleFactor: float): null
573SetIdentityOrientation(): null
573SetPrimaryPartCFrame(cframe: CFrame): null
573TranslateBy(delta: Vector3): null
573breakJoints(): null
573makeJoints(): null
573move(location: Vector3): null
573moveTo(location: Vector3): null
inherited from PVInstance
553Origin: CFrame
553Pivot Offset: CFrame
576GetPivot(): CFrame
573PivotTo(targetCFrame: CFrame): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 30

HistoryMember
565AnimationWeightedBlendFix: NewAnimationRuntimeSetting
396AutoJointsMode: AutoJointsMode
629EditorLiveScripting: EditorLiveScripting
587EnableFluidForces: bool
595HumanoidOnlySetCollisionsOnStateChange: HumanoidOnlySetCollisionsOnStateChange
466MeshPartHeads: MeshPartHeads
600NewPhysicsSolver: PhysicsSolver
373PGSPhysicsSolverEnabled: bool
539PhysicsInertiaAndVolumeFix: PhysicsInertiaAndVolumeFix
442SkinnedMeshEnabled: SkinnedMeshAllowType
443TemporaryLegacyPhysicsSolverOverride: bool
560UnionsScaleNonuniformly: UnionsScaleNonuniformly
410FindPartOnRay(ray: Ray, ignoreDescendantsInstance: Instance = Instance, terrainCellsAreCubes: bool = false, ignoreWater: bool = false): Tuple
410FindPartOnRayWithIgnoreList(ray: Ray, ignoreDescendantsTable: Objects, terrainCellsAreCubes: bool = false, ignoreWater: bool = false): Tuple
410FindPartOnRayWithWhitelist(ray: Ray, whitelistDescendantsTable: Objects, ignoreWater: bool = false): Tuple
410FindPartsInRegion3(region: Region3, ignoreDescendantsInstance: Instance = Instance, maxParts: int = 20): Objects
410FindPartsInRegion3WithIgnoreList(region: Region3, ignoreDescendantsTable: Objects, maxParts: int = 20): Objects
410FindPartsInRegion3WithWhiteList(region: Region3, whitelistDescendantsTable: Objects, maxParts: int = 20): Objects
369GetPhysicsAnalyzerBreakOnIssue(): bool
369GetPhysicsAnalyzerIssue(index: int): Objects
163InsertContent(url: Content): Objects
410IsRegion3Empty(region: Region3, ignoreDescendentsInstance: Instance = Instance): bool
410IsRegion3EmptyWithIgnoreList(region: Region3, ignoreDescendentsTable: Objects): bool
466SetMeshPartHeads(value: MeshPartHeads): void
369SetPhysicsAnalyzerBreakOnIssue(enable: bool): void
410findPartOnRay(ray: Ray, ignoreDescendantsInstance: Instance = Instance, terrainCellsAreCubes: bool = false, ignoreWater: bool = false): Tuple
410findPartsInRegion3(region: Region3, ignoreDescendantsInstance: Instance = Instance, maxParts: int = 20): Objects
369PhysicsAnalyzerIssuesFound(count: int)

History 274

Members 59

AirDensity

TypeDefault
float

History 1

AllowThirdPartySales

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

AvatarUnificationMode

TypeDefault
AvatarUnificationMode
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

BreakJoints

Parameters (1)
objectsObjects
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

CSGAsyncDynamicCollision

TypeDefault
CSGAsyncDynamicCollision
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

CalculateJumpDistance

Parameters (3)
gravityfloat
jumpPowerfloat
walkSpeedfloat
Returns (1)
float

History 2

CalculateJumpHeight

Parameters (2)
gravityfloat
jumpPowerfloat
Returns (1)
float

History 2

CalculateJumpPower

Parameters (2)
gravityfloat
jumpHeightfloat
Returns (1)
float

History 2

ClientAnimatorThrottling

TypeDefault
ClientAnimatorThrottlingMode

History 3

CurrentCamera

TypeDefault
Camera
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated]

DecreaseMinimumPartDensityMode

TypeDefault
DecreaseMinimumPartDensityMode
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

DistributedGameTime

TypeDefault
double
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

ExperimentalSolverIsEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 2

FallenPartsDestroyHeight

TypeDefault
float

History 4

FluidForces

TypeDefault
FluidForces
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

GetNumAwakeParts

Parameters (0)
No parameters.
Returns (1)
int

History 3

GetPhysicsThrottling

Parameters (0)
No parameters.
Returns (1)
int

History 7

GetRealPhysicsFPS

Parameters (0)
No parameters.
Returns (1)
double

History 7

GetServerTimeNow

Parameters (0)
No parameters.
Returns (1)
double

History 2

GlobalWind

TypeDefault
Vector3

History 2

Gravity

TypeDefault
float

History 4

IKControlConstraintSupport

TypeDefault
IKControlConstraintSupport
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

InsertPoint

TypeDefault
Vector3
This property is not replicated. Its interface does not cross the network boundary.

History 1

Tags: [NotReplicated]

JoinToOutsiders

Parameters (2)
objectsObjects
jointTypeJointCreationMode
Returns (1)
null

History 3

MakeJoints

Parameters (1)
objectsObjects
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

MeshPartHeadsAndAccessories

TypeDefault
MeshPartHeadsAndAccessories
This property is not scriptable. It cannot be accessed by script code.

History 3

Tags: [NotScriptable]

ModelStreamingBehavior

TypeDefault
ModelStreamingBehavior
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

MoverConstraintRootBehavior

TypeDefault
MoverConstraintRootBehaviorMode
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

PGSIsEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 4

PersistentLoaded

Parameters (1)
playerPlayer

History 1

PhysicsSteppingMethod

TypeDefault
PhysicsSteppingMethod
This property is not scriptable. It cannot be accessed by script code.

History 3

Tags: [NotScriptable]

PlayerCharacterDestroyBehavior

TypeDefault
PlayerCharacterDestroyBehavior
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

PrimalPhysicsSolver

TypeDefault
PrimalPhysicsSolver
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

RejectCharacterDeletions

TypeDefault
RejectCharacterDeletions
This property is not scriptable. It cannot be accessed by script code.

History 3

Tags: [NotScriptable]

RenderingCacheOptimizations

TypeDefault
RenderingCacheOptimizationMode
This property is not scriptable. It cannot be accessed by script code.

History 4

Tags: [NotScriptable]

ReplicateInstanceDestroySetting

TypeDefault
ReplicateInstanceDestroySetting
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

Retargeting

TypeDefault
AnimatorRetargetingMode

History 2

SetAvatarUnificationMode

Parameters (1)
valueAvatarUnificationMode
Returns (1)
null

History 1

SetMeshPartHeadsAndAccessories

Parameters (1)
valueMeshPartHeadsAndAccessories
Returns (1)
null

History 2

SetPhysicsThrottleEnabled

Parameters (1)
valuebool
Returns (1)
null

History 3

SignalBehavior

TypeDefault
SignalBehavior
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

StreamOutBehavior

TypeDefault
StreamOutBehavior
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

StreamingEnabled

TypeDefault
bool

History 7

StreamingIntegrityMode

TypeDefault
StreamingIntegrityMode
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

StreamingMinRadius

TypeDefault
int
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

StreamingTargetRadius

TypeDefault
int
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Terrain

TypeDefault
Terrain
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 6

Tags: [ReadOnly, NotReplicated]

TouchesUseCollisionGroups

TypeDefault
bool
This property is not scriptable. It cannot be accessed by script code.

History 4

Tags: [NotScriptable]

UnjoinFromOutsiders

Parameters (1)
objectsObjects
Returns (1)
null

History 3

ZoomToExtents

Parameters (0)
No parameters.
Returns (1)
null

History 4

Removed members 30

AnimationWeightedBlendFix

TypeDefault
NewAnimationRuntimeSetting
This property is not scriptable. It cannot be accessed by script code.

History 4

Tags: [NotScriptable]

AutoJointsMode

TypeDefault
AutoJointsMode
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

EditorLiveScripting

TypeDefault
EditorLiveScripting
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

EnableFluidForces

TypeDefault
bool

History 2

FindPartOnRay

Parameters (4)Default
rayRay
ignoreDescendantsInstanceInstanceInstance
terrainCellsAreCubesboolfalse
ignoreWaterboolfalse
Returns (1)
Tuple

History 5

FindPartOnRayWithIgnoreList

Parameters (4)Default
rayRay
ignoreDescendantsTableObjects
terrainCellsAreCubesboolfalse
ignoreWaterboolfalse
Returns (1)
Tuple

History 5

FindPartOnRayWithWhitelist

Parameters (3)Default
rayRay
whitelistDescendantsTableObjects
ignoreWaterboolfalse
Returns (1)
Tuple

History 3

FindPartsInRegion3

Parameters (3)Default
regionRegion3
ignoreDescendantsInstanceInstanceInstance
maxPartsint20
Returns (1)
Objects

History 4

FindPartsInRegion3WithIgnoreList

Parameters (3)Default
regionRegion3
ignoreDescendantsTableObjects
maxPartsint20
Returns (1)
Objects

History 4

FindPartsInRegion3WithWhiteList

Parameters (3)Default
regionRegion3
whitelistDescendantsTableObjects
maxPartsint20
Returns (1)
Objects

History 2

GetPhysicsAnalyzerBreakOnIssue

Parameters (0)
No parameters.
Returns (1)
bool

History 2

GetPhysicsAnalyzerIssue

Parameters (1)
indexint
Returns (1)
Objects

History 2

HumanoidOnlySetCollisionsOnStateChange

TypeDefault
HumanoidOnlySetCollisionsOnStateChange
This property is not scriptable. It cannot be accessed by script code.

History 4

Tags: [NotScriptable]

InsertContent

Parameters (1)
urlContent
Returns (1)
Objects

History 2

IsRegion3Empty

Parameters (2)Default
regionRegion3
ignoreDescendentsInstanceInstanceInstance
Returns (1)
bool

History 2

IsRegion3EmptyWithIgnoreList

Parameters (2)
regionRegion3
ignoreDescendentsTableObjects
Returns (1)
bool

History 2

MeshPartHeads

TypeDefault
MeshPartHeads
This property is not scriptable. It cannot be accessed by script code.

History 3

Tags: [NotScriptable]

NewPhysicsSolver

TypeDefault
PhysicsSolver
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

PGSPhysicsSolverEnabled

TypeDefault
bool
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated, NotScriptable]

PhysicsAnalyzerIssuesFound

Parameters (1)
countint

History 2

PhysicsInertiaAndVolumeFix

TypeDefault
PhysicsInertiaAndVolumeFix
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

SetMeshPartHeads

Parameters (1)
valueMeshPartHeads
Returns (1)
void

History 5

SetPhysicsAnalyzerBreakOnIssue

Parameters (1)
enablebool
Returns (1)
void

History 2

SkinnedMeshEnabled

TypeDefault
SkinnedMeshAllowType
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TemporaryLegacyPhysicsSolverOverride

TypeDefault
bool
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated, NotScriptable]

UnionsScaleNonuniformly

TypeDefault
UnionsScaleNonuniformly
This property is not scriptable. It cannot be accessed by script code.

History 3

Tags: [NotScriptable]

findPartOnRay

Parameters (4)Default
rayRay
ignoreDescendantsInstanceInstanceInstance
terrainCellsAreCubesboolfalse
ignoreWaterboolfalse
Returns (1)
Tuple
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

findPartsInRegion3

Parameters (3)Default
regionRegion3
ignoreDescendantsInstanceInstanceInstance
maxPartsint20
Returns (1)
Objects
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

Settings