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 "Protected" 157 results closeClear
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 4, 2026

NetList and NetDictionary: Delta Sync, OnChanged Callbacks, Write Guard, and CanWriteChanges

NetList and NetDictionary: Networked Collections with Delta Sync and are s&box networked collection types for use with . They only send changes (deltas) over th…

menu_bookDocumentation
May 4, 2026

SyncFlags.Interpolate: How Networked Property Interpolation Works — Supported Types, InterpolationBuffer, and Delay

SyncFlags.Interpolate: How Networked Property Interpolation Works When is applied to a property, proxy clients receive a smoothed value between network ticks ra…

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

NavMeshAgent: MoveTo, WishVelocity Pattern, Off-Mesh Links, Area Constraints, and Path Queries

NavMeshAgent: Navigation, WishVelocity, Links, and Path Control is the s&box component for AI navigation using the scene's navmesh. It uses DotRecast (Detour/Cr…

menu_bookDocumentation
May 4, 2026

RealTime vs Time: Wall-Clock vs Scene Time — RealTimeSince, RealTimeUntil, GlobalNow, and SmoothDelta

RealTime vs Time: Wall-Clock vs Scene Time — When to Use Each s&box has two time systems. Choosing the wrong one is a common source of bugs. Time (Scene Time) ,…

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…

menu_bookDocumentation
May 20, 2026

Custom Snapshot Data: INetworkSnapshot for s&box Joining Client Data Transfer

s&box Components can write and read custom data during the network snapshot process by implementing . The snapshot is sent to clients when they join a s&box mul…

codeAPI Reference
May 12, 2026

s&box ScriptedEmitterModel: Model-based emitter resource

ScriptedEmitterModel GameResource API Reference ScriptedEmitterModel is a GameResource for model-based particle/VFX emitters. It implements IDefinitionResource …

codeAPI Reference
May 12, 2026

s&box WaterVolume: Buoyancy physics for water volumes

WaterVolume API Reference WaterVolume is a Component that applies buoyancy physics to Rigidbody objects entering a trigger volume. Type Signature Physics Implem…

codeAPI Reference
May 12, 2026

s&box BasePickup: Trigger and collision-based pickup system

BasePickup API Reference BasePickup is an abstract Component for creating trigger or collision-based pickups (weapons, ammo, items). Type Signature Required Com…

codeAPI Reference
May 12, 2026

s&box IToolgunEvent: Toolgun selection interception

IToolgunEvent Interface API Reference IToolgunEvent is an interface for Components that want to intercept toolgun selection attempts. Implement to allow or reje…

codeAPI Reference
May 12, 2026

s&box IPhysgunEvent: Physgun grab interception

IPhysgunEvent Interface API Reference IPhysgunEvent is an interface for Components that want to intercept physgun grab attempts. Implement to allow or reject ph…

terminalCode Example
May 12, 2026

RPC-based chat system with avatars and Steam filtering

RPC-Based Chat System with Avatar Support This example shows a complete chat system using Razor, RPC broadcasting, Steam filtering, and avatar display. Key Feat…

menu_bookDocumentation
May 20, 2026

Razor Panels: HTML/CSS UI with C# in s&box PanelComponent System

s&box Razor Panels use web-like HTML/CSS syntax with C# for UI creation. Panels are rendered natively (not via HTML renderer) — the syntax is a convenience laye…

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 …

terminalCode Example
May 12, 2026

Automatic water volume setup with buoyancy physics

Automatic Water Volume Setup with Buoyancy This example shows automatic attachment of WaterVolume components to colliders tagged "water" and buoyancy physics im…

codeAPI Reference
May 3, 2026

ToolMode SelectionPoint and Trace Helpers

ToolMode.SelectionPoint and Trace Helpers Helper methods and data structures for toolgun selection and placement. SelectionPoint Struct Trace Methods Placement …

terminalCode Example
May 3, 2026

Rigidbody Physics

The component enables physics simulation on GameObjects. Basic Usage Rigidbody Properties Forces Collision Detection Wake/Sleep Spawn with Velocity

menu_bookDocumentation
May 12, 2026

s&box Throwable: Grenade type enum

Throwable Enum Documentation Throwable is an enum that defines the type of throwable weapon for viewmodels. It is used by the ViewModel component to specify whi…