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

RPC Attributes: Rpc.Broadcast, Rpc.Host, Rpc.Owner — Targeting, NetFlags, and Rpc.FilterInclude/Exclude

RPC Attributes: Rpc.Broadcast, Rpc.Host, Rpc.Owner — Targeting and Flags s&box RPCs are declared with nested attributes on the static class. The old top-level a…

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

Component Lifecycle: Full Callback Order — OnAwake, OnEnabled, OnStart, OnUpdate, OnFixedUpdate, OnDisabled, OnDestroy

Component Lifecycle: Full Callback Order s&box components have a well-defined lifecycle. Understanding the exact order prevents subtle bugs. Callback Order Key …

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

FileSystem: Mounted, Data, OrganizationData, Cache, and Memory Filesystems

FileSystem: Accessing Game Files in s&box s&box provides several filesystem access points through the static class. Available Filesystems Reading and Writing Fi…

menu_bookDocumentation
May 4, 2026

Graphics.Draw, Blit, DrawText, DrawIcon, and GrabFrameTexture — Custom Rendering APIs

Graphics.Draw and Graphics.Blit: Custom Rendering in s&box provides low-level rendering APIs for drawing custom geometry, screen-space quads, and text. All call…

menu_bookDocumentation
May 4, 2026

GameObjectFlags: DontDestroyOnLoad, NotNetworked, Absolute, and Destroy vs DestroyImmediate

GameObjectFlags: Controlling GameObject Behavior is a flags enum that controls special behaviors for GameObjects. Values Usage ```csharp // Survive scene loads …

menu_bookDocumentation
May 4, 2026

Inspector Attributes: Group, Title, Icon, Range, InfoBox, Feature, and More

Inspector Attributes: Controlling How Properties Appear in the Editor s&box provides a rich set of attributes to control how component properties appear in the …

menu_bookDocumentation
May 4, 2026

Scene.Load and Scene.LoadFromFile: Loading Scenes, DontDestroyOnLoad, and the Loading Sequence

Scene.Load and Scene.LoadFromFile: Loading Scenes Locally loads a scene file into the current scene. This is a local-only operation — it does not bring other cl…

menu_bookDocumentation
May 4, 2026

IHotloadManaged: Preserving and Restoring State Across s&box Hotloads

IHotloadManaged: Preserving State Across s&box Hotloads When a class is hotloaded in s&box, all live instances are replaced with new instances of the updated ty…

menu_bookDocumentation
May 4, 2026

FindMode and Component Lookup: GetComponent, GetAll, ComponentList, and Hierarchy Search

FindMode and Component Lookup: GetComponent, GetAll, and ComponentList s&box uses a flags enum to control how component searches traverse the hierarchy. Underst…

menu_bookDocumentation
May 4, 2026

Scene.Push(), BatchGroup(), FindInPhysics, and FindAllWithTag — Scene Context Management

Scene.Push() and Scene.BatchGroup(): Scene Context Management Scene.Push() makes a scene the active scene for the duration of a scope. This is required when cre…

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

Doo: Visual Scripting Tasks — Running, Stopping, and Exposing Methods

Doo: Visual Scripting Tasks on Components is s&box's visual scripting system. A is a serializable list of executable blocks that can be run on a component. It i…

menu_bookDocumentation
May 4, 2026

GameObjectSystem with [Sync] and RPCs: Networked Scene-Level State

GameObjectSystem with [Sync]: Networked Scene-Level State supports properties just like components. However, there is a key difference: all properties on a are …

menu_bookDocumentation
May 4, 2026

DamageInfo: The Standard Damage Payload — Properties, Usage, and Custom Types

DamageInfo: The Standard Damage Payload is a class (not a struct) used to pass damage information between game systems. It is intentionally a class so games can…

menu_bookDocumentation
May 4, 2026

SceneCamera: World-to-Screen, Screen-to-World, Render Hooks, and Camera Properties

SceneCamera: World-to-Screen, Screen-to-World, and Render Hooks is the main camera class in s&box. It wraps a native frustum and provides coordinate conversion,…

menu_bookDocumentation
May 4, 2026

MainThread.Queue: Running Code on the Main Thread from Worker Threads

MainThread.Queue: Running Code on the Main Thread from Worker Threads s&box is single-threaded for game logic. If you have code running on a worker thread (e.g.…

menu_bookDocumentation
May 4, 2026

ConVar and ConCmd: Console Variables and Commands in s&box

ConVar and ConCmd: Console Variables and Commands s&box uses and attributes on static properties and methods to expose them to the console system. ConVar (Conso…

menu_bookDocumentation
May 4, 2026

ISceneLoadingEvents: Async Scene Load Hooks with BeforeLoad, OnLoad, and AfterLoad

ISceneLoadingEvents: Async Scene Load Hooks Implement on a to hook into the scene loading pipeline. The game waits for async tasks to complete before proceeding…