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 "patterns" 80 results closeClear
terminalCode Example
May 4, 2026

Sandbox: BaseConstraintToolMode — two-stage constraint creation with IToolActionEvents

BaseConstraintToolMode — Two-Stage Constraint Creation Pattern is the base for all two-point constraint tools (Weld, Rope, BallSocket, Elastic, Hydraulic, NoCol…

menu_bookDocumentation
May 20, 2026

IsValid Pattern: Safe Null and Destroyed Object Checks

Destroying a or doesn't erase the C# reference — the variable still holds a non-null but dead object. A plain check will pass on destroyed objects, leading to e…

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…

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…

menu_bookDocumentation
May 3, 2026

Network Ownership System

Network Ownership System Control who simulates and updates networked GameObjects with the ownership system. Ownership Basics Every networked object has an Owner…

groupsCommunity
May 3, 2026

Common Pitfalls and How to Avoid Them

s&box Common Pitfalls and How to Avoid Them Community-compiled list of frequently encountered issues and their solutions, based on Discord support channels and …

menu_bookDocumentation
May 4, 2026

Sandbox: Map entities — Door, Button, FuncMover, TriggerPush, TriggerTeleport

Sandbox Map Entities — Door, Button, FuncMover, TriggerPush, TriggerTeleport These components implement interactive map elements. They live in the namespace and…

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…

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…

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…

codeAPI Reference
May 12, 2026

s&box SaveSystem: Scene save/load

SaveSystem GameObjectSystem API Reference SaveSystem is a saving/loading system that captures the differences between the current scene state and the original s…

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

ActionGraph Component Actions - s&box Documentation

ActionGraph Component Actions Add ActionGraph behavior directly to GameObjects using the ActionGraph component. Component Actions The ActionGraph component lets…

menu_bookDocumentation
May 4, 2026

DisplayInfo: Querying s&box Type and Member Metadata (Title, Icon, Group, Tags)

DisplayInfo: Querying s&box Type and Member Metadata is an s&box struct that aggregates all display-related metadata from attributes on a type or member. The ed…

codeAPI Reference
May 12, 2026

s&box FuncMover: Moving and rotating objects

FuncMover Component API Reference FuncMover is a Component that moves and rotates a GameObject with configurable linear and rotational movement patterns. Type S…

menu_bookDocumentation
May 4, 2026

Code Upgrader Diagnostics: SBOX001-SBOX007 and SB3000 Roslyn Analyzer Warnings

Code Upgrader Diagnostics: s&box Roslyn Analyzer Warnings s&box ships a Roslyn analyzer () that warns about deprecated patterns and auto-fixes them. These appea…

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…

menu_bookDocumentation
May 4, 2026

GameResource: Custom Asset Types, PostLoad, PostReload, ResourceLibrary.Get, and Resource Networking

GameResource: Custom Asset Types, PostLoad, and Resource Networking is the base class for all JSON-based assets in s&box (prefabs, scene files, custom assets). …

menu_bookDocumentation
May 4, 2026

TemporaryEffect Component: Auto-Destroy, ITemporaryEffect, BecomeOrphan, and Editor Behavior

TemporaryEffect Component: Auto-Destroy with ITemporaryEffect Support destroys a after a set time, optionally waiting for child effects (particles, sounds) to f…