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 "box" 466 results closeClear
terminalCode Example
May 3, 2026

Razor Panel Structure and Syntax

Razor Panel Structure s&box uses Razor syntax for UI panels with files and optional stylesheets. Basic Panel Component File Structure The Element The element is…

terminalCode Example
May 3, 2026

WebSockets

Use WebSockets for real-time communication with external servers. Basic Setup With Auth Token Common Use Cases Custom networking — External matchmaking, chat se…

terminalCode Example
May 18, 2026

Randomized Clothing for NPC Citizens using Dresser.Randomize() on Prefabs

Overview This demonstrates how to create NPC citizen prefabs with randomized clothing using the built-in component. Each time the prefab spawns or is enabled, i…

terminalCode Example
May 3, 2026

Leaderboards API

Implement leaderboards using s&box Services API. Submitting Scores Reading Leaderboards Leaderboard Entry Properties Web API Access Query leaderboards from exte…

codeAPI Reference
May 12, 2026

s&box ScriptedEmitter: Particle emitter GameResource

ScriptedEmitter GameResource API Reference ScriptedEmitter is a GameResource that defines a particle/VFX emitter with a prefab, used for spawning visual effects…

menu_bookDocumentation
May 5, 2026

Component Events - s&box Scene Documentation

Component Events Components can broadcast and listen for events. This provides a decoupled way for components to communicate without direct references. Event In…

codeAPI Reference
May 12, 2026

s&box WheelDefinition: Wheel type GameResource

WheelDefinition GameResource API Reference WheelDefinition is a GameResource that defines a wheel type with a prefab, used by the Wheel tool to spawn wheels. Ty…

codeAPI Reference
May 12, 2026

TraceAttackInfo record struct

TraceAttackInfo Record Struct Information about a trace-based attack in s&box, used to pass attack data through the weapon system. Properties Target () - The Ga…

groupsCommunity
May 3, 2026

Debugging and Profiling Tips

Debugging and Profiling Tips Community guide for debugging s&box games based on official tools and developer recommendations. Console Commands Useful built-in c…

codeAPI Reference
May 12, 2026

s&box ScriptedEntity: Custom entity GameResource

ScriptedEntity GameResource API Reference ScriptedEntity is a GameResource that defines a spawnable entity with a prefab, used by the spawn menu to create custo…

menu_bookDocumentation
May 12, 2026

s&box ISpawnerExtensions: Creating spawner instances

ISpawnerExtensions: Creating ISpawner Instances ISpawnerExtensions provides an extension method to create ISpawner instances from type strings, supporting vario…

menu_bookDocumentation
May 12, 2026

Rpc.FilterInclude for targeted RPC broadcasting

Rpc.FilterInclude for Targeted RPC Broadcasting Rpc.FilterInclude is a using statement in s&box that restricts RPC broadcasts to specific connections only. This…

menu_bookDocumentation
May 5, 2026

Styling Panels - s&box UI Documentation

Styling Panels Style your UI panels using SCSS-like stylesheets or direct code styling. Using Stylesheets Create files alongside your files: Or specify a differ…

menu_bookDocumentation
May 12, 2026

s&box HUD: UI scale factor

HUD Static Class HUD is an internal static class that provides a scale factor for UI elements based on screen resolution. It ensures UI elements scale proportio…

codeAPI Reference
May 12, 2026

s&box ManualLink: Logical link component

ManualLink Component API Reference ManualLink is a Component that creates a non-physics logical link between two GameObjects, used by the Linker tool to group u…

codeAPI Reference
May 12, 2026

s&box ThrusterDefinition: Thruster type GameResource

ThrusterDefinition GameResource API Reference ThrusterDefinition is a GameResource that defines a thruster type with a prefab, used by the Thruster tool to spaw…

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…

menu_bookDocumentation
May 3, 2026

Component Lifecycle Methods Reference

Component Lifecycle Methods s&box Components have a well-defined lifecycle with specific methods you can override for different phases of initialization and upd…

terminalCode Example
May 3, 2026

BaseWeapon and BaseCarryable Weapon Framework

BaseWeapon and BaseCarryable - Weapon Framework Base classes for creating weapons in s&box. Provides ammo management, view/world models, and input handling. Bas…