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 "overrides" 203 results closeClear
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

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

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

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

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

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

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

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

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

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 …

terminalCode Example
May 3, 2026

ControlSystem Pattern for Seat/Vehicle Control

ControlSystem - Seat/Vehicle Control Management A that manages control transfer between players and seated entities (vehicles, chairs). Handles input routing an…

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

NetworkHelper: Simplified Multiplayer Setup with Player Spawning

The NetworkHelper component simplifies multiplayer setup. It handles server creation, player spawning, and object ownership. Creating a Server Set to true and a…

menu_bookDocumentation
May 20, 2026

Creating Post-Process Effects: BasePostProcess with Volume Blending and Shaders

Create custom post-processing effects in s&box by deriving from . This enables volume-based blending and custom shader rendering. The Component Key Methods GetW…

menu_bookDocumentation
May 20, 2026

Serverside Code: #if SERVER Blocks and .Server.cs Files for Hidden Logic

s&box supports serverside-only code that is stripped from client builds. This only works when running local projects on dedicated servers. #if SERVER Blocks Cod…

menu_bookDocumentation
May 20, 2026

Triggers: Non-Blocking Collision Detection with ITriggerListener

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

menu_bookDocumentation
May 20, 2026

Network Ownership: Taking, Dropping, and Transferring Object Control

Networked GameObjects can be owned by a connection. Objects owned by a connection are simulated by that connection — their position and sync variables are contr…

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

Async Components: Coroutine-Style Async Tasks on the Main Thread

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

menu_bookDocumentation
May 20, 2026

WebSockets: External Server Communication with Auth Token Support

s&box allows WebSocket connections to interface with external servers. Common uses include custom networking and persistent data storage outside the local files…