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 "Connection" 123 results closeClear
codeAPI Reference
May 12, 2026

s&box BanSystem: Ban list management with persistence

BanSystem API Reference BanSystem is a GameObjectSystem that manages a ban list with LocalData persistence and connection blocking. Type Signature Key Methods -…

terminalCode Example
May 12, 2026

s&box achievement unlocking with Rpc.FilterInclude targeting

s&box Achievement Unlocking with Rpc.FilterInclude This example shows achievement unlocking using s&box's Services.Achievements, Services.Stats, and Rpc.FilterI…

menu_bookDocumentation
May 4, 2026

GameObject.Network Accessor — IsProxy, IsOwner, TakeOwnership, DropOwnership, Refresh, and IGameObjectNetworkEvents

GameObject.Network Accessor — Ownership, Spawning, and Proxy Detection is a that provides all network-related operations for a . It always resolves to the netwo…

menu_bookDocumentation
May 20, 2026

Testing Multiplayer: New Instances, Hotloading, and Local Connect

s&box provides built-in tools for testing multiplayer without needing another player. You can spawn additional game instances that join your running session, wi…

menu_bookDocumentation
May 5, 2026

Connection Permissions - s&box Networking Documentation

Connection Permissions Connection permissions control what clients can do in your multiplayer game. Set permissions for spawning objects, using tools, or perfor…

menu_bookDocumentation
May 12, 2026

Rpc.FilterInclude for targeted RPC broadcasting

Rpc.FilterInclude for Targeted RPC Broadcasting Rpc.FilterInclude is a using statement in s&box that restricts RPC broadcasts to specific connections only. This…

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

Voice Component: Push-to-Talk, Lip Sync Visemes, ExcludeFilter, ShouldHearVoice, and Amplitude

Voice Component: Voice Chat, Lip Sync, and Viseme Morphs The component handles voice chat recording, transmission, and playback with optional lip sync. Basic Se…

menu_bookDocumentation
May 20, 2026

Platform Chat - Built-in Multiplayer Text Chat System

Built-in text chat for multiplayer games. Messages are routed through the host, validated, filtered, and displayed via the standard overlay UI - no game code re…

menu_bookDocumentation
May 4, 2026

NetworkObject: Ownership, Proxy State, and Automatic Culling

NetworkObject Ownership, Proxy State, and Culling Derived from in the s&box engine source. Ownership Model Every networked has a (internal) that tracks: **** — …

menu_bookDocumentation
May 5, 2026

NetworkHelper — quick multiplayer setup with auto-server and player spawning

NetworkHelper — Quick Multiplayer Setup is a built-in s&box component that handles the boilerplate of starting a server and spawning players. It's the fastest w…

terminalCode Example
May 3, 2026

Multiplayer and Networking

Complete guide to multiplayer setup in s&box. Creating a Lobby Joining a Lobby Spawning Networked Players Host/Client Checks Connection Events Networked Object …

menu_bookDocumentation
May 5, 2026

Testing Multiplayer - s&box Networking Documentation

Testing Multiplayer s&box provides tools for testing multiplayer locally without needing multiple computers or Steam accounts. New Instance Launch a second game…

menu_bookDocumentation
May 4, 2026

NetworkSpawn, Ownership Transfer, and Network.Refresh in s&box

NetworkSpawn and Ownership Transfer in s&box Spawning a Networked Object Ownership Transfer Modes (OwnerTransfer) Taking and Dropping Ownership Checking Ownersh…

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

ClothingContainer: Apply, ApplyAsync, CreateFromConnection, RemoveUnownedItems, and Body Group Masking

ClothingContainer: Avatar Dressing System — Apply, CreateFromConnection, and RemoveUnownedItems manages a player's avatar outfit. It handles clothing compatibil…

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

WebSockets - s&box Networking Documentation

WebSockets s&box supports WebSocket connections for real-time communication with external servers. Use for custom networking, persistent data, or integrating wi…

terminalCode Example
May 3, 2026

Component Event Interfaces for Tool Interactions

Component Event Interfaces (IPhysgunEvent, IToolgunEvent) Event interfaces that allow components to respond to tool interactions. These use s&box's pattern for …

menu_bookDocumentation
May 20, 2026

Connection Permissions: CanSpawnObjects and CanRefreshObjects

The host can change permissions for a specific in s&box multiplayer. The ideal place to set these permissions is in the network event callback when a player con…