WorldModel

The code block below demonstrates how to use
`Class.WorldRoot:ArePartsTouchingOthers()` to check if parts in a list are
touching any parts in the workspace not in the list.

First the script creates two square parts that overlap 1 stud, `Part1` and
`Part2`. Then, it prints the value returned by ArePartsTouchingOthers() when
Part1 is passed in `partList` at three different overlap values: `0`, `0.999`,
and `1`. The first two times ArePartsTouchingOthers() is called return `false`
because the overlap values are less than the distance that Part1 and Part2
overlap. The third call returns `true` because the overlap value is equal to
the distance that the parts overlap.


WorldRoot:ArePartsTouchingOthers

partList

overlapIgnored

This example shows how to create a `Datatype.RaycastParams`
object, use it to cast a block shape, and check the results.


WorldRoot:Blockcast

cframe

size

direction

params

WorldRoot:BulkMoveTo

cframeList

eventMode

WorldRoot:FindPartOnRay

ignoreDescendantsInstance

terrainCellsAreCubes

ignoreWater

WorldRoot:FindPartOnRayWithIgnoreList

ignoreDescendantsTable

WorldRoot:FindPartOnRayWithWhitelist

whitelistDescendantsTable

WorldRoot:FindPartsInRegion3

region

maxParts

WorldRoot:FindPartsInRegion3WithIgnoreList

WorldRoot:FindPartsInRegion3WithWhiteList

WorldRoot:GetPartBoundsInBox

overlapParams

WorldRoot:GetPartBoundsInRadius

position

radius

WorldRoot:GetPartsInPart

part

WorldRoot:IKMoveTo

target

translateStiffness

rotateStiffness

collisionsMode

WorldRoot:IsRegion3Empty

ignoreDescendentsInstance

WorldRoot:IsRegion3EmptyWithIgnoreList

ignoreDescendentsTable

The following example shows how to construct a `Datatype.RaycastParams`
object, use it in a raycasting operation, and check the results.


WorldRoot:Raycast

origin

raycastParams

This example shows how to create a `Datatype.RaycastParams`
object, use it to cast a sphere shape, and check the results.


WorldRoot:Spherecast

WorldRoot:findPartOnRay

WorldRoot:findPartsInRegion3

WorldRoot

The following sample includes a basic function that takes a table of objects
and parents them into a new Model, returning that Model.


Model:AddPersistentPlayer

playerInstance

In this sample the joints in every Player character Model added will be broken
3 seconds after spawning. Breaking these joints will cause the Humanoid to
die.


This code sample demonstrates manual creation of joints on two parts that are
siblings of the script (PartA and PartB). It creates a joints on two touching
parts with compatible surface types (Studs and Inlet).


Model:BreakJoints

Model:GetBoundingBox

The code sample below demonstrates how Model.GetExtentsSize can be used to get
the size of the bounding box containing the parts.


Model:GetExtentsSize

Model:GetModelCFrame

This code would create a model, put some parts in it, position them randomly,
and then print its size:


Model:GetModelSize

Model:GetPersistentPlayers

The following code demonstrates how GetPrimaryPartCFrame and
SetPrimaryPartCFrame can be used to rotate a model.

A simple model is created in the Workspace and a loop is started that will
rotate the model 10 degrees around the Y axis every 0.2 seconds.


Model:GetPrimaryPartCFrame

This code sample demonstrates substituting in a replacement for all the copies of a tree model using PivotTo and ScaleTo. The pivot and scale of the models are used as a reference ensuring that the relative sizes and locations of the replacement models match those of the originals.


Model:GetScale

This code sample demonstrates how joints can be made using the
Model:MakeJoints function.

A model is instanced, with two parts on top of each other. The top part is
anchored and the bottom part is not. Normally, when parented to the Workspace
the bottom part would fall to the Baseplate.

However, as TopSurface property of the bottom part is set to
Enum.SurfaceType.Weld, this means that when Model:MakeJoints is ran a
connection is made between them.

Therefore the bottom part does not drop until the joints in the model are
broken. This is often done using Model:BreakJoints, but in this example the
connection is broken using an explosion.


This code sample demonstrates creation of joints on two parts that are
siblings of the script (PartA and PartB). It uses MakeJoints on two touching
parts with compatible surface types (Studs and Inlet).


Model:MakeJoints

This sample demonstrates how Model:MoveTo avoids collisions.

A simple two part Model is created, and its PrimaryPart is set. An large
obstruction part is placed next to it.

After 5 seconds Model:MoveTo is used to direct the model to move inside the
obstruction part. However, as MoveTo will not move a model inside of an
obstruction the Model is moved up on the Y axis and placed above the
obstruction.


Model:MoveTo

Model:RemovePersistentPlayer

Model:ResetOrientationToIdentity

Model:ScaleTo

newScaleFactor

Model:SetIdentityOrientation

Model:SetPrimaryPartCFrame

This sample demonstrates how Model:TranslateBy ignores collisions and respects
the orientation of the model.

A simple two part Model is created, rotated 45 degrees on the Y axis, and its
PrimaryPart is set. An large obstruction part is placed next to it.

After 5 seconds Model:TranslateBy is used to direct the model to move inside
the obstruction part. The model will move inside of the obstruction and
maintain it's current orientation.


Model:TranslateBy

delta

Model:breakJoints

Model:makeJoints

Model:move

location

Model:moveTo

Model

Model.LevelOfDetail

Model.ModelStreamingMode

This code sample creates and throws a dice model, then outputs whether it
landed with the blue side facing up. If `Class.Model.PrimaryPart` was not set,
the pivot / bounding box of the dice would rotate, as the parts inside of it
are physically simulated during the roll.


Model.PrimaryPart

Model.Scale

This code sample shows a custom function for resetting the pivot of a model
back to the center of that model's bounding box.


Model.WorldPivot

This code sample is a simple teleport script that moves your character
10&nbsp;studs forwards in the direction you're currently facing when you press
the <kbd>F</kbd> key. It does so by getting the current pivot with
`Class.PVInstance:GetPivot()` and calling `PVInstance|PivotTo` to move the
character forwards.


PVInstance:GetPivot

PVInstance:PivotTo

targetCFrame

PVInstance

PVInstance.Origin

PVInstance.Pivot Offset

The below example would print "Part is now a child of Model".


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Instance.Changed

property

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how an Instance being destroyed remains in place
until the connected function yields.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

This code first references an existing object in the `original` variable.
Then, it makes a copy of the object, sets the parent to that of the original,
and finally moves the copy to (0, 50, 0).


Instance:Clone

Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Instance:GetPropertyChangedSignal

Instance:GetTags

Instance:HasTag

Instance:IsA

Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

Instance:IsPropertyModified

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:ResetPropertyToDefault

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isA

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.ClassName

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.archivable

Instance.className

/reference/engine/classes/WorldModel.yaml

Provides some physics features to a `Class.ViewportFrame`.


Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Cloud

WorldModel

Summary

Properties

Methods

Events

Properties

Methods

Events