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 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…

codeAPI Reference
May 12, 2026

s&box PlayerFallDamage: Fall damage component

PlayerFallDamage Component API Reference PlayerFallDamage is a Component that applies fall damage to the player when they land. It implements Local.IPlayerEvent…

codeAPI Reference
May 12, 2026

s&box Projectile: Collision-based projectile

Projectile Component API Reference Projectile is a Component that implements ICollisionListener for collision-based projectiles. It destroys itself on collision…

codeAPI Reference
May 12, 2026

s&box BaseCarryable.IEvent: World model events

BaseCarryable.IEvent Interface API Reference BaseCarryable.IEvent is an interface for receiving world model lifecycle events on carryable objects (weapons, item…

codeAPI Reference
May 12, 2026

s&box TVEntity: Camera feed display

TVEntity Component API Reference TVEntity is a TV screen entity that displays the feed from a linked CameraEntity. Use the Linker tool to connect a Camera to th…

codeAPI Reference
May 12, 2026

s&box EntitySpawnerEntity: Entity spawner

EntitySpawnerEntity Component API Reference EntitySpawnerEntity is a world-placed SENT that spawns another SENT at its location. Can be triggered manually via p…

codeAPI Reference
May 12, 2026

s&box EmitterEntity: Particle emitter entity

EmitterEntity Component API Reference EmitterEntity is a world-placed SENT that spawns and controls a particle/VFX emitter. The emitter prefab is defined by a S…

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…

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 IInspectorEditor: Custom inspector panels

IInspectorEditor Interface API Reference IInspectorEditor is an interface for custom inspector panels that can edit selected GameObjects in the s&box editor. Pa…

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 …

codeAPI Reference
May 12, 2026

s&box ScriptedEmitterModel: Model-based emitter resource

ScriptedEmitterModel GameResource API Reference ScriptedEmitterModel is a GameResource for model-based particle/VFX emitters. It implements IDefinitionResource …

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 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 …

codeAPI Reference
May 12, 2026

s&box ResourceSelectAttribute: Resource picker configuration

ResourceSelectAttribute API Reference ResourceSelectAttribute is used to configure resource selection UI for properties in the inspector. Type Signature Propert…

codeAPI Reference
May 12, 2026

s&box InspectorEditorAttribute: Registering inspector editors

InspectorEditorAttribute API Reference InspectorEditorAttribute is used to register a panel implementing IInspectorEditor with the inspector system. Type Signat…

codeAPI Reference
May 12, 2026

s&box MetadataAttribute: Resource picker filtering

MetadataAttribute API Reference MetadataAttribute is a reusable property attribute that stores a string tag for resource picker filtering. The editor can read t…

codeAPI Reference
May 12, 2026

s&box ISpawner: Spawner interface

ISpawner Interface API Reference ISpawner describes something that can be spawned into the world. Implementations handle their own preview rendering and spawn l…

codeAPI Reference
May 12, 2026

s&box IResourcePreview: Resource preview interface

IResourcePreview Interface API Reference IResourcePreview is an interface for GameResources that want to enable in-picker previewing. When the user clicks an it…

codeAPI Reference
May 12, 2026

s&box ScriptedEmitter: Particle emitter GameResource

ScriptedEmitter GameResource API Reference ScriptedEmitter is a GameResource that defines a particle/VFX emitter with a prefab, used for spawning visual effects…