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 "client" in menu_bookDocumentation 91 results closeClear
menu_bookDocumentation
May 4, 2026

Sandbox: SaveSystem — scene diff save/load with versioning and ISaveEvents

Sandbox SaveSystem — Scene Diff Save/Load The captures the difference between the current scene state and the original scene file. This means saves are compact …

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

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

PlayerController: Architecture, Ground Detection, Jump System, WishVelocity Sync, and Physics Step Integration

PlayerController: Architecture, Ground Detection, and Jump System is the built-in s&box character movement component. It uses a internally and implements to hoo…

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

NetworkMode, NetworkFlags, OwnerTransfer, NetworkOrphaned — Complete Networking Enum Reference

NetworkMode, NetworkFlags, OwnerTransfer, and NetworkOrphaned — Complete Reference NetworkMode Controls how a is networked. Set via . Once a is a , only the hos…

menu_bookDocumentation
May 4, 2026

Application Context Flags: IsDedicatedServer, IsHeadless, IsEditor, IsVR — Runtime Context in s&box

Application Context Flags: IsDedicatedServer, IsHeadless, IsEditor, IsVR is a static class in s&box that exposes runtime context flags. These are set at startup…

menu_bookDocumentation
May 4, 2026

GameResource: Custom Asset Types, PostLoad, PostReload, ResourceLibrary.Get, and Resource Networking

GameResource: Custom Asset Types, PostLoad, and Resource Networking is the base class for all JSON-based assets in s&box (prefabs, scene files, custom assets). …

menu_bookDocumentation
May 4, 2026

Connection Class: Local, Host, All, Find, Permissions, Kicking, and Visibility Origins

Connection Class: Local, Host, All, Find, and Permissions represents a network connection to a player. It's the primary way to identify and interact with player…

menu_bookDocumentation
May 4, 2026

Component Marker Interfaces: ExecuteInEditor, DontExecuteOnServer, IDamageable, INetworkSpawn, IPressable, INetworkVisible

Component Marker Interfaces: ExecuteInEditor, DontExecuteOnServer, IDamageable, INetworkSpawn, IPressable s&box uses marker interfaces nested inside the class t…

menu_bookDocumentation
May 20, 2026

Network Ownership: Transfer, IsProxy, and Orphaned Modes

Networked GameObjects can be owned by a connection. The owner simulates the object — controlling its position and sync properties. Unowned objects are simulated…

menu_bookDocumentation
May 20, 2026

Network Visibility: Culling and INetworkVisible Interface

Network Visibility controls whether a networked object sends updates (Sync Vars, Transform) to a specific player. By default, all networked objects always trans…

menu_bookDocumentation
May 20, 2026

Testing Multiplayer: Local Multi-Instance Development Workflow

The best way to test multiplayer is having someone join your game, but s&box provides tools for solo testing. Spawning a New Instance Click the network status i…

menu_bookDocumentation
May 12, 2026

LocalData persistence for server-side data

LocalData Persistence in s&box LocalData provides server-side data persistence that survives server restarts. It's useful for storing configuration, ban lists, …

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

Console Variables and Commands: ConVar and ConCmd Runtime Configuration

s&box provides console variables () and console commands () for runtime configuration and debugging. Console Commands Static methods with attribute: Server Comm…

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

RPC Messages - s&box Documentation

RPC Messages Components can contain RPCs. An RPC is a function that when called, is called remotely too. Supported RPC arguments are the exact same as Sync prop…

menu_bookDocumentation
May 4, 2026

Networking State in s&box: IsHost, IsClient, IsActive, and Lobby Management

Networking State in s&box: IsHost, IsClient, IsActive Understanding the networking state is critical for writing correct multiplayer code in s&box. Key Properti…

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…