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
Results for "reference" 138 results closeClear
menu_bookDocumentation
May 3, 2026

Decals in s&box

Decals in s&box Decals are textures projected onto surfaces for bullet holes, graffiti, scorch marks, etc. Decal Component Add to a GameObject: DecalDefinition …

menu_bookDocumentation
May 5, 2026

Component Events - s&box Scene Documentation

Component Events Components can broadcast and listen for events. This provides a decoupled way for components to communicate without direct references. Event In…

codeAPI Reference
May 12, 2026

s&box SoundDefinition: Categorized sound GameResource

SoundDefinition GameResource API Reference SoundDefinition is a GameResource that defines a categorized sound for use on spawned entities (thrusters, hoverballs…

codeAPI Reference
May 12, 2026

s&box TaskStatus: NPC task status enum

TaskStatus Enum API Reference TaskStatus is an enum returned by task execution in the NPC system to indicate the current state of a task. Type Signature Values …

menu_bookDocumentation
May 4, 2026

Sandbox: Hydraulic tool — motorized SliderJoint with LineRenderer shaft

Sandbox Hydraulic Tool — Motorized SliderJoint Constraints The Hydraulic tool creates a between two objects with a component that can extend and retract the joi…

terminalCode Example
May 4, 2026

Sandbox: BaseCarryable — unified AimRay, WeaponModel resolution, and seat-aware damage

BaseCarryable — Unified Weapon Base with AimRay and Seat Support is the root class for all holdable items. It handles viewmodel/worldmodel management, a unified…

codeAPI Reference
May 12, 2026

s&box ToolAction: Toolgun input binding

ToolAction Enums and ToolActionEntry API Reference ToolInput, InputMode, and ToolActionEntry are used by the toolgun system to bind actions to input slots with …

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…

codeAPI Reference
May 12, 2026

s&box ICookieSource: Cookie persistence interface

ICookieSource API Reference ICookieSource is an interface for components that want to save their properties as cookies (persistent user preferences stored in Ga…

codeAPI Reference
May 12, 2026

s&box LineDefinition: Trail line resource

LineDefinition GameResource API Reference LineDefinition is a GameResource for trail line definitions used by the Trail tool. It implements IDefinitionResource …

menu_bookDocumentation
May 12, 2026

LocalData static class: Server-side data persistence

LocalData Static Class API Reference LocalData provides server-side data persistence that survives server restarts. It's useful for storing configuration, ban l…

codeAPI Reference
May 12, 2026

s&box Ownable: Ownership tracking component

Ownable Component API Reference Ownable is a Component that tracks which Connection (player) spawned a GameObject, enabling prop protection and ownership checks…

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…

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…

codeAPI Reference
May 12, 2026

s&box EmitMode: Emitter firing mode

EmitMode Enum API Reference EmitMode is an enum that defines how an emitter fires - either toggling on/off with a press, or emitting only while input is held do…

codeAPI Reference
May 12, 2026

s&box DynamiteEntity: Explosive entity

DynamiteEntity Component API Reference DynamiteEntity is a Component that implements IPlayerControllable and IDamageable for an explosive entity. It can be trig…

groupsCommunity
May 5, 2026

Scene setup checklist — minimum viable scene with lighting, post-processing, and physics

Scene Setup Checklist for New Projects A quick reference for the components every new s&box scene typically needs. Minimum Viable Scene Lighting Post-Processing…

menu_bookDocumentation
May 12, 2026

s&box GamePreferences: User preferences

GamePreferences Static Class GamePreferences is a static class that defines the local user's preferences for the game. These ConVars control player-specific set…