PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. WorldRoot

WorldRoot

Show deprecated
Hide content
Content
  1. apireference
  2. worldroot

WorldRoot

Show deprecated

Properties

Inherited from Model: Show Hide

BasePart

PrimaryPart

Points to the Model's primary part. The part is the BasePart that is used as a basis when positioning the model using the Model/MoveTo and Model/SetPrimaryPartCFrame functions.

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

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Deprecated]

A deprecated property that used to protect CoreGui objects
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

bool

ArePartsTouchingOthers ( Objects partList , float overlapIgnored )

void

BulkMoveTo ( Objects partList , Array cframeList , BulkMoveMode eventMode )

Tuple

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

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

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

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 )

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 )

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

FindPartsInRegion3WithIgnoreList ( Region3 region , Objects ignoreDescendantsTable , int maxParts )

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 )

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

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

bool

IsRegion3Empty ( Region3 region , Instance ignoreDescendentsInstance )

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

IsRegion3EmptyWithIgnoreList ( Region3 region , Objects ignoreDescendentsTable )

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.
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. This function will throw an error if no Model/PrimaryPart exists for the model.
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 Instance: Show Hide

void

ClearAllChildren ( )

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

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.
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.
Variant

GetAttribute ( string attribute )

RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Dictionary

GetAttributes ( )

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 )

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 )

RBXScriptSignal

Changed ( string property )

[DetectingPropertyChanges]

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

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

childAdded ( Instance child )

[Deprecated]