WorldModel

Properties

• LevelOfDetail:Enum.ModelLevelOfDetail

  Plugin Security

  Read Parallel

  Sets the level of detail on the model for experiences with instance streaming enabled.

• ModelStreamingMode:Enum.ModelStreamingMode

  Read Parallel

  Controls the model streaming behavior on Models when instance streaming is enabled.

• PrimaryPart:BasePart

  Read Parallel

  The primary part of the Model, or nil if not explicitly set.

• Scale:number

  Not Replicated

  Not Scriptable

  Read Parallel

  Editor-only property used to scale the model around its pivot. Setting this property will move the scale as though Model/ScaleTo was called on it.

• WorldPivot:CFrame

  Not Replicated

  Read Parallel

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

• Origin:CFrame

  Not Replicated

  Not Scriptable

  Read Parallel
• Pivot Offset:CFrame

  Not Replicated

  Not Scriptable

  Read Parallel

Methods

• ArePartsTouchingOthers(partList : Instances,overlapIgnored : number):boolean

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

• Blockcast(cframe : CFrame,size : Vector3,direction : Vector3,params : RaycastParams):RaycastResult?

  Write Parallel

  Casts a block shape in a given direction and returns a RaycastResult if the shape hits a BasePart or Terrain cell.

• BulkMoveTo(partList : Instances,cframeList : Array,eventMode : Enum.BulkMoveMode):()

  Moves a table of BaseParts to a table of CFrames.

• GetPartBoundsInBox(cframe : CFrame,size : Vector3,overlapParams : OverlapParams):Instances

  Write Parallel

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

• GetPartBoundsInRadius(position : Vector3,radius : number,overlapParams : OverlapParams):Instances

  Write Parallel

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

• GetPartsInPart(part : BasePart,overlapParams : OverlapParams):Instances

  Write Parallel

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

• IKMoveTo(part : BasePart,target : CFrame,translateStiffness : number,rotateStiffness : number,collisionsMode : Enum.IKCollisionsMode):()

  Plugin Security

  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.

• Raycast(origin : Vector3,direction : Vector3,raycastParams : RaycastParams):RaycastResult?

  Write Parallel

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

• Shapecast(part : BasePart,direction : Vector3,params : RaycastParams):RaycastResult?
• Spherecast(position : Vector3,radius : number,direction : Vector3,params : RaycastParams):RaycastResult?

  Write Parallel

  Casts a spherical shape in a given direction and returns a RaycastResult if the shape hits a BasePart or Terrain cell.

• StepPhysics(dt : number,parts : Instances):()

  Plugin Security

  Advances the simulation for parts in the world forward based on a specified time increment and an optional set of BaseParts.

• AddPersistentPlayer(playerInstance : Player):()

  Sets this model to be persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of addition.

• GetBoundingBox():Tuple

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

• GetExtentsSize():Vector3

  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.

• GetPersistentPlayers():Instances

  Returns all the Player objects that this model object is persistent for. Behavior varies based on whether this method is called from a Script or a LocalScript.

• GetScale():number

  Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via Model/ScaleTo.

• MoveTo(position : Vector3):()

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

• RemovePersistentPlayer(playerInstance : Player):()

  Makes this model no longer persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of removal.

• ScaleTo(newScaleFactor : number):()

  Sets the scale factor of the model, adjusting the sizing and location of all descendant Instances such that they have that scale factor relative to their initial sizes and locations when scale factor was 1.

• TranslateBy(delta : Vector3):()

  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.

• GetPivot():CFrame

  Write Parallel

  Gets the pivot of a PVInstance.

• PivotTo(targetCFrame : CFrame):()

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

Events