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 "Component" 432 results closeClear
terminalCode Example
May 4, 2026

Sandbox: CameraNoiseSystem — screen shake, punch, and recoil with ICameraSetup

CameraNoiseSystem — Screen Shake, Punch, and Recoil Effects is a that implements to apply camera noise effects (shake, punch, recoil) each frame. Effects are in…

menu_bookDocumentation
May 20, 2026

Hotloading: Live Code Reload Without Editor Restart in s&box

s&box hotloading recompiles and live-reloads code when you save or files, without restarting the editor. How It Works IL Hotload (Fast): If only method bodies c…

menu_bookDocumentation
May 5, 2026

Clothing - s&box Assets Documentation

Clothing The clothing system allows players to customize their Citizen character with various wearable items. Create hats, shirts, pants, accessories, and more.…

menu_bookDocumentation
May 4, 2026

ModelRenderer Material Overrides: MaterialOverride, SetMaterialOverride by Tag, Per-Index Materials Accessor, and Attachments

ModelRenderer Material Overrides: MaterialOverride, SetMaterialOverride, and Materials Accessor provides several ways to override materials on a model. Global M…

menu_bookDocumentation
May 4, 2026

NetworkOrphaned: Controlling What Happens to a Networked Object When Its Owner Disconnects

NetworkOrphaned: What Happens When an Owner Disconnects When a networked 's owner disconnects, the enum controls what happens to the object. Options How It Work…

codeAPI Reference
May 20, 2026

SceneTraceResult: All Fields and Properties from Trace Hits

is returned by and contains all information about a trace hit. Key Fields Common Usage Pattern

menu_bookDocumentation
May 20, 2026

Time Utilities: TimeSince, TimeUntil, and Frame-Rate Independence

s&box provides time utilities for cooldowns, countdowns, and frame-rate independent movement without manual bookkeeping. Time.Delta Seconds since last frame. Mu…

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

Sandbox: BaseBulletWeapon — hitscan shooting with BulletConfiguration, recoil, and IronSightsWeapon

BaseBulletWeapon — Hitscan Shooting with Recoil and Camera Noise extends and implements hitscan bullet firing with configurable aim cone, recoil, and camera noi…

codeAPI Reference
May 12, 2026

s&box IToolInfo: Tool information display interface

IToolInfo API Reference IToolInfo is an interface for providing tool information display in the UI, such as in the spawn menu or tool selector. Type Signature P…

menu_bookDocumentation
May 20, 2026

Custom GameResource Assets: Define, Create, and Access Custom Asset Types

Define custom asset types as subclasses. They get a nice inspector window, are hotloaded in-game, and are stored as JSON files with a custom extension. Creating…

menu_bookDocumentation
May 20, 2026

WebSocket Connections with Auth Token Authentication in s&box

s&box supports WebSocket connections to external servers for custom networking or persistent data outside the local filesystem. Basic Connection and Messaging U…

menu_bookDocumentation
May 5, 2026

PolygonMesh — procedural block meshes with per-face materials and vertex editing

PolygonMesh — Procedural Block Meshes s&box includes a API for creating and editing meshes at runtime or in editor tools. The editor's block mesh tools use this…

menu_bookDocumentation
May 5, 2026

Connection Permissions - s&box Networking Documentation

Connection Permissions Connection permissions control what clients can do in your multiplayer game. Set permissions for spawning objects, using tools, or perfor…

codeAPI Reference
May 3, 2026

Sandbox.Transform - Position, Rotation and Scale

Sandbox.Transform Position, rotation, and scale combined. Overview Transform combines position, rotation, and scale into a single matrix for efficient calculati…

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…

codeAPI Reference
May 4, 2026

s&box TimeSince and TimeUntil: Convenient Time Measurement Structs

s&box TimeSince and TimeUntil: Convenient Time Measurement Structs Both structs use internally and support implicit conversion from /. TimeSince Measures time e…

menu_bookDocumentation
May 20, 2026

Clutter System: GPU-Instanced Scattering for Grass, Rocks, and Debris

The s&box Clutter System scatters large amounts of small objects (grass, rocks, debris) with GPU-instanced rendering. It handles placement, streaming, and LOD a…

terminalCode Example
May 4, 2026

Sandbox: Duplicator tool — copy, paste, and save contraptions with DuplicationData

Duplicator Tool — Copy, Paste, and Save Contraptions The Duplicator tool copies a contraption (a connected graph of GameObjects) to JSON and pastes it back. It …

menu_bookDocumentation
May 20, 2026

Hotloading Pitfalls: Default Values, Types, Delegates, and Optimization

s&box hotloads code changes live when you save or files. Understanding the pitfalls helps avoid subtle bugs during development. How It Works IL Hotload (Fast): …