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 "Get()" 321 results closeClear
terminalCode Example
May 5, 2026

ConVar and ConCmd — console variables and commands with flags and game settings

ConVar and ConCmd — Console Variables and Commands and are s&box attributes for exposing variables and commands to the developer console. Console Commands Conso…

terminalCode Example
May 4, 2026

Sandbox: BaseWeapon — ammo system, reload, shoot delay, and IPlayerControllable

BaseWeapon — Ammo, Reloading, and Firing Pattern extends and adds ammo management, reloading, and a shoot delay system. It implements so it can also be used fro…

terminalCode Example
May 3, 2026

Sync Properties for Networked State

Sync Properties for Multiplayer The attribute automatically synchronizes property values to all clients when they change. Basic Sync Sync Flags Customize sync b…

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…

codeAPI Reference
May 3, 2026

Door Component with IPressable Interface

Door Component with IPressable Map entity door with animated open/close using curves and the IPressable interface. Key Features AnimationCurve for smooth motion…

menu_bookDocumentation
May 20, 2026

Sync Properties: Networked State with Change Detection and Collections

The attribute on a Component property sends its latest value to other players each time it changes. Only the owner of the object can change synced properties. B…

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

Input - s&box Gameplay Documentation

Input s&box provides a comprehensive input system that handles keyboard, mouse, and gamepad input. The input system uses named actions defined in your project s…

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 …

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

Property Attributes for Editor Inspector

Property Attributes for Editor Inspector Property attributes customize how fields appear and behave in the s&box editor inspector. Organization Attributes Visib…

codeAPI Reference
May 12, 2026

s&box PhysicalProperties: Physical property persistence

PhysicalProperties Component API Reference PhysicalProperties is a Component that persists physical properties (mass, gravity, health) across duplication and ne…

codeAPI Reference
May 3, 2026

Global.ISpawnEvents Spawn Event Interface

Global.ISpawnEvents Interface Scene-wide event interface for listening to spawn operations. Implement on components to receive pre/post spawn callbacks. Interfa…

menu_bookDocumentation
May 3, 2026

s&box Cheat Sheet

s&box Cheat Sheet Quick reference for common s&box operations. Debugging Transforms GameObjects Components Input Networking

terminalCode Example
May 4, 2026

Sandbox: Stacker tool — duplicate objects in a line or arc with StackAlignMode

Stacker Tool — Duplicate Objects in a Line or Arc The Stacker tool clones a selected object N times along a configurable axis with optional rotation and gap. It…

codeAPI Reference
May 12, 2026

s&box MountMetadata: Mount fallback rendering

MountMetadata Component API Reference MountMetadata is attached to mount-spawned props to show a graceful bounding box and hint the player which game it's from …

menu_bookDocumentation
May 5, 2026

GameResource Extensions - s&box Assets Documentation

GameResource Extensions Extend GameResource types with additional data. Create extensions that attach to existing resources like models or sounds. Creating a Re…

codeAPI Reference
May 12, 2026

s&box TriggerPush: Trigger-based push force

TriggerPush Component API Reference TriggerPush is a Component that pushes objects (players and rigidbodies) that enter its trigger collider. Type Signature Pro…

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…

codeAPI Reference
May 12, 2026

s&box BallSocketPair: Hydraulic ball socket visual

BallSocketPair Component API Reference BallSocketPair is a Component that aligns two ball socket models towards each other and updates a line renderer between t…