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 "key" in menu_bookDocumentation 73 results closeClear
menu_bookDocumentation
May 5, 2026

Scene Metadata - s&box Scene Documentation

Scene Metadata You can implement the interface in any Component that has data you'd like saved to Metadata. Metadata is data that can be accessed without needin…

menu_bookDocumentation
May 3, 2026

Particle Effects System

Particle Effects System CPU-simulated, fully controllable particle system for effects like fire, smoke, sparks, and explosions. Architecture The particle system…

menu_bookDocumentation
May 4, 2026

s&box CharacterController: Physics-Free Movement Component

s&box CharacterController: Physics-Free Movement Component provides collision-constrained movement without a . It only moves when you explicitly call or . Key P…

menu_bookDocumentation
May 3, 2026

Custom Editors

Custom Editors Create custom editor widgets for your classes, structs, and assets. ControlWidget (Property Editor) Create custom property editors using : Attrib…

menu_bookDocumentation
May 4, 2026

Sandbox: Hydraulic tool — motorized SliderJoint with LineRenderer shaft

Sandbox Hydraulic Tool — Motorized SliderJoint Constraints The Hydraulic tool creates a between two objects with a component that can extend and retract the joi…

menu_bookDocumentation
May 4, 2026

Sandbox: CleanupSystem — full scene cleanup and per-player cleanup with Ownable

Sandbox CleanupSystem — Scene Cleanup and Per-Player Cleanup is a that handles cleaning up spawned objects. It distinguishes between "baseline" objects (part of…

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…

menu_bookDocumentation
May 20, 2026

Razor Panels: HTML/CSS UI with C# in s&box PanelComponent System

s&box Razor Panels use web-like HTML/CSS syntax with C# for UI creation. Panels are rendered natively (not via HTML renderer) — the syntax is a convenience laye…

menu_bookDocumentation
May 20, 2026

Component Versioning: JsonUpgrader for Breaking Property Changes in s&box

s&box Component Versioning lets you define upgraders for breaking changes like property renames or data structure changes. Upgrades are chained — if a component…

menu_bookDocumentation
May 20, 2026

Animation System: Animgraph, Skeletal Animation, IK, and Ragdolls

s&box uses Valve's Animgraph system for character animation, providing a powerful node-based animation state machine. Key Features Animgraph — node-based animat…

menu_bookDocumentation
May 20, 2026

Hotloading: Live Code Reload Without Editor Restart in s&box

s&box hotloading recompiles and live-reloads code when you save or files, without restarting the editor. How It Works IL Hotload (Fast): If only method bodies c…

menu_bookDocumentation
May 4, 2026

ScenePhysicsSystem: Physics Sub-Stepping at 120Hz, Collision Event Routing, Keyframe Colliders, and Editor Physics

ScenePhysicsSystem: How Physics Steps Work in s&box is the built-in that drives physics simulation. Understanding it explains the physics step order and collisi…

menu_bookDocumentation
May 4, 2026

Collider Component: Triggers, Surface Properties, Keyframe Bodies, Concave Shapes, and Tag Propagation

Collider Component: Triggers, Surface Properties, and Keyframe Bodies The abstract base class is the foundation for all physics colliders in s&box (, , , , ). T…