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 "csharp" 571 results closeClear
menu_bookDocumentation
May 20, 2026

Component Editor Tools: Selection-Based Scene View UI and Gizmos

Component Editor Tools in s&box are always active when a specific Component is selected. They create UI in the scene view and can override input. An example is …

menu_bookDocumentation
May 5, 2026

Prefab instance overrides — customizing instances without breaking the prefab link

Prefab Instance Overrides Prefab instance overrides let you customize individual instances without affecting the original prefab or other instances. The instanc…

menu_bookDocumentation
May 5, 2026

Indirect Light Volumes (DDGI) — dynamic global illumination probe grid

Indirect Light Volumes (DDGI) places a probe grid for dynamic global illumination — light bouncing off surfaces tints nearby objects, and sunlight fades natural…

menu_bookDocumentation
May 4, 2026

ISceneLoadingEvents: Async Scene Load Hooks with BeforeLoad, OnLoad, and AfterLoad

ISceneLoadingEvents: Async Scene Load Hooks Implement on a to hook into the scene loading pipeline. The game waits for async tasks to complete before proceeding…

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

NPC Ragdoll Creation with Clothing Preservation

NPC Ragdoll Creation with Clothing Pattern for creating ragdolls from NPCs including clothing preservation and bone merging. Key APIs **** — copies model, mater…

codeAPI Reference
May 12, 2026

Throwable enum

Throwable Enum Types of throwable weapons for s&box viewmodel animation selection. Values HEGrenade - High-explosive grenade SmokeGrenade - Smoke grenade StunGr…

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…

codeAPI Reference
May 12, 2026

IDefinitionResource interface

IDefinitionResource Interface Interface for s&box game resources that have title and description metadata. Properties Title () - Display title for the resource …

terminalCode Example
May 12, 2026

s&box player management with RPC, ConCmd, and Connection APIs

s&box Player Management with RPC, ConCmd, and Connection APIs This example shows player kick/ban utilities using s&box's Connection, RPC, ConCmd, and Chat syste…

menu_bookDocumentation
May 5, 2026

Network visibility — culling networked objects per client with INetworkVisible

Network Visibility — Culling Networked Objects Per Client Network visibility controls whether a networked object sends updates (Sync Vars, transforms) to a spec…

codeAPI Reference
May 3, 2026

BasePickup with ITriggerListener and ICollisionListener

BasePickup Abstract Class Abstract base for item pickups using trigger and collision detection with host-only consumption. Key Patterns **** — trigger volume pi…

menu_bookDocumentation
May 20, 2026

VirtualGrid: Virtualized Grid Panel for Large Item Collections

is a s&box UI Panel that virtualizes large item collections — only rendering visible cells. If you have thousands of items, it creates only the few on screen an…

menu_bookDocumentation
May 20, 2026

Dedicated Server User Permissions: Claims-Based Access Control via Steam ID

On s&box Dedicated Servers, you can specify admin permissions per user via the file using Steam IDs and claims. Configuration Claims Claims are strings describi…

menu_bookDocumentation
May 20, 2026

Particle Effects: CPU-Simulated Programmable Particle System

The s&box particle system is CPU-simulated (multithreaded) and fully programmable via components. You can emit particles manually, iterate and modify them at ru…

menu_bookDocumentation
May 5, 2026

Your First Project - s&box Documentation

Your First Project Creating Game Objects In s&box, everything in your scene is a GameObject. GameObjects can have Components attached to them that provide funct…

menu_bookDocumentation
May 5, 2026

Component execution order — OnAwake, OnStart, OnUpdate, OnFixedUpdate, and OnLateUpdate

Component Execution Order s&box calls component lifecycle methods in a defined order each frame. Understanding this order is essential for avoiding race conditi…

menu_bookDocumentation
May 4, 2026

GameObjectFlags: DontDestroyOnLoad, NotNetworked, Absolute, and Destroy vs DestroyImmediate

GameObjectFlags: Controlling GameObject Behavior is a flags enum that controls special behaviors for GameObjects. Values Usage ```csharp // Survive scene loads …

terminalCode Example
May 12, 2026

CleanupSystem: Map reset and baseline restoration

CleanupSystem: Map Reset and Baseline Restoration This example shows the CleanupSystem which tracks the baseline scene state and allows resetting the map to its…

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…