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
in menu_bookDocumentation 352 results closeClear
menu_bookDocumentation
May 20, 2026

Console Variables and Commands: ConVar and ConCmd with Flags

Console variables () and commands () let you create tweakable settings and runnable commands accessible from the s&box console. Console Commands Static methods …

menu_bookDocumentation
May 20, 2026

Property Attributes: Inspector Customization for Components and Assets

Property attributes control how Component properties appear in the s&box editor/inspector. They work on both Components and GameResource properties. Layout and …

menu_bookDocumentation
May 20, 2026

WebSocket Connections with Auth Token Authentication in s&box

s&box supports WebSocket connections to external servers for custom networking or persistent data outside the local filesystem. Basic Connection and Messaging U…

menu_bookDocumentation
May 20, 2026

Custom GameResource Assets: Define, Create, and Access Custom Asset Types

Define custom asset types as subclasses. They get a nice inspector window, are hotloaded in-game, and are stored as JSON files with a custom extension. Creating…

menu_bookDocumentation
May 20, 2026

NavMesh Agent: AI Pathfinding with Crowd Avoidance

The component moves a GameObject along the NavMesh automatically with built-in crowd avoidance. Agents try to avoid bumping into each other when multiple agents…

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…

menu_bookDocumentation
May 20, 2026

Scenes: Loading, Component Lookup, and GameObject Directory

A Scene is a collection of GameObjects that represents the game world. Every Component and GameObject has a property for accessing the current scene, and you ca…

menu_bookDocumentation
May 20, 2026

Time Utilities: TimeSince, TimeUntil, and Frame-Rate Independence

s&box provides time utilities for cooldowns, countdowns, and frame-rate independent movement without manual bookkeeping. Time.Delta Seconds since last frame. Mu…

menu_bookDocumentation
May 20, 2026

Network Events: INetworkListener and INetworkSpawn Interfaces

React to players joining and leaving by implementing or on a component in the scene. INetworkListener Example Spawn a player object when someone joins: INetwork…

menu_bookDocumentation
May 20, 2026

Playing Sounds: SoundHandle, GameObject.PlaySound, and Audio Components

s&box provides several ways to play sounds: fire-and-forget at a position, controlled via , attached to a , or via scene components. SoundEvent Assets Sounds ar…

menu_bookDocumentation
May 20, 2026

HudPainter: Immediate-Mode HUD Drawing in s&box

Each has a property (HudPainter) for immediate-mode drawing onto the screen. More efficient than UI panels since there's no layout, stylesheets, or interactivit…

menu_bookDocumentation
May 20, 2026

PlayerController: Physics-Based Character with Events Interface

The component is a physics-based first/third person player controller. Add it to a scene and be running around with no programming required. Core Features Physi…

menu_bookDocumentation
May 20, 2026

Stats Service: Recording and Reading Player Statistics in s&box

Games can record per-player stats using . Stats can be queried individually, per-player, or globally. Recording Stats Increment a counter: Set a value directly:…

menu_bookDocumentation
May 20, 2026

Network Visibility: Culling and INetworkVisible Interface

Network Visibility controls whether a networked object sends updates (Sync Vars, Transform) to a specific player. By default, all networked objects always trans…

menu_bookDocumentation
May 20, 2026

Component Interfaces: IDamageable, ICollisionListener, ExecuteInEditor

s&box provides several built-in component interfaces for physics, damage, networking, and editor execution. ExecuteInEditor Runs component methods (OnAwake, OnE…

menu_bookDocumentation
May 20, 2026

Physics Triggers: Enter, Exit Events and Polling in s&box

A trigger is a collider that detects when physics objects enter or exit it without blocking movement. Useful for pickup zones, death planes, checkpoints, and ar…

menu_bookDocumentation
May 20, 2026

Async Tasks and Coroutines in s&box Components

Async tasks in s&box run on the main thread by default, operating like coroutines. They are the recommended replacement for coroutines. Basic Async Method Frame…

menu_bookDocumentation
May 20, 2026

HTTP Requests: Async GET and POST with JSON in s&box

s&box provides a static class for asynchronous HTTP requests (GET, POST, DELETE, etc.) with JSON support. Allowed URLs Only or URLs to domains (no IP addresses)…

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…

menu_bookDocumentation
May 20, 2026

Scene Events: Interface-Based Broadcasting and Listening

s&box uses interface-based events to broadcast and listen to events within a scene. Events are sent to active Components and GameObjectSystems — they are NOT se…