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 "player" in menu_bookDocumentation 116 results closeClear
menu_bookDocumentation
May 5, 2026

Mapping - s&box Editor Documentation

Mapping s&box includes Hammer, the Source 2 level editor, for creating maps and environments. Build worlds with brushes, props, lighting, and gameplay entities.…

menu_bookDocumentation
May 4, 2026

Sandbox: PlayerInventory — weapon slots, pickup, drop, and loadout persistence

Sandbox PlayerInventory — Weapon Slots, Pickup, Drop, and Loadout Persistence manages up to 6 weapon slots, handles pickup/drop logic, and delegates loadout sav…

menu_bookDocumentation
May 12, 2026

s&box GamePreferences: User preferences

GamePreferences Static Class GamePreferences is a static class that defines the local user's preferences for the game. These ConVars control player-specific set…

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

Your First Project - s&box Documentation

Your First Project Creating Game Objects In s&box, everything in your scene is a GameObject. GameObjects can have Components attached to them that provide funct…

menu_bookDocumentation
May 4, 2026

Scene.Trace: Raycasting, Shape Sweeps, Tag Filters, SceneTraceResult Fields, and FindInPhysics

Scene.Trace: Raycasting and Shape Sweeps in s&box is the entry point for all physics traces in s&box. It returns a builder that uses a fluent API. Basic Usage F…

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

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

Publishing Clothing - s&box Clothing Documentation

Publishing Clothing Publish clothing assets to sbox.game for players to use. Setting up your .Clothing File Create a clothing definition asset: Right-click in A…

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…

menu_bookDocumentation
May 20, 2026

Physics Triggers: Enter, Exit Events and Polling in s&box

A trigger is a collider that detects when physics objects enter or exit it without blocking movement. Useful for pickup zones, death planes, checkpoints, and ar…

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

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

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

Controller Input: Analog Sticks, Haptics, Motion Controls, and Local Multiplayer

s&box supports gamepad/controller input with analog sticks, haptics/rumble, motion controls, and local multiplayer. Detecting Controller Check to see if the pla…

menu_bookDocumentation
May 20, 2026

VR Development: Tracked Objects, Controllers, and Hand Input

s&box supports VR development with built-in components for headset tracking, controller input, and hand animation. Enabling VR Editor: Launch with headset conne…

menu_bookDocumentation
May 20, 2026

Leaderboard Web API: Public REST Endpoint with Aggregation and Filtering

The s&box leaderboard Web API is publicly accessible for querying player rankings based on stats. Endpoint Parameters stat — stat name to base the leaderboard o…

menu_bookDocumentation
May 20, 2026

Triggers: Non-Blocking Collision Detection with ITriggerListener

A trigger is a collider that detects when other physics objects enter or exit it without blocking their movement. Useful for pickup zones, death planes, checkpo…

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

s&box WeaponConVars: Global weapon settings

WeaponConVars Static Class WeaponConVars is a static class that defines console variables controlling global weapon behavior in s&box. These ConVars can be set …