ViewportFrame 是一個 GuiObject ，可以渲染其邊界內的 3D 對象，提供一種方法來在 2D 空間中顯示 3D 對象，如 ScreenGui 。此對象有以下限制：
沒有陰影或後期處理效果被渲染。
Enum.Material.Neon 和 Enum.Material.Glass 材料以最低品質渲染。
巢穴 GuiObjects 不受支持。
預設情況下，在 ViewportFrame 內照明會作為如果 Lighting.EnvironmentSpecularScale 和 Lighting.EnvironmentDiffuseScale 都設為 0 一樣，因此依賴這些欄位的屬性，例如 SurfaceAppearance.MetalnessMap，可能會看起來不同。
範例程式碼
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local playerGui = player:WaitForChild("PlayerGui")
local screenGui = Instance.new("ScreenGui")
screenGui.Parent = playerGui
local viewportFrame = Instance.new("ViewportFrame")
viewportFrame.Size = UDim2.new(0.3, 0, 0.4, 0)
viewportFrame.Position = UDim2.new(0, 15, 0, 15)
viewportFrame.BackgroundColor3 = Color3.new(0, 0, 0)
viewportFrame.BorderColor3 = Color3.new(0.6, 0.5, 0.4)
viewportFrame.BorderSizePixel = 2
viewportFrame.BackgroundTransparency = 0.25
viewportFrame.Parent = screenGui
local part = Instance.new("Part")
part.Material = Enum.Material.Concrete
part.Color = Color3.new(0.25, 0.75, 1)
part.Position = Vector3.new(0, 0, 0)
part.Parent = viewportFrame
local viewportCamera = Instance.new("Camera")
viewportFrame.CurrentCamera = viewportCamera
viewportCamera.Parent = viewportFrame
viewportCamera.CFrame = CFrame.new(Vector3.new(0, 2, 12), part.Position)local Players = game:GetService("Players")
local player = Players.LocalPlayer
local playerGui = player:WaitForChild("PlayerGui")
local screenGui = Instance.new("ScreenGui")
screenGui.Parent = playerGui
local TweenService = game:GetService("TweenService")
local viewportFrame = Instance.new("ViewportFrame")
viewportFrame.Size = UDim2.new(0.3, 0, 0.4, 0)
viewportFrame.Position = UDim2.new(0, 15, 0, 15)
viewportFrame.BackgroundColor3 = Color3.new(0, 0, 0)
viewportFrame.BorderColor3 = Color3.new(0.6, 0.5, 0.4)
viewportFrame.BorderSizePixel = 2
viewportFrame.BackgroundTransparency = 0.25
viewportFrame.Parent = screenGui
local part = Instance.new("Part")
part.Material = Enum.Material.Concrete
part.Color = Color3.new(0.25, 0.75, 1)
part.Position = Vector3.new(0, 0, 0)
part.Parent = viewportFrame
local viewportCamera = Instance.new("Camera")
viewportFrame.CurrentCamera = viewportCamera
viewportCamera.Parent = viewportFrame
viewportCamera.CFrame = CFrame.new(Vector3.new(0, 2, 12), part.Position)
task.wait(2)
local cameraGoal = {
CFrame = CFrame.new(Vector3.new(0, 6, 4), part.Position),
}
local tweenInfo = TweenInfo.new(2, Enum.EasingStyle.Quad, Enum.EasingDirection.Out)
local tween = TweenService:Create(viewportCamera, tweenInfo, cameraGoal)
tween:Play()概要
屬性
適用於 ViewportFrame 內的區域的照明顏色。
Camera 用於渲染兒童對象。
決定渲染視窗圖像的顏色化方式。
決定渲染視窗圖像的透明度。
發射的光的顏色。
A Vector3 代表光原始碼的方向。
屬性
決定這個介面元素是否會沉沒輸入。
決定 GuiObject 的起始點，相對於其絕對尺寸。
決定是否基於兒童內容進行縮放。
決定 GuiObject 背景顏色。
決定 GuiObject 背景和邊框的透明度。
決定 GuiObject 邊框的顏色。
決定在哪種方式下 GuiObject 邊界被布置在其尺寸相對。
決定 GuiObject 邊框的像素寬度。
決定是否在父 GUI 元素的範圍之外成像子元素 GuiObjects 。
決定玩家的鼠標是否在 GuiObject 上被主動按下。
控制使用 GuiObject 與 UIGridStyleLayout 時的排序順序。
設置在遊戲控制器選擇器向下移動時會選擇的 GuiObject 。
設置在遊戲控制器選擇器移動到左側時會選擇的 GuiObject 。
設置在遊戲控制器選擇器移動到右側時會選擇的 GuiObject 。
設置在遊戲控制器選擇器向上移動時會選擇的 GuiObject 。
決定 GuiObject 的像素和向量位置。
決定旋轉 GuiObject 的角度數量。
確定是否可以由遊戲控制器選擇 GuiObject 。
覆蓋使用於遊戲板的預設選擇裝飾。
由遊戲控制器介面選擇所選擇的 GuiObjects 順序。
決定 GuiObject 的像素和積分尺寸。
混合屬性 BackgroundTransparency 和 TextTransparency 。
決定是否渲染 GuiObject 和其子孫。
決定 GuiObject 對其他人的相對順序進行渲染。
屬性
方法
方法 繼承自 GuiObject方法
- TweenPosition(endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : boolean,callback : function):boolean
順暢將 GUI 移動到新的 UDim2 。
- TweenSize(endSize : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : boolean,callback : function):boolean
- TweenSizeAndPosition(endSize : UDim2,endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : boolean,callback : function):boolean
順暢將 GUI 移動到新的尺寸和位置。
活動
活動 繼承自 GuiObject活動
當使用者開始使用人工智慧與電腦介面裝置（例如滑鼠按鈕向下、觸摸開始、鍵盤按鈕向下等）時發射。
當使用者變更如何透過人工智慧與電腦介面裝置（滑鼠按鈕向下、觸摸開始、鍵盤按鈕向下等）進行互動時，發射時間。
當使用者停止使用人工智慧與電腦介面裝置（例如：滑鼠按鈕向下、觸摸開始、鍵盤按鈕向下等）互動時，發射。
當使用者將鼠標移到 GUI 元素時發生火災。
當使用者將鼠標移出 GUI 元素時發生火災。
在使用者移動滑鼠時，無論在哪個GUI元素內，都會發生火災。
當使用者滾動滑鼠輪時，滑鼠停在 GUI 元素上時，發生火災。
當使用者將滑鼠輪向前滾動時，發生火災，當滑鼠在 GUI 元素上時。
當使用遊戲控制器選擇器將 GuiObject 聚焦時，發射。
當遊戲控制器選擇器停止關注 GuiObject 時發射。
當玩家開始、繼續並停止長按 UI 元素時，發生火災。
- TouchPan(touchPositions : Array,totalTranslation : Vector2,velocity : Vector2,state : Enum.UserInputState):RBXScriptSignal
當玩家在介面元素上移動手指時發生火災。
- TouchPinch(touchPositions : Array,scale : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
當玩家使用介面元素上的兩個手指執行撥動或拉動動作時，發生火焰。
- TouchRotate(touchPositions : Array,rotation : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
當玩家使用介面元素上的兩個手指執行旋轉動作時，發生火災。
當玩家在介面元素上執行滑動動作時，發生火災。
當玩家在介面元素上執行點擊動作時，發生火焰。
活動
- SelectionChanged(amISelected : boolean,previousSelection : GuiObject,newSelection : GuiObject):RBXScriptSignal
當遊戲控制器選擇移動到、離開或變更連接的 GuiBase2d 或任何子控制器 GuiObjects 時發生火災。
屬性
CurrentCamera
Camera 用於渲染子對象的實例。默認為 nil 。
Camera 對象不會複製，因此 ViewportFrame.CurrentCamera 也不會複製。當您設置此屬性時， 和 將被保存並複製到內部，以便客戶端可以無需 對物件來渲染框架。
ImageColor3
此屬性決定渲染視窗圖像的顏色，可以讓您無需直接修改渲染對物件就可以變更顏色。預設色化值是
也參見 ImageTransparency ，這會決定渲染圖像的透明度。
ImageTransparency
此屬性決定渲染視窗圖像的透明度，允許您無需直接修改渲染對物件就可以更改透明度。值 0 （預設值）完全不透明，值 1 完全透明（隱形）。
請參閱ImageColor3，這會決定渲染圖像將如何被彩色。