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" 130 results closeClear
codeAPI Reference
May 4, 2026

s&box Game Static Class: Core Game State and Operations

s&box Game Static Class: Core Game State and Operations The static class provides global access to core game state, utilities, and operations. Scene Management …

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…

codeAPI Reference
May 12, 2026

s&box SaveSystem: Scene save/load

SaveSystem GameObjectSystem API Reference SaveSystem is a saving/loading system that captures the differences between the current scene state and the original s…

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…

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

IGameObjectNetworkEvents: StartControl, StopControl, and NetworkOwnerChanged Callbacks

IGameObjectNetworkEvents: Ownership Change Callbacks Implement on a component to receive callbacks when network ownership of the parent changes. Interface Metho…

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…

codeAPI Reference
May 12, 2026

s&box TriggerTeleport: Trigger-based teleportation

TriggerTeleport Component API Reference TriggerTeleport is a Component that teleports objects that enter its trigger collider to a target GameObject. Type Signa…

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

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…

terminalCode Example
May 12, 2026

IPlayerControllable example: ThrusterEntity

IPlayerControllable Example: ThrusterEntity ThrusterEntity demonstrates how to implement IPlayerControllable for a thruster that responds to player input while …

codeAPI Reference
May 12, 2026

s&box PointLightEntity: Controllable point light

PointLightEntity Component API Reference PointLightEntity is a controllable point light that can be toggled and configured via player input. It wraps a PointLig…

codeAPI Reference
May 12, 2026

s&box ClientInput: Input scope for controlled objects

Client input scope struct for routing input to controlled objects. Used by ControlSystem to redirect player input during chair/vehicle control. Static Propertie…

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

RPC Messages: Broadcast, Owner, Host with Filtering and Caller Info

Components can contain RPCs — functions that when called locally, are also called remotely. Supported RPC argument types are the same as Sync properties. Basic …

menu_bookDocumentation
May 20, 2026

Console Variables and Commands: ConVar and ConCmd with Flags

Console variables () and commands () let you create tweakable settings and runnable commands accessible from the s&box console. Console Commands Static methods …

menu_bookDocumentation
May 20, 2026

IGameObjectNetworkEvents: Ownership Change and Control Transfer Events

lets Components on a networked GameObject react to ownership changes. The events are targeted only at the specific GameObject whose ownership is changing. Inter…

menu_bookDocumentation
May 20, 2026

Platform Chat: Built-in Text Chat with IChatEvent Filtering

s&box includes a built-in platform chat system for multiplayer games. Messages are routed through the host, validated, filtered via Steam's text filter, and dis…