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
menu_bookDocumentation
May 20, 2026

Async Tasks and Coroutines in s&box Components

Async tasks in s&box run on the main thread by default, operating like coroutines. They are the recommended replacement for coroutines. Basic Async Method Frame…

terminalCode Example
May 3, 2026

Prefab Spawning and Cloning

Prefab Spawning and Cloning Prefabs are reusable GameObject templates that can be instantiated at runtime. Creating Prefabs Create a GameObject in the scene wit…

terminalCode Example
May 3, 2026

Rigidbody Physics

The component enables physics simulation on GameObjects. Basic Usage Rigidbody Properties Forces Collision Detection Wake/Sleep Spawn with Velocity

codeAPI Reference
May 12, 2026

s&box ICleanupEvents: Cleanup event callbacks

ICleanupEvents API Reference ICleanupEvents is an interface for receiving callbacks when the scene is cleaned up (map reset). Type Signature Method - Called aft…

menu_bookDocumentation
May 20, 2026

Networked Objects: Spawning, Network Modes, and Interpolation

Any GameObject can become networked by calling . It will then be sent to all clients and can have Sync Properties and RPC Messages. Spawning a Networked Object …

menu_bookDocumentation
May 20, 2026

RPC Messages: Broadcast, Owner, Host with Filtering and Caller Info

Components can contain RPCs — functions that when called locally, are also called remotely. Supported RPC argument types are the same as Sync properties. Basic …

menu_bookDocumentation
May 20, 2026

TemporaryEffect: Auto-Cleanup for Particle and Sound Prefabs

The TemporaryEffect component in s&box is added to prefabs containing ParticleEffects and Sounds. It automatically deletes the GameObject after all particles ar…

menu_bookDocumentation
May 5, 2026

Beams - s&box Rendering Documentation

Beams Beam effects create animated lines between points - useful for lasers, lightning, energy beams, and trails. BeamEffect Component Create beams using the Be…

menu_bookDocumentation
May 4, 2026

Collider Component: Triggers, Surface Properties, Keyframe Bodies, Concave Shapes, and Tag Propagation

Collider Component: Triggers, Surface Properties, and Keyframe Bodies The abstract base class is the foundation for all physics colliders in s&box (, , , , ). T…

terminalCode Example
May 5, 2026

Rendering entities — TextRenderer, LineRenderer, SpriteRenderer, TrailRenderer, and ModelRenderer

Rendering Entities — Text, Line, Sprite, and Trail Renderers s&box provides several lightweight renderer components for common visual needs that don't require a…

menu_bookDocumentation
May 4, 2026

GameObjectSystem with [Sync] and RPCs: Networked Scene-Level State

GameObjectSystem with [Sync]: Networked Scene-Level State supports properties just like components. However, there is a key difference: all properties on a are …

codeAPI Reference
May 12, 2026

s&box EnvironmentShake: Camera shake component

Component that creates camera shake effects based on distance and time curves. Implements ICameraSetup to apply rotation noise during PostSetup. Properties Prop…

menu_bookDocumentation
May 20, 2026

Shader Graph Getting Started: Visual Shader Editor in s&box

s&box Shader Graph is a visual scripting language that compiles to shader code. Accessible to beginners and useful for rapid prototyping by experienced shader d…

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…

codeAPI Reference
May 3, 2026

Sandbox.Angles

Sandbox.Angles Euler angles (yaw, pitch, roll) representation. Overview Angles stores rotation as yaw, pitch, and roll in degrees — easier to work with than qua…

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…

menu_bookDocumentation
May 20, 2026

DecalDefinition: PBR Decal Assets with Color, Normal, and Parallax

A DecalDefinition in s&box holds what a single decal should look like. It describes color, normals, roughness, metalness, ambient occlusion, and optional parall…

codeAPI Reference
May 12, 2026

s&box BaseToggle: Toggle state base class

Abstract base class for toggle state with [Sync] support and event callbacks. Properties Methods Usage Inherit from this class for any component that needs a sy…

codeAPI Reference
May 12, 2026

s&box ICameraSetup: Camera render hooks

Interface for camera setup hooks that allow fine-grained control over camera effects. Implement to modify the camera at specific stages of the render pipeline. …

codeAPI Reference
May 12, 2026

s&box WaterVolume: Buoyancy physics for water volumes

WaterVolume API Reference WaterVolume is a Component that applies buoyancy physics to Rigidbody objects entering a trigger volume. Type Signature Physics Implem…