SceneFrame
Renders a separate three-dimensional scene inside an interface.
Behavior
SceneFrame renders a separate three-dimensional scene inside an interface.
Summary
The resolved top-left position of this interface element in pixels.
The resolved rotation of this interface element in degrees, including ancestor rotation.
The resolved width and height of this interface element in pixels.
Whether this interface accepts and consumes input.
The ambient light color used for the SceneFrame scene.
The normalized point within the element used as the origin for Position.
The dimensions that resize to fit the element's content.
The color used to fill the element's background.
The background transparency, from 0 for opaque to 1 for invisible.
The color of the element's border.
Whether the border is drawn outside, across, or inside the element's bounds.
The border thickness in pixels.
The camera transform used to render the SceneFrame.
Whether descendant rendering is clipped to this element's bounds.
The corner radius used for the element's rounded background.
The individual corner radii used for the element's rounded background.
The Camera used by the SceneFrame.
Whether pointer dragging can move the element.
The environment instance used to light the SceneFrame scene.
The vertical field of view of the SceneFrame camera, in degrees.
Whether the SceneFrame camera is positioned manually, fitted to contents, or orbited.
The padding included when fitting the camera to scene contents.
The share of remaining main-axis space assigned to this child in flow layout.
The element's current idle, hover, pressed, or non-interactable state.
Which input events this element consumes before they reach elements behind it.
Whether the element accepts interaction.
Whether children use flow layout or their explicit positions.
The numeric order of this element when a parent layout sorts by layout order.
The directional light intensity used for the SceneFrame scene.
The directional light color used for the SceneFrame scene.
The directional light vector used for the SceneFrame scene.
The interface element selected when navigating down from this element.
The interface element selected when navigating left from this element.
The interface element selected when navigating right from this element.
The interface element selected when navigating up from this element.
The opacity multiplier applied to this element and its descendants.
The angular speed used when the SceneFrame camera orbits its contents.
The element position relative to its parent.
Whether the SceneFrame renders on changes, every frame, or only on request.
The resolution used for the captured reflection.
The interface rotation in degrees.
Whether interface navigation can select this element.
The interface element used to draw the selection indicator.
The numeric order used for interface selection traversal.
Whether the SceneFrame includes the main world in its rendered scene.
The element size relative to its parent.
The parent axes used to resolve relative interface size.
The color tint applied to the rendered SceneFrame image.
The transparency of the SceneFrame tint.
Whether this interface element is rendered.
The element's draw-order index.
Gives keyboard focus to this interface element.
Returns the bounds of the SceneFrame's scene contents.
Returns this instance if it is an ExecutionGroup.
Requests another SceneFrame render when using manual rendering.
Removes keyboard focus from this interface element.
Fires when pointer dragging of the element begins.
Fires when pointer dragging of the element ends.
Fires when input begins over or is dispatched to this interface element.
Fires when input dispatched to this element changes.
Fires when input dispatched to this element ends.
Fires when the mouse wheel scrolls backward over this element.
Fires when the mouse wheel scrolls forward over this element.
Fires when the pointer enters the SceneFrame.
Fires when the pointer leaves the SceneFrame.
Fires when the pointer moves within the SceneFrame.
Fires when interface navigation selects this element.
Fires when this element loses interface selection.
Properties
AbsolutePosition
SceneFrame.AbsolutePosition: Vector2 = Vector2.new(0, 0)The resolved top-left position of this interface element in pixels.
AbsoluteRotation
SceneFrame.AbsoluteRotation: number = 0The resolved rotation of this interface element in degrees, including ancestor rotation.
AbsoluteSize
SceneFrame.AbsoluteSize: Vector2 = Vector2.new(0, 0)The resolved width and height of this interface element in pixels.
Active
SceneFrame.Active: boolean = falseWhether this interface accepts and consumes input.
Ambient
SceneFrame.Ambient: Color3 = Color3.new(0.34, 0.35, 0.38)The ambient light color used for the SceneFrame scene.
AnchorPoint
SceneFrame.AnchorPoint: Vector2 = Vector2.new(0, 0)The normalized point within the element used as the origin for Position. (0, 0) is the top-left corner; (0.5, 0.5) is the center.
AutomaticSize
SceneFrame.AutomaticSize: Enum.AutomaticSize = Enum.AutomaticSize.NoneThe dimensions that resize to fit the element's content.
BackgroundColor3
SceneFrame.BackgroundColor3: Color3 = Color3.new(0.6392157, 0.63529414, 0.64705884)The color used to fill the element's background.
BackgroundTransparency
SceneFrame.BackgroundTransparency: number = 0The background transparency, from 0 for opaque to 1 for invisible.
BorderColor3
SceneFrame.BorderColor3: Color3 = Color3.new(0.105882354, 0.16470589, 0.20784314)The color of the element's border.
BorderMode
SceneFrame.BorderMode: Enum.BorderMode = Enum.BorderMode.OutlineWhether the border is drawn outside, across, or inside the element's bounds.
BorderSizePixel
SceneFrame.BorderSizePixel: number = 1The border thickness in pixels.
CameraCFrame
SceneFrame.CameraCFrame: CFrame = CFrame.new(0, 0, 0)The camera transform used to render the SceneFrame.
ClipsDescendants
SceneFrame.ClipsDescendants: boolean = falseWhether descendant rendering is clipped to this element's bounds.
CornerRadius
SceneFrame.CornerRadius: number = 0The corner radius used for the element's rounded background.
Corners
SceneFrame.Corners: { number } = {}The individual corner radii used for the element's rounded background.
CurrentCamera
SceneFrame.CurrentCamera: Camera? = nilThe Camera used by the SceneFrame.
Draggable
SceneFrame.Draggable: boolean = falseWhether pointer dragging can move the element.
Environment
SceneFrame.Environment: boolean = trueThe environment instance used to light the SceneFrame scene.
FieldOfView
SceneFrame.FieldOfView: number = 30The vertical field of view of the SceneFrame camera, in degrees.
Framing
SceneFrame.Framing: Enum.SceneFraming = Enum.SceneFraming.FitWhether the SceneFrame camera is positioned manually, fitted to contents, or orbited.
FramingPadding
SceneFrame.FramingPadding: number = 1.18The padding included when fitting the camera to scene contents.
Grow
SceneFrame.Grow: number = 0The share of remaining main-axis space assigned to this child in flow layout.
GuiState
SceneFrame.GuiState: Enum.GuiState = Enum.GuiState.IdleThe element's current idle, hover, pressed, or non-interactable state.
InputSink
SceneFrame.InputSink: Enum.InputSink = Enum.InputSink.NoneWhich input events this element consumes before they reach elements behind it.
Interactable
SceneFrame.Interactable: boolean = trueWhether the element accepts interaction.
Layout
SceneFrame.Layout: Enum.Layout = Enum.Layout.FlowWhether children use flow layout or their explicit positions.
LayoutOrder
SceneFrame.LayoutOrder: number = 0The numeric order of this element when a parent layout sorts by layout order.
LightBrightness
SceneFrame.LightBrightness: number = 2The directional light intensity used for the SceneFrame scene.
LightColor
SceneFrame.LightColor: Color3 = Color3.new(1, 0.97, 0.92)The directional light color used for the SceneFrame scene.
LightDirection
SceneFrame.LightDirection: Vector3 = Vector3.new(0.45, -0.72, -0.53)The directional light vector used for the SceneFrame scene.
NextSelectionDown
SceneFrame.NextSelectionDown: GuiObject? = nilThe interface element selected when navigating down from this element.
NextSelectionLeft
SceneFrame.NextSelectionLeft: GuiObject? = nilThe interface element selected when navigating left from this element.
NextSelectionRight
SceneFrame.NextSelectionRight: GuiObject? = nilThe interface element selected when navigating right from this element.
NextSelectionUp
SceneFrame.NextSelectionUp: GuiObject? = nilThe interface element selected when navigating up from this element.
Opacity
SceneFrame.Opacity: number = 1The opacity multiplier applied to this element and its descendants.
OrbitSpeed
SceneFrame.OrbitSpeed: number = 24The angular speed used when the SceneFrame camera orbits its contents.
Position
The element position relative to its parent. Scale components use the parent size; offsets are in pixels.
RenderMode
SceneFrame.RenderMode: Enum.SceneRenderMode = Enum.SceneRenderMode.OnChangeWhether the SceneFrame renders on changes, every frame, or only on request.
Resolution
SceneFrame.Resolution: number = 1The resolution used for the captured reflection.
Rotation
SceneFrame.Rotation: number = 0The interface rotation in degrees.
Selectable
SceneFrame.Selectable: boolean = falseWhether interface navigation can select this element.
SelectionImageObject
SceneFrame.SelectionImageObject: GuiObject? = nilThe interface element used to draw the selection indicator.
SelectionOrder
SceneFrame.SelectionOrder: number = 0The numeric order used for interface selection traversal.
ShowsWorld
SceneFrame.ShowsWorld: boolean = falseWhether the SceneFrame includes the main world in its rendered scene.
Size
The element size relative to its parent. Scale components use the parent size; offsets are in pixels.
SizeConstraint
SceneFrame.SizeConstraint: Enum.SizeConstraint = Enum.SizeConstraint.RelativeXYThe parent axes used to resolve relative interface size.
Tint
SceneFrame.Tint: Color3 = Color3.new(1, 1, 1)The color tint applied to the rendered SceneFrame image.
TintTransparency
SceneFrame.TintTransparency: number = 0The transparency of the SceneFrame tint.
Visible
SceneFrame.Visible: boolean = trueWhether this interface element is rendered.
ZIndex
SceneFrame.ZIndex: number = 1The element's draw-order index. Interpretation depends on the root's ZIndexBehavior.
Methods
CaptureFocus
SceneFrame:CaptureFocus(): ()Gives keyboard focus to this interface element.
GetContentBounds
Returns the bounds of the SceneFrame's scene contents.
GetExecutionGroup
SceneFrame:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Redraw
SceneFrame:Redraw(): ()Requests another SceneFrame render when using manual rendering.
ReleaseFocus
SceneFrame:ReleaseFocus(): ()Removes keyboard focus from this interface element.
Events
DragBegin
SceneFrame.DragBegin: RBXScriptSignalFires when pointer dragging of the element begins.
DragStopped
SceneFrame.DragStopped: RBXScriptSignalFires when pointer dragging of the element ends.
InputBegan
SceneFrame.InputBegan: RBXScriptSignalFires when input begins over or is dispatched to this interface element.
InputChanged
SceneFrame.InputChanged: RBXScriptSignalFires when input dispatched to this element changes.
InputEnded
SceneFrame.InputEnded: RBXScriptSignalFires when input dispatched to this element ends.
MouseWheelBackward
SceneFrame.MouseWheelBackward: RBXScriptSignalFires when the mouse wheel scrolls backward over this element.
MouseWheelForward
SceneFrame.MouseWheelForward: RBXScriptSignalFires when the mouse wheel scrolls forward over this element.
PointerEntered
SceneFrame.PointerEntered: RBXScriptSignalFires when the pointer enters the SceneFrame.
PointerExited
SceneFrame.PointerExited: RBXScriptSignalFires when the pointer leaves the SceneFrame.
PointerMoved
SceneFrame.PointerMoved: RBXScriptSignalFires when the pointer moves within the SceneFrame.
SelectionGained
SceneFrame.SelectionGained: RBXScriptSignalFires when interface navigation selects this element.
SelectionLost
SceneFrame.SelectionLost: RBXScriptSignalFires when this element loses interface selection.
Inherited members
- Properties
- CatchesPointer
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying