---
name: ViewportCamera
last_updated: 2026-11-11T22:23:26Z
inherits:
  - Camera
  - PVInstance
  - Instance
  - Object
type: class
memory_category: Instances
summary: "A Camera that replicates and is saved as authored content, for use with ViewportFrames or as a ThumbnailCamera."
---

# Class: ViewportCamera

> A [Camera](/docs/reference/engine/classes/Camera.md) that replicates and is saved as authored content, for use
> with [ViewportFrames](/docs/reference/engine/classes/ViewportFrame.md) or as a ThumbnailCamera.

## Description

`ViewportCamera` is a [Camera](/docs/reference/engine/classes/Camera.md) intended for cameras that you set up at
design time, such as a camera assigned to [ViewportFrame.CurrentCamera](/docs/reference/engine/classes/ViewportFrame.md)
or a `ThumbnailCamera` inside a [Model](/docs/reference/engine/classes/Model.md). It has the same properties,
methods, and events as [Camera](/docs/reference/engine/classes/Camera.md), but unlike [Camera](/docs/reference/engine/classes/Camera.md) it
replicates, so it works as expected in Team Create and when replicated from
the server to clients.

Use a [Camera](/docs/reference/engine/classes/Camera.md) for the camera that renders the 3D world, accessible
through [Workspace.CurrentCamera](/docs/reference/engine/classes/Workspace.md). Use a `ViewportCamera` for any other
camera that you author and want saved with the place.

#### Autoupgrade Behavior

When you paste copied content containing a [Camera](/docs/reference/engine/classes/Camera.md) in Studio, any
[Camera](/docs/reference/engine/classes/Camera.md) is automatically converted into a `ViewportCamera` with the
same properties. This is to facilitate the common workflow of setting up a
camera by positioning the main workspace camera and then copy-pasting that
camera.

## Inherited Members

### From [Camera](/docs/reference/engine/classes/Camera.md)

- **Property `CameraSubject`** (`Instance`): The Humanoid or BasePart that is the Camera
- **Property `CameraType`** (`CameraType`): Specifies the CameraType to be read by the camera scripts.
- **Property `CFrame`** (`CFrame`): The CFrame of the Camera, defining its position and
- **Property `CoordinateFrame`** (`CFrame`):  *(deprecated, hidden)*
- **Property `DiagonalFieldOfView`** (`float`): Sets the angle of the camera's diagonal field of view.
- **Property `FieldOfView`** (`float`): Sets the angle of the camera's vertical field of view.
- **Property `FieldOfViewMode`** (`FieldOfViewMode`): Determines the FOV value of the Camera that's invariant under
- **Property `Focus`** (`CFrame`): Sets the area in 3D space that is prioritized by Roblox's graphical
- **Property `focus`** (`CFrame`):  *(deprecated)*
- **Property `HeadLocked`** (`boolean`): Toggles whether the camera will automatically track the head motion of a
- **Property `HeadScale`** (`float`): Sets the scale of the user's perspective of the world when using VR.
- **Property `MaxAxisFieldOfView`** (`float`): Sets the angle of the camera's field of view along the longest viewport
- **Property `NearPlaneZ`** (`float`): Describes the negative **Z** offset, in studs, of the camera's near
- **Property `OrthographicMode`** (`OrthographicMode`): Sets which screen axis OrthographicSize is
- **Property `OrthographicSize`** (`float`): Sets the extent in studs of the dimension chosen by
- **Property `ProjectionType`** (`ProjectionType`): Chooses between perspective and orthographic cameras.
- **Property `ViewportSize`** (`Vector2`): The dimensions of the device safe area on a Roblox client.
- **Property `ViewStretch`** (`float`): Stretches the axis of the view not pinned by the current
- **Property `VRTiltAndRollEnabled`** (`boolean`): Toggles whether to apply tilt and roll from the
- **Method `GetLargestCutoffDistance(ignoreList: Instances): float`**: Returns how much the Camera needs to be pushed towards its *(deprecated)*
- **Method `GetPanSpeed(): float`**: Returns the current 'pan' speed of the Camera. *(deprecated)*
- **Method `GetPartsObscuringTarget(castPoints: Array, ignoreList: Instances): Instances`**: Returns an array of BaseParts that are obscuring the
- **Method `GetRenderCFrame(): CFrame`**: Returns the actual CFramewhere the Camera is being
- **Method `GetRoll(): float`**: Returns in radians the current roll, or rotation around the camera's
- **Method `GetTiltSpeed(): float`**: Returns the current tilt speed of the Camera. *(deprecated)*
- **Method `Interpolate(endPos: CFrame, endFocus: CFrame, duration: float): ()`**: Tweens the Camera in a linear fashion towards a new *(deprecated)*
- **Method `PanUnits(units: int): ()`**: Pans the Camera around the Focus in 45 degree *(deprecated)*
- **Method `ScreenPointToRay(x: float, y: float, depth?: float): Ray`**: Creates a unit Ray from a position on the screen (in pixels),
- **Method `SetCameraPanMode(mode?: CameraPanMode): ()`**: Sets the CameraPanMode to be used by the Camera on mobile *(deprecated)*
- **Method `SetRoll(rollAngle: float): ()`**: Sets the current rotation applied around the camera's Z-axis.
- **Method `TiltUnits(units: int): boolean`**: Tilts the Camera around its Focus in 10 *(deprecated)*
- **Method `ViewportPointToRay(x: float, y: float, depth?: float): Ray`**: Creates a unit Ray from a position on the viewport (in pixels),
- **Method `WorldToScreenPoint(worldPoint: Vector3): Tuple`**: Returns the screen location and depth of a Vector3 `worldPoint`
- **Method `WorldToViewportPoint(worldPoint: Vector3): Tuple`**: Returns the screen location and depth of a Vector3 `worldPoint`
- **Method `ZoomToExtents(boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): ()`**: Adjusts the CFrame so that the specified bounding
- **Event `InterpolationFinished`**: Fired when the Camera has finished interpolating

### From [PVInstance](/docs/reference/engine/classes/PVInstance.md)

- **Property `Origin`** (`CFrame`): Editor-only property that reads and sets the world CFrame of
- **Property `Pivot Offset`** (`CFrame`): Editor-only property that displays and edits the pivot's CFrame
- **Method `GetPivot(): CFrame`**: Gets the pivot of a PVInstance.
- **Method `PivotTo(targetCFrame: CFrame): ()`**: Transforms the PVInstance along with all of its descendant

### From [Instance](/docs/reference/engine/classes/Instance.md)

- **Property `Archivable`** (`boolean`): Determines if an Instance and its descendants can be cloned using
- **Property `archivable`** (`boolean`):  *(deprecated, hidden)*
- **Property `Capabilities`** (`SecurityCapabilities`): The set of capabilities allowed to be used for scripts inside this
- **Property `IsInSandbox`** (`boolean`): Indicates whether the instance is inside a sandboxed container.
- **Property `Name`** (`string`): A non-unique identifier of the Instance.
- **Property `Parent`** (`Instance`): Determines the hierarchical parent of the Instance.
- **Property `PredictionMode`** (`PredictionMode`): Reflects the client-side prediction mode applied to the instance under
- **Property `RobloxLocked`** (`boolean`): A deprecated property that used to protect CoreGui objects. *(hidden)*
- **Property `Sandboxed`** (`boolean`): When enabled, the instance can only access abilities in its `Capabilities`
- **Property `UniqueId`** (`UniqueId`): A unique identifier for the instance.
- **Method `AddTag(tag: string): ()`**: Applies a tag to the instance.
- **Method `children(): Instances`**: Returns an array of the object's children. *(deprecated)*
- **Method `ClearAllChildren(): ()`**: This method destroys all of an instance's children.
- **Method `Clone(): Instance`**: Create a copy of an instance and all its descendants, ignoring instances
- **Method `clone(): Instance`**:  *(deprecated)*
- **Method `Destroy(): ()`**: Sets the Instance.Parent property to `nil`, locks the
- **Method `destroy(): ()`**:  *(deprecated)*
- **Method `FindFirstAncestor(name: string): Instance?`**: Returns the first ancestor of the Instance whose
- **Method `FindFirstAncestorOfClass(className: string): Instance?`**: Returns the first ancestor of the Instance whose
- **Method `FindFirstAncestorWhichIsA(className: string): Instance?`**: Returns the first ancestor of the Instance for whom
- **Method `FindFirstChild(name: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance found with the given name.
- **Method `findFirstChild(name: string, recursive?: boolean): Instance`**:  *(deprecated)*
- **Method `FindFirstChildOfClass(className: string): Instance?`**: Returns the first child of the Instance whose
- **Method `FindFirstChildWhichIsA(className: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance for whom
- **Method `FindFirstDescendant(name: string): Instance?`**: Returns the first descendant found with the given Instance.Name.
- **Method `GetActor(): Actor?`**: Returns the Actor associated with the Instance, if any.
- **Method `GetAttribute(attribute: string): Variant`**: Returns the value which has been assigned to the given attribute name.
- **Method `GetAttributeChangedSignal(attribute: string): RBXScriptSignal`**: Returns an event that fires when the given attribute changes.
- **Method `GetAttributes(): Dictionary`**: Returns a dictionary of the instance's attributes.
- **Method `GetChildren(): Instances`**: Returns an array containing all of the instance's children.
- **Method `getChildren(): Instances`**:  *(deprecated)*
- **Method `GetDebugId(scopeLength?: int): string`**: Returns a coded string of the debug ID used internally by Roblox.
- **Method `GetDescendants(): Instances`**: Returns an array containing all of the descendants of the instance.
- **Method `GetFullName(): string`**: Returns a string describing the instance's ancestry.
- **Method `GetStyled(name: string, selector: string?): Variant`**: Returns the styled or explicitly modified value of the specified property,
- **Method `GetStyledPropertyChangedSignal(property: string): RBXScriptSignal`**: Returns an event that fires when the given style property changes on the
- **Method `GetTags(): Array`**: Gets an array of all tags applied to the instance.
- **Method `HasTag(tag: string): boolean`**: Check whether the instance has a given tag.
- **Method `IsAncestorOf(descendant: Instance): boolean`**: Returns true if an Instance is an ancestor of the given
- **Method `IsDescendantOf(ancestor: Instance): boolean`**: Returns `true` if an Instance is a descendant of the given
- **Method `isDescendantOf(ancestor: Instance): boolean`**:  *(deprecated)*
- **Method `IsPropertyModified(property: string): boolean`**: Returns `true` if the value stored in the specified property is not equal
- **Method `QueryDescendants(selector: string): Instances`**: Returns an array containing all descendants of the instance that match the
- **Method `Remove(): ()`**: Sets the object's `Parent` to `nil`, and does the same for all its *(deprecated)*
- **Method `remove(): ()`**:  *(deprecated)*
- **Method `RemoveTag(tag: string): ()`**: Removes a tag from the instance.
- **Method `ResetPropertyToDefault(property: string): ()`**: Resets a property to its default value.
- **Method `SetAttribute(attribute: string, value: Variant): ()`**: Sets the attribute with the given name to the given value.
- **Method `WaitForChild(childName: string, timeOut: double): Instance`**: Returns the child of the Instance with the given name. If the
- **Event `AncestryChanged`**: Fires when the Instance.Parent property of this object or one of
- **Event `AttributeChanged`**: Fires whenever an attribute is changed on the Instance.
- **Event `ChildAdded`**: Fires after an object is parented to this Instance.
- **Event `childAdded`**:  *(deprecated)*
- **Event `ChildRemoved`**: Fires after a child is removed from this Instance.
- **Event `DescendantAdded`**: Fires after a descendant is added to the Instance.
- **Event `DescendantRemoving`**: Fires immediately before a descendant of the Instance is removed.
- **Event `Destroying`**: Fires immediately before (or is deferred until after) the instance is
- **Event `StyledPropertiesChanged`**: Fires whenever any style property is changed on the instance, including

### From [Object](/docs/reference/engine/classes/Object.md)

- **Property `ClassName`** (`string`): A read-only string representing the class this Object belongs to.
- **Property `className`** (`string`):  *(deprecated)*
- **Method `GetPropertyChangedSignal(property: string): RBXScriptSignal`**: Get an event that fires when a given property of the object changes.
- **Method `IsA(className: string): boolean`**: Returns true if an object's class matches or inherits from a given class.
- **Method `isA(className: string): boolean`**:  *(deprecated)*
- **Event `Changed`**: Fires immediately after a property of the object changes, with some