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 "query" in menu_bookDocumentation 27 results closeClear
menu_bookDocumentation
May 5, 2026

Sync Properties - Complete Networking Guide

Sync Properties Sync Attribute Adding the attribute to a property on a Component will have its latest value sent to other players each time it changes. These pr…

menu_bookDocumentation
May 5, 2026

Storage UGC - s&box Assets Documentation

Storage UGC The Storage system manages user-generated content. Save games, player creations, and share to Steam Workshop. Creating a New Entry Create a storage …

menu_bookDocumentation
May 20, 2026

Input System Overview: Button Queries, Analog Input, and Escape Override

The s&box Input class provides button queries, analog input, and escape key handling for gameplay. Button Queries Analog Input Custom Keys Configure input actio…

menu_bookDocumentation
May 4, 2026

[Sync] Attribute: SyncFlags.FromHost, SyncFlags.Interpolate, SyncFlags.Query — How Property Sync Works

[Sync] Attribute: SyncFlags and How Property Synchronization Works The attribute marks a component property for automatic network synchronization from the owner…

menu_bookDocumentation
May 5, 2026

Components - s&box Documentation

Components A Component is added to a GameObject to provide functionality. This functionality can vary wildly. You could add a component that renders a model at …

menu_bookDocumentation
May 12, 2026

s&box WorkshopSortMode: Workshop sorting modes

WorkshopSortMode Enum WorkshopSortMode is a friendly enum for Storage/Workshop queries in s&box. It wraps the underlying Storage.SortOrder enum with a simpler A…

menu_bookDocumentation
May 20, 2026

Input System: Button Queries, AnalogMove, AnalogLook, and Escape Override

Input is accessed using the class in s&box. It provides button state queries, analog stick/mouse values, and escape key handling for game components. Button Que…

menu_bookDocumentation
May 20, 2026

Scenes: Loading, Directory Lookups, and Component Queries in s&box

A s&box Scene is a collection of GameObjects. Access the current scene via on any GameObject/Component/Panel, or via . Loading Scenes GameObject Directory Every…

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

Dedicated Servers: Installation, Configuration, and Command Line

s&box dedicated servers run headless and can be installed via SteamCMD. They host multiplayer games without requiring the full editor. Installation Install via …

menu_bookDocumentation
May 12, 2026

s&box PackageSortMode: Package sorting modes

PackageSortMode Enum PackageSortMode is a typed enum for package sorting modes in the s&box package browser. It provides a type-safe way to specify how packages…

menu_bookDocumentation
May 20, 2026

Storage UGC: User-Generated Content with Steam Workshop Integration

The s&box Storage system provides a unified way to manage user-generated content in your game. Each storage entry is a self-contained folder with its own filesy…

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…

menu_bookDocumentation
May 20, 2026

Sync Properties: Networked State with Change Detection and Collections

The attribute on a Component property sends its latest value to other players each time it changes. Only the owner of the object can change synced properties. B…

menu_bookDocumentation
May 4, 2026

s&box Input System: Down, Pressed, Released, AnalogLook, AnalogMove, Input Contexts, and Suppression

s&box Input System: Actions, Contexts, and How Input State Works The s&box static class provides all player input querying. Actions are defined in the project'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…

menu_bookDocumentation
May 4, 2026

Scene.Trace: Raycasting, Shape Sweeps, Tag Filters, SceneTraceResult Fields, and FindInPhysics

Scene.Trace: Raycasting and Shape Sweeps in s&box is the entry point for all physics traces in s&box. It returns a builder that uses a fluent API. Basic Usage F…

menu_bookDocumentation
May 4, 2026

Collider Component: Triggers, Surface Properties, Keyframe Bodies, Concave Shapes, and Tag Propagation

Collider Component: Triggers, Surface Properties, and Keyframe Bodies The abstract base class is the foundation for all physics colliders in s&box (, , , , ). T…

menu_bookDocumentation
May 4, 2026

Networking Static Class: IsHost, IsClient, CreateLobby, Connect, SetData, and Debug Convars

Networking Static Class: IsHost, IsClient, CreateLobby, Connect, and Server Data The static class manages the multiplayer session in s&box. Session State Note: …