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
Results for "Dictionary" 40 results closeClear
menu_bookDocumentation
May 4, 2026

IHotloadManaged: Preserving and Restoring State Across s&box Hotloads

IHotloadManaged: Preserving State Across s&box Hotloads When a class is hotloaded in s&box, all live instances are replaced with new instances of the updated ty…

menu_bookDocumentation
May 12, 2026

LocalData persistence for server-side data

LocalData Persistence in s&box LocalData provides server-side data persistence that survives server restarts. It's useful for storing configuration, ban lists, …

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

Scene Object Index: How Scene.GetAll Works — Type Hierarchy Indexing, Update Sets, and Hotload Safety

Scene Object Index: How Scene.GetAll<T> Works and Why It's Fast is the primary way to find all active components or systems of a type in the scene. Understandin…

terminalCode Example
May 3, 2026

BanSystem Pattern for Player Management

BanSystem - Player Ban Management A GameObjectSystem that manages player bans with persistent storage. Demonstrates , persistence, and RPC commands. Implementat…

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

LocalData static class: Server-side data persistence

LocalData Static Class API Reference LocalData provides server-side data persistence that survives server restarts. It's useful for storing configuration, ban l…

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…

codeAPI Reference
May 3, 2026

LimitsSystem Per-Player Spawn Limits

LimitsSystem Per-Player Limits Enforces configurable spawn limits per player with automatic tracking via ISpawnEvents. Key Features Per-player tracking via Stea…

groupsCommunity
May 3, 2026

Project Structure Recommendations

Project Structure Recommendations Community guide for organizing s&box projects based on Facepunch examples and successful community projects. Recommended Folde…

menu_bookDocumentation
May 5, 2026

Sync Properties - Complete Networking Guide

Sync Properties Sync Attribute Adding the attribute to a property on a Component will have its latest value sent to other players each time it changes. These pr…

menu_bookDocumentation
May 4, 2026

Sandbox: BanSystem — persistent ban list with INetworkListener.AcceptConnection

Sandbox BanSystem — Persistent Ban List with INetworkListener is a that implements to intercept incoming connections and reject banned players before they join.…

codeAPI Reference
May 3, 2026

Sandbox.Http

Sandbox.Http HTTP request utilities. Overview Http provides asynchronous methods for making HTTP requests to external services. GET Request POST Request JSON Re…

codeAPI Reference
May 12, 2026

s&box MorphState: Morph value persistence

MorphState Component API Reference MorphState persists morph values on a GameObject so they survive over the network and duplication. Type Signature Properties …

menu_bookDocumentation
May 5, 2026

Hotloading — live code reloading, IL fast path, and common pitfalls

Hotloading — Live Code Reloading s&box recompiles and live-reloads your assembly whenever you save a or file. You don't need to restart the editor for most chan…

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 …

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

SkinnedModelRenderer Animation Parameters: Set, SetIk, SetLookDirection, Pre-Spawn Caching, and ClearParameters

SkinnedModelRenderer Animation Parameters: Set, SetIk, SetLookDirection, and Pre-Spawn Caching stores animation parameters in a dictionary and applies them to t…

codeAPI Reference
May 12, 2026

s&box AmmoInventory: Shared ammo pools

AmmoInventory Component API Reference AmmoInventory stores shared ammo pools on a player, keyed by AmmoResource. Add this component to the player prefab alongsi…