s&box MCP Knowledgebase

Documentation, API references, code examples and community knowledge for s&box development.

library_books 595 entries menu_book 352 Documentation code 133 API Reference terminal 100 Code Example groups 10 Community
Results for "Scene" 187 results closeClear
terminalCode Example
May 12, 2026

UndoSystem: Per-player undo functionality

UndoSystem: Per-Player Undo Functionality This example shows the UndoSystem which provides per-player undo stacks for tracking spawned objects and allowing play…

menu_bookDocumentation
May 20, 2026

Creating Terrain: Heightmap Setup, World Scale, and Asset Reuse

To add Terrain to your s&box scene, right-click in the Hierarchy and select 3D Object → Terrain. The inspector prompts you to create, import, or link an existin…

menu_bookDocumentation
May 12, 2026

LocalData static class: Server-side data persistence

LocalData Static Class API Reference LocalData provides server-side data persistence that survives server restarts. It's useful for storing configuration, ban l…

menu_bookDocumentation
May 4, 2026

s&box Component Lifecycle: Exact Execution Order and Internal Guards

s&box Component Lifecycle: Exact Execution Order and Internal Guards Derived directly from and in the s&box engine source. Execution Order **** — Called once wh…

terminalCode Example
May 4, 2026

Sandbox: ControlSystem — vehicle seat and contraption control with IPlayerControllable

ControlSystem — Vehicle Seat and Contraption Control is a that drives components on contraptions. When a player sits in a , the system walks the connected contr…

terminalCode Example
May 3, 2026

BanSystem Pattern for Player Management

BanSystem - Player Ban Management A GameObjectSystem that manages player bans with persistent storage. Demonstrates , persistence, and RPC commands. Implementat…

menu_bookDocumentation
May 20, 2026

Component Versioning: JsonUpgrader for Scene and Prefab Migration

s&box component versioning uses attributes and the property to migrate serialized scene/prefab data when you make breaking changes to component properties. This…

terminalCode Example
May 3, 2026

ControlSystem Pattern for Seat/Vehicle Control

ControlSystem - Seat/Vehicle Control Management A that manages control transfer between players and seated entities (vehicles, chairs). Handles input routing an…

terminalCode Example
May 5, 2026

Scene lighting setup — DirectionalLight, PointLight, SpotLight, SkyBox, AmbientLight, and Fog

Scene Lighting Setup s&box lighting is built from components. A typical scene needs a directional light (sun), ambient light, and a skybox. Directional Light (S…

menu_bookDocumentation
May 12, 2026

s&box DupeCategory: Workshop duper categories

s&box DupeCategory Enum DupeCategory is an enum used to categorize workshop dupes for filtering and browsing. Each category has an associated icon for UI displa…

terminalCode Example
May 5, 2026

Custom editor tools — EditorTool, Gizmo drawing, scene tracing, and overlay UI

Custom Editor Tools Editor tools appear in the s&box toolbar and let you build scene editing workflows — painting, placement, custom gizmos. They must live in a…

groupsCommunity
May 5, 2026

Common s&box component gotchas — physics, networking, scene, and rendering pitfalls

Common s&box Component Gotchas Practical pitfalls that catch most new s&box developers. Physics Rigidbody + CharacterController on the same GO — don't do it. Th…

terminalCode Example
May 12, 2026

Automatic water volume setup with buoyancy physics

Automatic Water Volume Setup with Buoyancy This example shows automatic attachment of WaterVolume components to colliders tagged "water" and buoyancy physics im…

terminalCode Example
May 12, 2026

s&box Hints GameObjectSystem: UI hint queue

Hints GameObjectSystem Example Hints is a GameObjectSystem that manages the display of timed popup hints in the UI. It queues hints with delays and displays the…

menu_bookDocumentation
May 20, 2026

Scene Events: Interface-Based Broadcasting and Listening

s&box uses interface-based events to broadcast and listen to events within a scene. Events are sent to active Components and GameObjectSystems — they are NOT se…

codeAPI Reference
May 12, 2026

s&box ScriptedEmitterModel: Model-based emitter resource

ScriptedEmitterModel GameResource API Reference ScriptedEmitterModel is a GameResource for model-based particle/VFX emitters. It implements IDefinitionResource …

codeAPI Reference
May 12, 2026

s&box PostProcessManager: Post-processing resource management

PostProcessManager API Reference PostProcessManager is a GameObjectSystem that manages post-processing resources with preview, toggle, and camera attachment. Ty…

codeAPI Reference
May 3, 2026

Global.ISpawnEvents Spawn Event Interface

Global.ISpawnEvents Interface Scene-wide event interface for listening to spawn operations. Implement on components to receive pre/post spawn callbacks. Interfa…

menu_bookDocumentation
May 4, 2026

Sandbox: PlayerInventory — weapon slots, pickup, drop, and loadout persistence

Sandbox PlayerInventory — Weapon Slots, Pickup, Drop, and Loadout Persistence manages up to 6 weapon slots, handles pickup/drop logic, and delegates loadout sav…

menu_bookDocumentation
May 4, 2026

ScreenPanel and WorldPanel: AutoScale Strategies, ZIndex, LookAtCamera, and Interaction Range

ScreenPanel and WorldPanel: UI Components in s&box Scenes ScreenPanel is the root component for 2D screen-space UI. It renders attached children to the screen. …