Viewport

Playground

Height (px)

Interactive

Allow orbit + zoom controls

Auto focus

Focus on object automatically

Manual focus

Usage

You can create a Viewport by calling the AddViewport method on a Groupbox.

Arguments

local Viewport = Groupbox:AddViewport("MyViewport", {
    Object = Instance.new("Part"),
    Camera = Instance.new("Camera"),
    Interactive = true,
    AutoFocus = true,
    Height = 200,
})

Arg Idx	Argument Description	Type	Default
1	Index/ID of the viewport element	string	nil
2	Viewport configuration table	table	nil

Configuration Table

Prop

Type

Methods

You can use the following methods to interact with the viewport element:

SetObject

Changes the displayed 3D object.

Viewport:SetObject(object)

Arg Idx	Argument Description	Type	Default
1	Object instance to display	Instance	nil

SetCamera

Updates the camera instance.

Viewport:SetCamera(camera)

Arg Idx	Argument Description	Type	Default
1	Camera instance	Instance (Camera)	nil

SetInteractive

Toggles user interaction.

Viewport:SetInteractive(interactive)

Arg Idx	Argument Description	Type	Default
1	Whether the viewport is interactive	boolean	nil

SetHeight

Adjusts the viewport frame height.

Viewport:SetHeight(height)

Arg Idx	Argument Description	Type	Default
1	Frame height in pixels	number	nil

Focus

Focuses the camera on the object.

Viewport:Focus()

Arg Idx	Argument Description	Type	Default
1	No arguments	–	–

Example

local Options = Library.Options
 
local Viewport = Groupbox:AddViewport("DemoViewport", {
    Object = Instance.new("Part"),
    Camera = Instance.new("Camera"),
    Interactive = true,
    AutoFocus = true,
    Height = 240,
})
 
Viewport:SetInteractive(true)
Viewport:SetHeight(260)
Viewport:Focus()

Viewport

On this page