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 "save" 69 results closeClear
menu_bookDocumentation
May 4, 2026

ComponentFlags: Hidden, NotSaved, NotNetworked, NotCloned — Controlling Component Behavior

ComponentFlags: Controlling Component Serialization, Networking, and Visibility is a flags enum on that controls how a component behaves in the editor, serializ…

terminalCode Example
May 4, 2026

Sandbox: Player spawn flow with PlayerData, events, and NetworkSpawn

Player Spawn Flow in s&box Sandbox The Sandbox game uses a (a ) to handle player connections and spawning. Here's the full pattern: GameManager spawns players o…

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 5, 2026

Binary Serialization - s&box Documentation

Official s&box documentation for Binary Serialization - efficient data storage. Binary Serialization saves data in compact binary format. The system handles ver…

codeAPI Reference
May 3, 2026

ToolMode Base Class for Toolgun Modes

ToolMode Base Class Abstract base class for creating toolgun modes in s&box. Handles input registration, action dispatch, and HUD rendering. Class Overview Acti…

menu_bookDocumentation
May 5, 2026

Publishing Clothing - s&box Clothing Documentation

Publishing Clothing Publish clothing assets to sbox.game for players to use. Setting up your .Clothing File Create a clothing definition asset: Right-click in A…

menu_bookDocumentation
May 4, 2026

FileSystem: Mounted, Data, OrganizationData, Cache, and Memory Filesystems

FileSystem: Accessing Game Files in s&box s&box provides several filesystem access points through the static class. Available Filesystems Reading and Writing Fi…

menu_bookDocumentation
May 20, 2026

Clutter System: GPU-Instanced Scattering for Grass, Rocks, and Debris

The s&box Clutter System scatters large amounts of small objects (grass, rocks, debris) with GPU-instanced rendering. It handles placement, streaming, and LOD a…

codeAPI Reference
May 3, 2026

GameManager.Spawn RPC with Ident Parsing

GameManager.Spawn RPC Broadcast RPC for spawning entities from string identifiers with automatic weapon pickup detection. Ident Format - Spawn a prop from asset…

menu_bookDocumentation
May 3, 2026

ActionGraph - Visual Scripting System

ActionGraph - Visual Scripting System Create game logic using node-based visual scripting without writing code. Overview ActionGraph lets you: Build gameplay lo…

menu_bookDocumentation
May 4, 2026

ConVar and ConCmd: Console Variables and Commands in s&box

ConVar and ConCmd: Console Variables and Commands s&box uses and attributes on static properties and methods to expose them to the console system. ConVar (Conso…

terminalCode Example
May 3, 2026

CleanupSystem Pattern for Map Reset and Scene Management

CleanupSystem - Scene State Management and Map Cleanup A that captures the baseline scene state and allows resetting the map to its original state. Removes spaw…

menu_bookDocumentation
May 20, 2026

File System: Sandboxed Virtual Filesystems for Data Persistence

Standard .NET access is restricted in s&box. Instead, use the provided virtual filesystems that sandbox access to specific game directories. Available File Syst…

menu_bookDocumentation
May 20, 2026

Prefabs: Reusable GameObjects with Runtime Spawning via Clone

A prefab is a GameObject that can be used in multiple places — across scenes or instantiated at runtime. Assets Prefabs are saved as PrefabFile assets. To creat…

menu_bookDocumentation
May 20, 2026

Scene Metadata: ISceneMetadata for Queryable Scene and Prefab Data

The interface in s&box allows Components to save data that can be accessed without loading a Scene or cloning a Prefab. Metadata is accessible via or directly. …

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 20, 2026

GameObjectSystem: Scene-Level Batch Processing Systems in s&box

A in s&box is a scene-level system that performs work at specific points during the frame. Automatically instantiated when a scene is created — no manual setup …

menu_bookDocumentation
May 20, 2026

Shader Graph Getting Started: Visual Shader Editor in s&box

s&box Shader Graph is a visual scripting language that compiles to shader code. Accessible to beginners and useful for rapid prototyping by experienced shader d…

menu_bookDocumentation
May 20, 2026

Hotloading Pitfalls: Default Values, Types, Delegates, and Optimization

s&box hotloads code changes live when you save or files. Understanding the pitfalls helps avoid subtle bugs during development. How It Works IL Hotload (Fast): …

terminalCode Example
May 3, 2026

HTTP Requests

s&box provides the static class for asynchronous HTTP requests. Allowed URLs Domains only (no IP addresses) permitted on ports: 80, 443, 8080, 8443 Use command …