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 "components" in codeAPI Reference 96 results closeClear
codeAPI Reference
May 12, 2026

TraceAttackInfo record struct

TraceAttackInfo Record Struct Information about a trace-based attack in s&box, used to pass attack data through the weapon system. Properties Target () - The Ga…

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

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 Global.ISaveEvents: Save/load event callbacks

Global.ISaveEvents Interface API Reference Global.ISaveEvents is an interface for Components that want to listen to SaveSystem events. Implement to receive call…

codeAPI Reference
May 12, 2026

BaseCarryable.IEvent interface

BaseCarryable.IEvent Interface Scene event interface for world model lifecycle events on s&box carryable items. Methods OnCreateWorldModel Called when the world…

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

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

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

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 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 PostProcessResource: Post-processing effect GameResource

PostProcessResource GameResource API Reference PostProcessResource is a GameResource that defines a post-processing effect with a prefab, used by the PostProces…

codeAPI Reference
May 12, 2026

s&box SaveSystem: Scene save/load with metadata and event hooks

SaveSystem API Reference SaveSystem is a GameObjectSystem that captures differences between the current scene state and the original scene, enabling save/load f…

codeAPI Reference
May 12, 2026

s&box IKillSource: Kill feed attacker interface

IKillSource Interface API Reference IKillSource is an interface for Components that can appear as an attacker in the kill feed. Implement on Player, Npc, explos…

codeAPI Reference
May 12, 2026

s&box Global.ISpawnEvents: Spawn event callbacks

Global.ISpawnEvents Interface API Reference Global.ISpawnEvents is an interface for Components that want to listen to spawn events across the scene. Implement t…

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 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 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 IToolActionEvents: Tool action callbacks

IToolActionEvents Interface API Reference IToolActionEvents allows listening to tool actions across the scene. Implement this on a Component to receive callback…

codeAPI Reference
May 12, 2026

s&box ControlSystem: Chair control management

GameObjectSystem that manages chair control with seat priority sorting. Routes player input to controllable objects using ClientInput.PushScope(). Behavior Sort…