PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. WorldRoot

WorldRoot

Show deprecated
Hide content
  1. apireference
  2. worldroot

WorldRoot

Show deprecated

Properties

Inherited from Model: Show Hide

ModelLevelOfDetail

LevelOfDetail

BasePart

PrimaryPart

Points to the primary part of the Model.
Vector3

World Pivot Orientation

[NotReplicated] [NotScriptable]

Editor-only property to set the orientation of the pivot. Scripts must use Model/WorldPivot instead.
Vector3

World Pivot Position

[NotReplicated] [NotScriptable]

Editor-only property to set the position of the pivot. Scripts must use Model/WorldPivot instead.
CFrame

WorldPivot

[NotReplicated]

Determines where the pivot of a Model which does not have a set Model/PrimaryPart is located.

Inherited from PVInstance: Show Hide

Vector3

Origin Orientation

[NotReplicated] [NotScriptable]

Editor-only property used to rotate the object around its pivot. Scripts must use PVInstance/PivotTo instead.
Vector3

Origin Position

[NotReplicated] [NotScriptable]

Editor-only property used to move the object. Scripts must use PVInstance/PivotTo instead.
Vector3

Pivot Offset Orientation

[NotReplicated] [NotScriptable]

Editor-only property to set the orientation of the pivot relative to a part. Scripts must use BasePart/PivotOffset instead.
Vector3

Pivot Offset Position

[NotReplicated] [NotScriptable]

Editor-only property to set the position of the pivot relative to a part. Scripts must use BasePart/PivotOffset instead.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

bool

ArePartsTouchingOthers ( Objects partList , float overlapIgnored )

Returns true if any of the given BasePart are touching any other parts
void

BulkMoveTo ( Objects partList , Array cframeList , BulkMoveMode eventMode )

Moves a table of Part|parts to DataType/CFrame|CFrames in a table of CFrames, without firing property changed events
Tuple

FindPartOnRay ( Ray ray , Instance ignoreDescendantsInstance , bool terrainCellsAreCubes , bool ignoreWater )

[Deprecated]

Returns the first BasePart or Terrain cell intersecting with the given DataType/Ray
Tuple

FindPartOnRayWithIgnoreList ( Ray ray , Objects ignoreDescendantsTable , bool terrainCellsAreCubes , bool ignoreWater )

[Deprecated]

Returns the first BasePart or Terrain cell intersecting with the given DataType/Ray that isn’t in, nor is a descendant of an object in, the given ignore list
Tuple

FindPartOnRayWithWhitelist ( Ray ray , Objects whitelistDescendantsTable , bool ignoreWater )

[Deprecated]

Returns the first BasePart or Terrain cell intersecting with the given DataType/Ray that is in, or is a descendant of an object in, the given whitelist
Objects

FindPartsInRegion3 ( Region3 region , Instance ignoreDescendantsInstance , int maxParts )

[Deprecated]

Returns an array of BaseParts in the given DataType/Region3.
Objects

FindPartsInRegion3WithIgnoreList ( Region3 region , Objects ignoreDescendantsTable , int maxParts )

[Deprecated]

Returns an array of BaseParts in the given DataType/Region3 that aren’t in, or a descendant of an entry in, the given IgnoreList.
Objects

FindPartsInRegion3WithWhiteList ( Region3 region , Objects whitelistDescendantsTable , int maxParts )

[Deprecated]

Returns an array of BaseParts in the given DataType/Region3 that are in, or descendant of an object in, a given white list.
Objects

GetPartBoundsInBox ( CFrame cframe , Vector3 size , OverlapParams overlapParams )

Returns an array of parts whose bounding boxes overlap a given box
Objects

GetPartBoundsInRadius ( Vector3 position , float radius , OverlapParams overlapParams )

Returns an array of parts whose bounding boxes overlap a given sphere
Objects

GetPartsInPart ( BasePart part , OverlapParams overlapParams )

Returns an array of parts whose occupied space is shared with the given part
void

IKMoveTo ( BasePart part , CFrame target , float translateStiffness , float rotateStiffness , IKCollisionsMode collisionsMode )

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
bool

IsRegion3Empty ( Region3 region , Instance ignoreDescendentsInstance )

[Deprecated]

Returns a bool indicating whether there are no BaseParts within the given DataType/Region3.
bool

IsRegion3EmptyWithIgnoreList ( Region3 region , Objects ignoreDescendentsTable )

[Deprecated]

Returns a bool indicating whether there are no BaseParts within in the given DataType/Region3, ignoring any BaseParts that are descendants of the objects within the given ignore list.
RaycastResult

Raycast ( Vector3 origin , Vector3 direction , RaycastParams raycastParams )

Casts a ray using an origin, direction, and optional datatype/RaycastParams, then returns a datatype/RaycastResult if an eligible object or terrain intersects the ray.
void

SetInsertPoint ( Vector3 point , bool ignoreGrid )

Tuple

findPartOnRay ( Ray ray , Instance ignoreDescendantsInstance , bool terrainCellsAreCubes , bool ignoreWater )

[Deprecated]
Objects

findPartsInRegion3 ( Region3 region , Instance ignoreDescendantsInstance , int maxParts )

[Deprecated]

Inherited from Model: Show Hide

void

BreakJoints ( )

Breaks connections between BaseParts, including surface connections with any adjacent parts, WeldConstraints and all Welds and other JointInstances.
Tuple

GetBoundingBox ( )

Returns a description of a volume that contains all parts of a Model
Vector3

GetExtentsSize ( )

Returns the size of the smallest bounding box that contains all of the BaseParts in the Model, aligned with the Model/PrimaryPart if it is set.
CFrame

GetModelCFrame ( )

[Deprecated]

This value historically returned the CFrame of a central position in the model. It has been deprecated as it did not provide reliable results.
Vector3

GetModelSize ( )

[Deprecated]

Returns the Vector3 size of the Model.
CFrame

GetPrimaryPartCFrame ( )

Returns the CFrame of the Model’s Model/PrimaryPart. This function will throw an error if no primary part exists for the Model.
void

MakeJoints ( )

Goes through all BaseParts in the Model. If any part’s side has a SurfaceType that can make a joint it will create a joint with any adjacent parts
void

MoveTo ( Vector3 position )

Moves the Model/PrimaryPart to the given position. If a primary part has not been specified then the root part of the model will be used.
void

ResetOrientationToIdentity ( )

[Deprecated]

Resets the rotation of the model’s parts to the previously set identity rotation, which is done through the Model/SetIdentityOrientation method.
void

SetIdentityOrientation ( )

[Deprecated]

Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of the ResetOrientationToIdentity method.
void

SetPrimaryPartCFrame ( CFrame cframe )

Sets the BasePart/CFrame of the Model’s Model/PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the Model/PrimaryPart.
void

TranslateBy ( Vector3 delta )

Shifts a Model by the given Vector3 offset, preserving the Model’s orientation. If another BasePart or Terrain already exists at the new position then the Model will overlap said object.
void

breakJoints ( )

[Deprecated]
void

makeJoints ( )

[Deprecated]
void

move ( Vector3 location )

[Deprecated]
void

moveTo ( Vector3 location )

[Deprecated]

Inherited from PVInstance: Show Hide

CFrame

GetPivot ( )

Gets the pivot of a PVInstance.
void

PivotTo ( CFrame targetCFrame )

Transforms the PVInstance along with all of its descendant PVInstance|PVInstances such that the pivot is now located at the specified datatype/CFrame.

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

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

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]