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

Playing Sounds: SoundEvent, SoundHandle, and GameObject Audio in s&box

s&box provides several ways to play sounds in code: fire-and-forget at a world position, control via SoundHandle, attach to a GameObject, or use scene component…

menu_bookDocumentation
May 20, 2026

Navigation: Recast NavMesh Generation and Pathfinding in s&box

s&box implements Recast Navigation (the industry standard used in Unreal, Unity, and Godot) for navmesh generation and navigation agents. What is a NavMesh? A s…

menu_bookDocumentation
May 20, 2026

NavMesh Agent: AI Pathfinding Component with Crowd Control

The s&box NavMeshAgent component moves GameObjects along the NavMesh automatically with built-in crowd control to avoid collisions between agents. Component Set…

menu_bookDocumentation
May 20, 2026

Leaderboards: Stats Aggregation with Country, Date, and Centering Filters

Leaderboards in s&box are stats aggregated and ordered. They use the API. Basic Usage By default, leaderboards aggregate using sum and order descending. Filteri…

codeAPI Reference
May 12, 2026

s&box Global.ISaveEvents: Save/load event callbacks

Global.ISaveEvents Interface API Reference Global.ISaveEvents is an interface for Components that want to listen to SaveSystem events. Implement to receive call…

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 …

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…

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

Stats API

Track player statistics with the Stats service. Recording Stats Reading Stats Stat Types Batching Stats are automatically batched and sent periodically. Call as…

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

Code Basics - s&box Documentation

Code Basics C# is the primary programming language for s&box. The engine uses modern .NET with hotloading support, allowing you to see code changes instantly wi…

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…

codeAPI Reference
May 12, 2026

s&box HoverballDefinition: Hoverball type GameResource

HoverballDefinition GameResource API Reference HoverballDefinition is a GameResource that defines a hoverball type with a prefab, used by the Hoverball tool to …

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

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…

codeAPI Reference
May 12, 2026

s&box ICleanupEvents: Cleanup event callbacks

ICleanupEvents API Reference ICleanupEvents is an interface for receiving callbacks when the scene is cleaned up (map reset). Type Signature Method - Called aft…

codeAPI Reference
May 12, 2026

s&box IDefinitionResource: Resource metadata interface

IDefinitionResource API Reference IDefinitionResource is an interface for game resources that have display metadata (title and description). Type Signature Prop…

menu_bookDocumentation
May 5, 2026

Dedicated Servers - s&box Documentation

Official s&box documentation for dedicated server hosting. Dedicated Servers covers running s&box games on headless servers. Running Local Projects explains tes…

menu_bookDocumentation
May 3, 2026

Localization (i18n)

Localization (i18n) Support multiple languages using localization tokens. How It Works Use tokens starting with in UI strings. The system replaces them based on…

codeAPI Reference
May 3, 2026

Sandbox.GameResource

Sandbox.GameResource Base class for custom asset types. Overview GameResource is the base class for creating custom asset types that appear in the editor with f…