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
gamejams
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
Get s&box
Sign in with Steam
Api
Classes
WorldPanel
chevron_left Classes
class
WorldPanel

Constructors

functionsWorldPanel

Properties

data_objectLightingdata_objectMaxInteractionDistancedata_objectPositiondata_objectRotationdata_objectTagsdata_objectTransformdata_objectWorldScale

Methods

functionsDeletefunctionsOnDeletedfunctionsRayToLocalPositionlockUpdateBoundslockUpdateScale

Static Properties

data_objectScreenToWorldScale
WorldPanel
An interactive 2D panel rendered in the 3D world.
class Sandbox.UI .account_tree extends RootPanel
Sandbox.Engine

build Constructors 1

WorldPanel (world)

data_object Properties 7

Lighting
bool
Whether the panel is affected by lighting.
MaxInteractionDistance
float
Maximum distance at which a player can interact with this world panel.
Position
Vector3
Position of the world panel in 3D space.
Rotation
Rotation
Rotation of the world panel in 3D space.
Tags
ITagSet
Tags that are applied to the underlying SceneObject
Transform
Transform
Transform of the world panel in 3D space.
WorldScale
float
Scale of the world panel in 3D space.

functions Methods 5

Delete (immediate)
OnDeleted ()
RayToLocalPosition (ray, position, distance)
bool
UpdateBounds (rect)
Update the bounds for this panel. We purposely do nothing here because on world panels you can change the bounds by setting Sandbox.UI.RootPanel.PanelBounds.
UpdateScale (screenSize)
We override this to prevent the scale automatically being set based on screen size changing.. because that's obviously not needed here.

data_object Static Properties 1

ScreenToWorldScale
float

Inheritance

Panel
RootPanel
WorldPanel
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