Reference API Roblox

Engine API

Website

Related

Reference API Roblox

WorldRoot

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryPhysicsParts
Tags: [NotCreatable]

Member index 25

HistoryMember
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 1

HistoryMember
427IkMoveTo(part: Instance, target: CFrame, translateStiffness: float = 1, rotateStiffness: float = 1, collisionsMode: CollisionsMode = OtherMechanismsAnchored): void

History 91

Members 25

ArePartsTouchingOthers

Parameters (2)Default
partListObjects
overlapIgnoredfloat0.000199999995
Returns (1)
bool
Thread safetyUnsafe

History 2

Blockcast

Parameters (4)Default
cframeCFrame
sizeVector3
directionVector3
paramsRaycastParamsRaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
Returns (1)
RaycastResult
Thread safetySafe

History 2

BulkMoveTo

Parameters (3)Default
partListObjects
cframeListArray
eventModeBulkMoveModeFireAllEvents
Returns (1)
null
Thread safetyUnsafe

History 3

CacheCurrentTerrain

Parameters (3)
idstring
centerVector3
radiusfloat
Returns (1)
string
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

ClearCachedTerrain

Parameters (1)
idstring
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

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. Raycast should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

FindPartOnRayWithIgnoreList

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

History 4

Tags: [Deprecated]

FindPartOnRayWithWhitelist

Parameters (3)Default
rayRay
whitelistDescendantsTableObjects
ignoreWaterboolfalse
Returns (1)
Tuple
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Raycast should be used instead.
Thread safetyUnsafe

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. GetPartBoundsInBox should be used instead.
Thread safetyUnsafe

History 6

Tags: [Deprecated]

FindPartsInRegion3WithIgnoreList

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

History 4

Tags: [Deprecated]

FindPartsInRegion3WithWhiteList

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

History 4

Tags: [Deprecated]

GetPartBoundsInBox

Parameters (3)Default
cframeCFrame
sizeVector3
overlapParamsOverlapParamsOverlapParams{MaxParts=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
Returns (1)
Objects
Thread safetySafe

History 4

GetPartBoundsInRadius

Parameters (3)Default
positionVector3
radiusfloat
overlapParamsOverlapParamsOverlapParams{MaxParts=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
Returns (1)
Objects
Thread safetySafe

History 4

GetPartsInPart

Parameters (2)Default
partBasePart
overlapParamsOverlapParamsOverlapParams{MaxParts=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
Returns (1)
Objects
Thread safetySafe

History 5

  • 549 Change Parameters of GetPartsInPart from (part: BasePart, overlapParams: OverlapParams = OverlapParams{MaxParts=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (part: BasePart, overlapParams: OverlapParams = OverlapParams{MaxParts=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}})
  • 512 Change ThreadSafety of GetPartsInPart from Unsafe to Safe
  • 509 Change Parameters of GetPartsInPart from (part: BasePart, overlapParams: OverlapParams = OverlapParams{MaxParts=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (part: BasePart, overlapParams: OverlapParams = OverlapParams{MaxParts=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}})
  • 492 Change Parameters of GetPartsInPart from (part: Instance, overlapParams: OverlapParams = OverlapParams{MaxParts=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (part: BasePart, overlapParams: OverlapParams = OverlapParams{MaxParts=false, CollisionGroup=Default, FilterDescendantsInstances={}})
  • 470 Add GetPartsInPart

IKMoveTo

Parameters (5)Default
partBasePart
targetCFrame
translateStiffnessfloat0.5
rotateStiffnessfloat0.5
collisionsModeIKCollisionsModeOtherMechanismsAnchored
Returns (1)
null
SecurityPluginSecurity
Thread safetyUnsafe

History 4

IsRegion3Empty

Parameters (2)Default
regionRegion3
ignoreDescendentsInstanceInstanceInstance
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetPartBoundsInBox should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

IsRegion3EmptyWithIgnoreList

Parameters (2)
regionRegion3
ignoreDescendentsTableObjects
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetPartBoundsInBox should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

Raycast

Parameters (3)Default
originVector3
directionVector3
raycastParamsRaycastParamsRaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
Returns (1)
RaycastResult
Thread safetySafe

History 9

  • 549 Change Parameters of Raycast from (origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}})
  • 509 Change Parameters of Raycast from (origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}})
  • 486 Change ThreadSafety of Raycast from ReadOnly to Safe
  • 462 Change ThreadSafety of Raycast from to ReadOnly
  • 438 Change Parameters of Raycast from (origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, FilterDescendantsInstances={}}) to (origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, CollisionGroup=Default, FilterDescendantsInstances={}})
  • 422 Change ReturnType of Raycast from Tuple to RaycastResult
  • 420 Add Raycast
  • 419 Remove Raycast
  • 420 Add Raycast

RaycastCachedTerrain

Parameters (4)
idstring
originVector3
directionVector3
ignoreWaterbool
Returns (1)
RaycastResult
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

SetInsertPoint

Parameters (2)Default
pointVector3
ignoreGridboolfalse
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

Shapecast

Parameters (3)Default
partBasePart
directionVector3
paramsRaycastParamsRaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
Returns (1)
RaycastResult
Thread safetyUnsafe

History 1

Spherecast

Parameters (4)Default
positionVector3
radiusfloat
directionVector3
paramsRaycastParamsRaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
Returns (1)
RaycastResult
Thread safetySafe

History 2

StepPhysics

Parameters (2)Default
dtfloat
partsObjects{}
Returns (1)
null
SecurityPluginSecurity
Thread safetyUnsafe

History 1

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. Raycast should be used instead.
Thread safetyUnsafe

History 3

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. GetPartBoundsInBox should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

Removed members 1

IkMoveTo

Parameters (5)Default
partInstance
targetCFrame
translateStiffnessfloat1
rotateStiffnessfloat1
collisionsModeCollisionsModeOtherMechanismsAnchored
Returns (1)
void
SecurityRobloxScriptSecurity

History 2

Settings