API ReferenceSandbox

public sealed class Sandbox.ScreenPanel : Sandbox.Component

Renders any attached PanelComponents to the screen. Acts as the root for all your UI components.

Broader workflow and conceptual references connected to this API.

UI can also be created using Razor, which allows you to use web-like HTML/CSS to create and style each Panel while also being able to leverage C#.

Our UI system is structured around Panels. A Panel is a c# class that can have parent and child panels.

Constructors

Showing 1 constructors

public ScreenPanel()

Methods

Showing 1 methods

public virtual sealed Sandbox.UI.Panel GetPanel()

Properties

Showing 6 properties

public bool Sandbox.ScreenPanel.AutoScreenScale { get; set; }

public float Sandbox.ScreenPanel.Opacity { get; set; }

public float Sandbox.ScreenPanel.Scale { get; set; }

public Sandbox.ScreenPanel.AutoScale Sandbox.ScreenPanel.ScaleStrategy { get; set; }

public Sandbox.CameraComponent Sandbox.ScreenPanel.TargetCamera { get; set; }

public int Sandbox.ScreenPanel.ZIndex { get; set; }

Metadata

Field	Value
Namespace	`Sandbox`
Type	`class`
Assembly	`Sandbox.Engine`
Doc ID	`T:Sandbox.ScreenPanel`

Screen

Previous Page

ScreenSpaceReflections

Next Page

On this page

Constructors public ScreenPanel()Methods public virtual sealed Sandbox.UI.Panel GetPanel()Properties public System.Boolean Sandbox.ScreenPanel.AutoScreenScale { get; set; }public System.Single Sandbox.ScreenPanel.Opacity { get; set; }public System.Single Sandbox.ScreenPanel.Scale { get; set; }public Sandbox.ScreenPanel.AutoScale Sandbox.ScreenPanel.ScaleStrategy { get; set; }public Sandbox.CameraComponent Sandbox.ScreenPanel.TargetCamera { get; set; }public System.Int32 Sandbox.ScreenPanel.ZIndex { get; set; }Metadata