auto_stories

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
in terminalCode Example 100 results closeClear
terminalCode Example
May 10, 2026

s&box JSONObject Save Data Helper for Components

This s&box-focused sample shows how to programmatically construct and deconstruct JSON for component save data. It is useful for player saves, world unlock stat…

terminalCode Example
May 10, 2026

Extensible Player Data Save Hooks for World Components

This pattern lets gameplay components plug into a player's save/load flow without putting every feature directly inside one large class. The framework has three…

terminalCode Example
May 10, 2026

Trigger-Based Background Music Crossfade Framework

This pattern replaces area music with a small local-client music framework. Each zone requests a target , while one controller crossfades the currently playing …

terminalCode Example
May 10, 2026

Reusable World-Space Interaction Prompt Framework

A small, compartmentalized interaction framework can be built from three pieces: : the base component placed on objects the player can use. : the player-side ra…

terminalCode Example
May 5, 2026

Unit tests in s&box — MSTest setup, engine initialization, and component testing

Unit Tests in s&box s&box supports MSTest-based unit tests. Create a directory in your project folder and restart the editor — a test project is generated autom…

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…

terminalCode Example
May 5, 2026

Custom GameResource assets — defining asset types with ResourceLibrary and PostLoad registry

Custom GameResource Assets lets you define your own asset types with a custom file extension, inspector UI, and hot-reload support. Assets are JSON files under …

terminalCode Example
May 5, 2026

VirtualGrid — efficiently rendering large scrollable lists in s&box UI

VirtualGrid — Efficiently Rendering Large Lists in UI is a s&box UI panel that virtualizes a large collection — only the visible cells are created in the DOM. S…

terminalCode Example
May 5, 2026

Math types — Vector3, Rotation, Angles, Transform, TimeSince, and BBox

Math Types — Vector3, Rotation, Angles, and Transform s&box uses its own math types. Here's a practical reference for the ones you'll use constantly. Vector3 Ro…

terminalCode Example
May 5, 2026

Async tasks in s&box — coroutines, parallel tasks, and frame-by-frame animation

Async Tasks in s&box Components s&box async tasks run on the main thread — they behave like coroutines. Use to yield one frame, to wait, and to run tasks in par…

terminalCode Example
May 5, 2026

DebugOverlay — in-game visualization for spheres, lines, text, and traces

DebugOverlay — In-Editor and In-Game Visualization draws shapes, text, and traces in the world for debugging. All draws are temporary and disappear after a spec…

terminalCode Example
May 5, 2026

ConVar and ConCmd — console variables and commands with flags and game settings

ConVar and ConCmd — Console Variables and Commands and are s&box attributes for exposing variables and commands to the developer console. Console Commands Conso…

terminalCode Example
May 5, 2026

Decal component — projecting bullet holes, scorch marks, and surface details

Decal Component — Projecting Surface Marks projects a texture onto surfaces in the world. Use it for bullet holes, blood splats, scorch marks, graffiti, and any…

terminalCode Example
May 5, 2026

WorldPanel and ScreenPanel — HUD overlays and 3D world-space UI with Razor PanelComponent

WorldPanel and ScreenPanel — UI in the World s&box UI uses (Razor) attached to either a (HUD overlay) or (3D world-space UI). The same component works with both…

terminalCode Example
May 5, 2026

SpawnPoint and TriggerHurt — spawn locations and damage trigger volumes

SpawnPoint and TriggerHurt in s&box SpawnPoint is a built-in s&box component that marks a world location for player or NPC spawning. uses to find valid spawn lo…

terminalCode Example
May 5, 2026

EnvmapProbe — local reflection captures with Static, Dynamic, and OnDemand modes

EnvmapProbe — Reflection Captures in s&box is a built-in s&box component that captures a cubemap at its world position for local specular reflections. The engin…

terminalCode Example
May 5, 2026

Rendering entities — TextRenderer, LineRenderer, SpriteRenderer, TrailRenderer, and ModelRenderer

Rendering Entities — Text, Line, Sprite, and Trail Renderers s&box provides several lightweight renderer components for common visual needs that don't require a…

terminalCode Example
May 5, 2026

ModelPhysics — ragdolls and per-bone physics simulation

ModelPhysics — Ragdolls and Per-Bone Physics drives physics simulation per bone on a skinned model. Use it for ragdolls, destructible characters, and physics-dr…

terminalCode Example
May 5, 2026

RadiusDamage — explosion area damage with IDamageable, occlusion, and physics force

RadiusDamage Component is a built-in s&box component that applies damage to all objects within a sphere. It integrates with the system and can apply outward phy…

terminalCode Example
May 5, 2026

BeamEffect — laser and energy beams between two points

BeamEffect — Laser and Energy Beams renders a beam between two points in the world. Use it for lasers, electricity, tractor beams, or any line-based visual effe…