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

s&box LineDefinition: Trail line resource

LineDefinition GameResource API Reference LineDefinition is a GameResource for trail line definitions used by the Trail tool. It implements IDefinitionResource …

menu_bookDocumentation
May 3, 2026

Media Support - Video and Audio Codecs

Media Support - Video and Audio Codecs Video and audio codec/format support for playback, streaming, and encoding. Video Codecs Recommendation: Use VP9 or AV1 f…

menu_bookDocumentation
May 5, 2026

Custom Editors - s&box Editor Documentation

Custom Editors Custom editors let you create specialized inspector interfaces for your components and assets. Build custom widgets, property drawers, and full i…

menu_bookDocumentation
May 20, 2026

Playing Sounds: SoundHandle, GameObject.PlaySound, and Audio Components

s&box provides several ways to play sounds: fire-and-forget at a position, controlled via , attached to a , or via scene components. SoundEvent Assets Sounds ar…

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

Playing Sounds - s&box Sound Documentation

Playing Sounds s&box provides multiple ways to play audio. From simple one-shots to complex 3D spatial audio with full control. SoundEvent Create reusable sound…

terminalCode Example
May 3, 2026

Playing Sounds

Playing Sounds in s&box s&box provides both 2D and 3D sound playback through code and components. Quick Sound Playback Sound Handle Store the handle to control …

menu_bookDocumentation
May 4, 2026

Sandbox: Map entities — Door, Button, FuncMover, TriggerPush, TriggerTeleport

Sandbox Map Entities — Door, Button, FuncMover, TriggerPush, TriggerTeleport These components implement interactive map elements. They live in the namespace and…

menu_bookDocumentation
May 4, 2026

SyncFlags.Interpolate: How Networked Property Interpolation Works — Supported Types, InterpolationBuffer, and Delay

SyncFlags.Interpolate: How Networked Property Interpolation Works When is applied to a property, proxy clients receive a smoothed value between network ticks ra…

menu_bookDocumentation
May 4, 2026

NavMeshAgent: MoveTo, WishVelocity Pattern, Off-Mesh Links, Area Constraints, and Path Queries

NavMeshAgent: Navigation, WishVelocity, Links, and Path Control is the s&box component for AI navigation using the scene's navmesh. It uses DotRecast (Detour/Cr…

menu_bookDocumentation
May 4, 2026

Sound.Play and SoundHandle: 3D Audio, Volume, Pitch, Occlusion, UI Sounds, and Dedicated Server Behavior

Sound.Play and SoundHandle: Audio Playback in s&box is the static entry point for audio playback. is the returned handle for controlling a playing sound. Playin…

menu_bookDocumentation
May 4, 2026

SkinnedModelRenderer: Bone Merge, Animation Parameters, Sequences, Attachments, and Animation Events

SkinnedModelRenderer: Bone Merge, Animation Parameters, and Attachments extends for models with bones and animations. It integrates with the for threaded animat…

menu_bookDocumentation
May 4, 2026

ModelRenderer: Body Groups, Material Override, Material Groups, Shadow Modes, and LOD Override

ModelRenderer: Body Groups, Material Override, Shadow Modes, and LOD renders a static (non-skinned) model in the world. It creates a in the . Basic Usage Body G…

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

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

BasePostProcess: Custom Post-Processing with GetWeighted, BlitMode, and PostProcessVolume Blending

BasePostProcess<T>: Custom Post-Processing Effects with Volume Blending is the current (non-obsolete) base class for post-processing effects in s&box. It replac…

menu_bookDocumentation
May 5, 2026

Console Variables - s&box Documentation

Official s&box documentation for Console Variables (ConVar) and Console Commands (ConCmd). ConVar creates variables that can be modified through the console and…

menu_bookDocumentation
May 4, 2026

ScenePhysicsSystem: Physics Sub-Stepping at 120Hz, Collision Event Routing, Keyframe Colliders, and Editor Physics

ScenePhysicsSystem: How Physics Steps Work in s&box is the built-in that drives physics simulation. Understanding it explains the physics step order and collisi…

menu_bookDocumentation
May 4, 2026

RenderOptions: Game, Overlay, Bloom, AfterUI Render Layers — and Renderer.Attributes for Shader Parameters

RenderOptions: Render Layers for SceneObjects controls which render layers a component's appears in. It's exposed as a property on all subclasses. Render Layers…

menu_bookDocumentation
May 4, 2026

s&box LineRenderer and TrailRenderer: Points, Spline Interpolation, Face Modes, Texture Scrolling, and DepthFeather

s&box LineRenderer and TrailRenderer: Procedural Line Rendering renders a line through a list of points with configurable width, color, and spline interpolation…