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

s&box IKillSource: Kill feed attacker interface

IKillSource Interface API Reference IKillSource is an interface for Components that can appear as an attacker in the kill feed. Implement on Player, Npc, explos…

terminalCode Example
May 3, 2026

GameManager INetworkListener Pattern

GameManager INetworkListener Pattern Game manager implementing connection lifecycle with player spawning and cleanup. Implemented Interfaces INetworkListener - …

menu_bookDocumentation
May 12, 2026

s&box LocalProps: Built-in prop definitions

LocalProps Static Class LocalProps is a static class that defines hardcoded models that ship with the game and are not available on the workshop. These models a…

codeAPI Reference
May 12, 2026

s&box DroppedWeapon: Weapon pickup

DroppedWeapon Component API Reference DroppedWeapon handles weapon pickup when a weapon is dropped in the world. Implements IPressable for interaction and Playe…

codeAPI Reference
May 12, 2026

s&box UndoSystem: Per-player undo stacks

GameObjectSystem that provides per-player undo stacks with 128-step limit. Tracks GameObjects for destruction on undo. Classes PlayerStack Per-player undo stack…

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

Styling Panels: SCSS, Inline Styles, and Code-Based Styling

s&box panels can be styled using SCSS stylesheets, inline styles, style blocks, or direct code manipulation. The styling system uses CSS-like syntax but is rend…

menu_bookDocumentation
May 20, 2026

CodeGenerator: Compile-Time Method and Property Wrapping via Attributes

The attribute in s&box lets you create custom attributes that wrap methods and properties at compile time. This is the mechanism behind properties and — you can…

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

Console Variables and Commands: ConVar and ConCmd Runtime Configuration

s&box provides console variables () and console commands () for runtime configuration and debugging. Console Commands Static methods with attribute: Server Comm…

codeAPI Reference
May 12, 2026

s&box IDefinitionResource: Resource metadata interface

IDefinitionResource API Reference IDefinitionResource is an interface for game resources that have display metadata (title and description). Type Signature Prop…

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…

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 …

menu_bookDocumentation
May 5, 2026

Undo System - s&box Editor Documentation

Undo System The undo system allows you to make editor actions reversible. Users can press Ctrl+Z to undo changes made by your tools. Scope Based Undo Create an …

menu_bookDocumentation
May 20, 2026

Custom Assets: GameResource Definition with Inspector and Hotloading

Define custom asset types as in s&box. They provide inspector windows, are hotloaded in-game, and are stored as JSON files with custom extensions. Creating a Cu…

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

s&box PhysicsBody: Body Types, Adding Shapes, Forces vs Impulses, Move vs Transform

s&box PhysicsBody: Body Types, Shapes, Forces, and Move vs Transform is the s&box physics simulation object. It wraps the native physics engine and can have mul…

menu_bookDocumentation
May 20, 2026

Achievements: Score-Based and Stat-Based Player Unlocks

s&box achievements allow players to unlock rewards with configurable scores. The API lives in . Score Each achievement has a score (5-100). Low values for easy …

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

Libraries - s&box Code Documentation

Libraries Libraries are reusable code packages you can share between projects or distribute to others. They provide a way to modularize your code and avoid dupl…