auto_stories

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
in codeAPI Reference 133 results closeClear
codeAPI Reference
May 4, 2026

s&box SoundHandle: Full Audio Playback Control API

s&box SoundHandle: Full Audio Playback Control API is returned by and gives full control over a playing sound. Playing Sounds SoundHandle Properties Stopping St…

codeAPI Reference
May 4, 2026

s&box DamageInfo: Extensible Damage Data Class and IDamageable Interface

s&box DamageInfo: Extensible Damage Data Class is a class (not a struct) so it can be subclassed for game-specific damage types. Definition Usage IDamageable In…

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…

codeAPI Reference
May 3, 2026

BasePickup with ITriggerListener and ICollisionListener

BasePickup Abstract Class Abstract base for item pickups using trigger and collision detection with host-only consumption. Key Patterns **** — trigger volume pi…

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…

codeAPI Reference
May 3, 2026

LimitsSystem Per-Player Spawn Limits

LimitsSystem Per-Player Limits Enforces configurable spawn limits per player with automatic tracking via ISpawnEvents. Key Features Per-player tracking via Stea…

codeAPI Reference
May 3, 2026

GameManager.Spawn RPC with Ident Parsing

GameManager.Spawn RPC Broadcast RPC for spawning entities from string identifiers with automatic weapon pickup detection. Ident Format - Spawn a prop from asset…

codeAPI Reference
May 3, 2026

PlayerData Component for Stats and Respawn

PlayerData Component Persistent player data component tracking stats (kills, deaths), respawn state, and providing connection lookup. Key Properties Connection …

codeAPI Reference
May 3, 2026

Player Component with Static Accessors

Player Component Main player component that manages health, damage, camera, and interfaces with the inventory system. Static Accessors Key Properties HUD Visibi…

codeAPI Reference
May 3, 2026

BaseConstraintToolMode for Constraint Tools

BaseConstraintToolMode Abstract Class Base class for two-stage constraint tools (weld, rope, elastic, etc.) with selection point handling. Class Overview Contro…

codeAPI Reference
May 3, 2026

ToolMode SelectionPoint and Trace Helpers

ToolMode.SelectionPoint and Trace Helpers Helper methods and data structures for toolgun selection and placement. SelectionPoint Struct Trace Methods Placement …

codeAPI Reference
May 3, 2026

LinkedGameObjectBuilder for Finding Connected Objects

LinkedGameObjectBuilder Utility class for building a set of connected GameObjects by traversing physics joints, constraints, and manual links. Class Definition …

codeAPI Reference
May 3, 2026

Player Event Interfaces (Local and Global)

Local.IPlayerEvents and Global.IPlayerEvents Event interfaces for player lifecycle, damage, inventory, and camera events. Local fires to player hierarchy only; …

codeAPI Reference
May 3, 2026

ToolMode Base Class for Toolgun Modes

ToolMode Base Class Abstract base class for creating toolgun modes in s&box. Handles input registration, action dispatch, and HUD rendering. Class Overview Acti…

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…

codeAPI Reference
May 3, 2026

Sandbox.Storage

Sandbox.Storage Save and load player data. Overview Storage provides persistent storage for player data, save games, and settings with automatic Steam Cloud syn…

codeAPI Reference
May 3, 2026

Sandbox.PhysicsWorld

Sandbox.PhysicsWorld Access to the physics simulation. Overview PhysicsWorld provides access to the physics simulation, including gravity, time step, and broad …

codeAPI Reference
May 3, 2026

Sandbox.Ray

Sandbox.Ray Infinite ray for intersection tests. Overview Ray represents an infinite line starting from a point and extending in a direction. Used for raycastin…

codeAPI Reference
May 3, 2026

Sandbox.BBox

Sandbox.BBox Axis-aligned bounding box. Overview BBox represents an axis-aligned box in 3D space. Used for collision, bounds checking, and spatial queries. Crea…

codeAPI Reference
May 3, 2026

Sandbox.VrAnchor

Sandbox.VrAnchor Locks VR player position. Overview VrAnchor locks the player's playspace to a GameObject's transform. Essential for seated VR, vehicles, and ro…