v1.6.15 / Classes

Model

extends PVInstance

Class fields

Field	XML type	Value
`Name`	string	Model
`ExplorerOrder`	string	10
`ExplorerImageIndex`	string	2
`summary`	string	A construct used to group Parts and other objects together, also allows manipulation of multiple objects.

Properties

2

ModelInPrimary

CoordinateFrame

Field	XML type	Value
`Name`	string	ModelInPrimary

PrimaryPart

Object

Field	XML type	Value
`Name`	string	PrimaryPart
`summary`	string	A Part that serves as a reference for the Model's CFrame. Used in conjunction with GetModelPrimaryPartCFrame and SetModelPrimaryPartCFrame. Use this to rotate/translate all Parts relative to the PrimaryPart.

Functions

15

BreakJoints

() → void

Field	XML type	Value
`Name`	string	BreakJoints
`summary`	string	Breaks all surface joints contained within

GetExtentsSize

() → Vector3

Field	XML type	Value
`Name`	string	GetExtentsSize

GetModelCFrame

() → CoordinateFrame

Field	XML type	Value
`Name`	string	GetModelCFrame
`summary`	string	Returns a CFrame that has position of the centroid of all Parts in the Model. The rotation matrix is either the rotation matrix of the user-defined PrimaryPart, or if not specified then a part in the Model chosen by the engine.

GetModelSize

() → Vector3

Field	XML type	Value
`Name`	string	GetModelSize
`summary`	string	Returns a Vector3 that is union of the extents of all Parts in the model.

GetPrimaryPartCFrame

() → CoordinateFrame

Field	XML type	Value
`Name`	string	GetPrimaryPartCFrame
`summary`	string	Returns the cframe of the Model.PrimaryPart. If PrimaryPart is nil, then this function will throw an error.

MakeJoints

() → void

Field	XML type	Value
`Name`	string	MakeJoints
`summary`	string	Creates the appropriate SurfaceJoints between all touching Parts contrained within the model. Technically, this function calls MakeJoints() on all Parts inside the model.

MoveTo

(position: Vector3) → void

Field	XML type	Value
`Name`	string	MoveTo
`summary`	string	Moves the centroid of the Model to the specified location, respecting all relative distances between parts in the model.

ResetOrientationToIdentity

() → void

Field	XML type	Value
`Name`	string	ResetOrientationToIdentity
`summary`	string	Rotates all parts in the model to the orientation that was set using SetIdentityOrientation(). If this function has never been called, rotation is reset to GetModelCFrame()'s rotation.

SetIdentityOrientation

() → void

Field	XML type	Value
`Name`	string	SetIdentityOrientation
`summary`	string	Takes the current rotation matrix of the model and stores it as the model's identity matrix. The rotation is applied when ResetOrientationToIdentity() is called.

SetPrimaryPartCFrame

(cframe: CoordinateFrame) → void

Field	XML type	Value
`Name`	string	SetPrimaryPartCFrame
`summary`	string	Sets the cframe of the Model.PrimaryPart. If PrimaryPart is nil, then this function will throw an error. This also sets the cframe of all descendant Parts relative to the cframe change to PrimaryPart.

TranslateBy

(delta: Vector3) → void

Field	XML type	Value
`Name`	string	TranslateBy
`summary`	string	Similar to MoveTo(), except instead of moving to an explicit location, we use the model's current CFrame location and offset it.

breakJoints

() → void

Field	XML type	Value
`Name`	string	breakJoints

makeJoints

() → void

Field	XML type	Value
`Name`	string	makeJoints
`summary`	string	Use MakeJoints() instead
`Deprecated`	bool	true

move

(location: Vector3) → void

Field	XML type	Value
`Name`	string	move
`Deprecated`	bool	true
`summary`	string	Use MoveTo() instead

moveTo

(location: Vector3) → void

Field	XML type	Value
`Name`	string	moveTo