s&
About
The Project
infoAbout s&box mapRoadmap monitoringMetricsEngine startup and usage numbers
Updates
newspaperLatest News published_with_changesChangesRelease-by-release changelog
Games
Browse Games Discover Games
gamejamslive now

Game Jam III

Ends Fri 25 Sep
ThemeOne More Round

The jam is running. Build something, or play the entries.

£50,000
prizepool
View the jam
Workshop
Playable
sports_esportsGamesStandalone games and gamemodes
Assets
landscapeMaps view_in_arModels textureMaterials apparelClothing
appsEverythingEvery asset type in one list
Forum
Learn
Documentation
rocket_launchGetting Started docsDocumentation apiAPI Reference
Resources
schoolTutorials manage_searchCode Search
inputLog in with Steam
Api
Classes
DockHost
chevron_left Classes
class
DockHost

Constructors

functionsDockHost

Properties

data_objectItemsdata_objectState

Methods

functionsActivatefunctionsClosefunctionsDockfunctionsFindfunctionsIsOpenfunctionsOnDeletedfunctionsRegisterfunctionsRestoreStatefunctionsTick
DockHost
Tabbed panel docking with nested splits. Registered content is owned until this host is deleted or transfers it.
class Sandbox.UI .account_tree extends Panel
Sandbox.Engine

build Constructors 1

DockHost ()
Creates an empty docking workspace.

data_object Properties 2

Items
IReadOnlyCollection`1
All registered panels, including closed panels.
State
string
Saves tab order, selection and split proportions. Closed panels are omitted.

functions Methods 9

Activate (id)
bool
Selects an open panel without moving it.
Close (id)
bool
Closes a panel without deleting its content. Nonclosable panels are left open.
Dock (id, relativeTo, position, fraction, tabIndex)
Opens or moves a registered panel. Edge fractions describe the incoming panel's share.
Find (id)
DockItem
Finds a registered panel, including closed panels.
IsOpen (id)
bool
Whether a registered panel is in the layout.
OnDeleted ()
Register (id, title, content, canClose, icon)
DockItem
Registers content, initially closed. A panel instance can belong to only one registration.
RestoreState (json)
bool
Restores a valid layout atomically. Open nonclosable panels must remain present.
Tick ()

Inheritance

Panel
DockHost
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.
Facepunch
  • News
  • Docs
  • Metrics
  • FAQ
  • Forum
  • Discord
  • Twitter