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 "true" 244 results closeClear
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…

codeAPI Reference
May 12, 2026

s&box FuncMover: Moving and rotating objects

FuncMover Component API Reference FuncMover is a Component that moves and rotates a GameObject with configurable linear and rotational movement patterns. Type S…

terminalCode Example
May 3, 2026

CleanupSystem Pattern for Map Reset and Scene Management

CleanupSystem - Scene State Management and Map Cleanup A that captures the baseline scene state and allows resetting the map to its original state. Removes spaw…

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…

terminalCode Example
May 12, 2026

CleanupSystem: Map reset and baseline restoration

CleanupSystem: Map Reset and Baseline Restoration This example shows the CleanupSystem which tracks the baseline scene state and allows resetting the map to its…

terminalCode Example
May 10, 2026

Trigger-Based Background Music Crossfade Framework

This pattern replaces area music with a small local-client music framework. Each zone requests a target , while one controller crossfades the currently playing …

codeAPI Reference
May 4, 2026

s&box Inspector Attributes: Complete Reference for Component Properties

s&box Inspector Attributes: Complete Reference for Component Properties These attributes control how properties appear in the s&box editor inspector. Display At…

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: **** — …

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

menu_bookDocumentation
May 4, 2026

s&box Rigidbody Component: Physics Body Reference

s&box Rigidbody Component: Physics Body Reference adds physics simulation to a . It requires at least one component on the same object. Key Properties Force and…

terminalCode Example
May 11, 2026

UIDecal Component - Render Razor UI as a Decal

A Render Component for s&box that allows you to project Razor UI onto surfaces as a Decal. Great for sticking UI onto rounded walls, curved surfaces, or any geo…

menu_bookDocumentation
May 4, 2026

Component.GetComponent, GetComponentInChildren, GetComponentInParent — FindMode and RequireComponent

Component.GetComponent, GetComponentInChildren, GetComponentInParent — FindMode Reference Components provide convenient lookup methods for finding other compone…

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

Sandbox: CleanupSystem — full scene cleanup and per-player cleanup with Ownable

Sandbox CleanupSystem — Scene Cleanup and Per-Player Cleanup is a that handles cleaning up spawned objects. It distinguishes between "baseline" objects (part of…

codeAPI Reference
May 12, 2026

s&box Tracer: Projectile trail renderer

Tracer Renderer Component API Reference Tracer is a Renderer component that creates a tracer effect (like bullet trails) that travels from its world position to…

terminalCode Example
May 4, 2026

Sandbox: Ownable component — prop protection with IPhysgunEvent and IToolgunEvent

Ownable Component — Prop Protection and Physgun/Toolgun Access Control The component tracks which spawned a . It implements and to enforce ownership checks when…

terminalCode Example
May 3, 2026

Ownable Component Pattern for Prop Ownership

Ownable Component - Prop Ownership and Permission System A component that tracks which player spawned an object and enforces ownership-based permissions. Useful…

terminalCode Example
May 5, 2026

Spatial audio components — SoundPoint, SoundBox, SoundscapeTrigger, DspVolume, and AudioListener

Spatial Audio Components s&box provides several components for placing audio in the world. All are alternatives to for persistent, positioned audio sources. Sou…

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…