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 "Editor" 124 results closeClear
terminalCode Example
May 5, 2026

Unit tests in s&box — MSTest setup, engine initialization, and component testing

Unit Tests in s&box s&box supports MSTest-based unit tests. Create a directory in your project folder and restart the editor — a test project is generated autom…

codeAPI Reference
May 12, 2026

s&box FuncMover: Moving and rotating objects

FuncMover Component API Reference FuncMover is a Component that moves and rotates a GameObject with configurable linear and rotational movement patterns. Type S…

terminalCode Example
May 10, 2026

Reusable World-Space Interaction Prompt Framework

A small, compartmentalized interaction framework can be built from three pieces: : the base component placed on objects the player can use. : the player-side ra…

terminalCode Example
May 10, 2026

Extensible Player Data Save Hooks for World Components

This pattern lets gameplay components plug into a player's save/load flow without putting every feature directly inside one large class. The framework has three…

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

s&box Hotload System: How Code Reloading Works, SkipHotload, ConVar Persistence, and NetworkObject.OnHotload

s&box Hotload System: How Code Reloading Works s&box supports live code reloading (hotload) without restarting the game. Understanding how it works helps avoid …

menu_bookDocumentation
May 4, 2026

s&box CameraComponent: Screen/World Conversion, RenderToTexture, Priority, Viewport, and Oblique Projection

s&box CameraComponent: Screen/World Conversion, RenderToTexture, and Priority wraps a and provides the main rendering configuration for a s&box scene. Every sce…

menu_bookDocumentation
May 4, 2026

Game Static Class: ActiveScene, ChangeScene, TypeLibrary, Cookies, and Core State Properties

Game Static Class: ActiveScene, ChangeScene, TypeLibrary, and Core State The static class is the primary entry point for global game state in s&box. Core State …

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: …

menu_bookDocumentation
May 4, 2026

Scene Object Index: How Scene.GetAll Works — Type Hierarchy Indexing, Update Sets, and Hotload Safety

Scene Object Index: How Scene.GetAll<T> Works and Why It's Fast is the primary way to find all active components or systems of a type in the scene. Understandin…

codeAPI Reference
May 12, 2026

s&box ServerSettings: Replicated server-controlled settings

ServerSettings API Reference ServerSettings is a static class for server-controlled settings that are replicated to all clients. Type Signature Example Property…

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

Getting Started - s&box Documentation

Getting Started S&box is coded in C#. Under the hood, it uses the Source 2 engine (CS2, HL:Alyx, DOTA2) and some of its systems: rendering, resources, physics, …

menu_bookDocumentation
May 12, 2026

s&box EaseType: Animation easing functions

EaseType Enum Documentation EaseType is an enum that defines easing functions for animated hydraulic movement. It is used by HydraulicEntity to control how the …

menu_bookDocumentation
May 20, 2026

Networked Objects: Spawning, Network Modes, and Interpolation

Any GameObject can become networked by calling . It will then be sent to all clients and can have Sync Properties and RPC Messages. Spawning a Networked Object …

menu_bookDocumentation
May 20, 2026

Scene Tracing: Raycasts, Sphere Traces, and Box Traces

Scenes can be traced against using with a builder pattern. At minimum, traces need a shape, start, and end. You can filter by tags or use your project's collisi…

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

ISceneStartup: Host and Client Scene Initialization Events

is a scene event interface for listening to scene initialization on host and client. It runs when pressing play in editor, loading a game, or joining a server. …

menu_bookDocumentation
May 20, 2026

Cloud Assets: Referencing and Runtime Mounting from sbox.game

s&box provides access to a large library of cloud assets (models, textures, sounds) hosted on sbox.game. Assets are downloaded and cached automatically — no man…

menu_bookDocumentation
May 20, 2026

Unit Tests: MSTest with Engine Initialization for Component Testing

s&box supports unit testing via a directory in your project. The engine auto-generates a test project when this directory exists (restart editor after creating …