Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PVInstance

Abstract class for all objects that have a physical location in the world.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is not browsable. It is not visible in Studio's object browser.
Tags: [NotCreatable, NotBrowsable]

Member index 4

HistoryMember
731Origin: CFrame
731Pivot Offset: CFrame
576GetPivot(): CFrame
573PivotTo(targetCFrame: CFrame): null
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Removed member index 5

HistoryMember
337CoordinateFrame: CoordinateFrame
557Origin Orientation: Vector3
557Origin Position: Vector3
557Pivot Offset Orientation: Vector3
557Pivot Offset Position: Vector3

Description

A PVInstance is an abstract class that cannot be created. It is the base for all objects that have a physical location in the world.

History 31

Members 4

GetPivot

Parameters (0)
No parameters.
Returns (1)
CFrame

This function gets the pivot of a PVInstance. This is often used with PVInstance:PivotTo() to move a model.

Models and BaseParts are both PVInstances ("Position Velocity Instances") and so both have this function.

History 2

Origin

TypeDefault
CFrame

Editor-only property, shown in the Studio Properties window as Origin Position and Origin Orientation under Transform. Its value is the world-space CFrame of the instance's pivot; reading it returns the same CFrame as PVInstance:GetPivot(). It has no stored value of its own and always reflects the current pivot.

Setting it from the Properties window moves the whole instance so its pivot lands at the new CFrame, much like PVInstance:PivotTo(). Editing through the Properties window temporarily disables WeldConstraints to other objects for the move; PivotTo does not modify joints.

Not available to scripts; use PVInstance:GetPivot() and PVInstance:PivotTo() at runtime instead.

This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

Pivot Offset

TypeDefault
CFrame

Editor-only property, shown in the Studio Properties window as Pivot Position and Pivot Orientation under Pivot. It is the CFrame of the pivot relative to the instance's own frame.

Changing it from the Properties window moves the pivot relative to the instance while leaving the instance in place, unlike Origin, which moves the whole instance. For a BasePart, the offset defaults to the identity CFrame, so the pivot coincides with the part's center. For a Model, this property appears only when the model has a PrimaryPart; it then reflects and edits that part's PivotOffset, and Model:GetPivot() aliases the primary part's pivot.

Not available to scripts; scripts read and write the equivalent through the concrete class, such as BasePart.PivotOffset.

This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

PivotTo

Parameters (1)
targetCFrameCFrame
Returns (1)
null

Transforms the PVInstance along with all of its descendant PVInstances such that the pivot is now located at the specified CFrame. This is the primary function that should be used to move Models via scripting.

BaseParts are moved in this way by having their CFrame transformed by the necessary offset. Models are moved in this way by having their Model.WorldPivot transformed by the necessary offset.

Note that for efficiency purposes, Object.Changed events are not fired for Position and Orientation of BaseParts moved in this way; they are only fired for CFrame.

When calling PivotTo on Models, the offsets of the descendant parts and models are cached, such that subsequent calls to PivotTo on the same model do not accumulate floating point drift between the parts making up the model.

Models and BaseParts are both PVInstances ("Position Velocity Instances") and so both have this function.

History 2

Removed members 5

CoordinateFrame

TypeDefault
CoordinateFrame
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [WriteOnly, Deprecated]

Origin Orientation

TypeDefault
Vector3
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

Origin Position

TypeDefault
Vector3
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

Pivot Offset Orientation

TypeDefault
Vector3
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

Pivot Offset Position

TypeDefault
Vector3
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated, NotScriptable]

Settings