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 PhysicalProperties: Physical property persistence

PhysicalProperties Component API Reference PhysicalProperties is a Component that persists physical properties (mass, gravity, health) across duplication and ne…

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 IDefinitionResource: Resource metadata interface

IDefinitionResource API Reference IDefinitionResource is an interface for game resources that have display metadata (title and description). Type Signature Prop…

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 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 IKillIcon: Kill feed icon interface

IKillIcon API Reference IKillIcon is an interface for components that can display a kill icon in the kill feed or other UI elements. Type Signature Property - T…

codeAPI Reference
May 12, 2026

s&box ICameraSetup: Camera setup callbacks

ICameraSetup API Reference ICameraSetup is an interface for receiving callbacks during camera setup, allowing fine-grained control over camera effects before, d…

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…

codeAPI Reference
May 12, 2026

s&box IToolActionEvents: Tool action event interface

IToolActionEvents API Reference IToolActionEvents is a scene-wide interface for listening to toolgun actions before and after they execute. Type Signature Actio…

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…

codeAPI Reference
May 12, 2026

s&box BasePickup: Trigger and collision-based pickup system

BasePickup API Reference BasePickup is an abstract Component for creating trigger or collision-based pickups (weapons, ammo, items). Type Signature Required Com…

codeAPI Reference
May 12, 2026

s&box PostProcessManager: Post-processing resource management

PostProcessManager API Reference PostProcessManager is a GameObjectSystem that manages post-processing resources with preview, toggle, and camera attachment. Ty…

codeAPI Reference
May 12, 2026

s&box BanSystem: Ban list management with persistence

BanSystem API Reference BanSystem is a GameObjectSystem that manages a ban list with LocalData persistence and connection blocking. Type Signature Key Methods -…

codeAPI Reference
May 12, 2026

s&box ServerSettings: Replicated server-controlled settings

ServerSettings API Reference ServerSettings is a static class for server-controlled settings that are replicated to all clients. Type Signature Example Property…

codeAPI Reference
May 12, 2026

s&box GamePreferences: ConVar-based user settings with attributes

GamePreferences API Reference GamePreferences is a static class for defining user preferences using ConVar attributes with automatic persistence. Type Signature…

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 4, 2026

s&box Game Static Class: Core Game State and Operations

s&box Game Static Class: Core Game State and Operations The static class provides global access to core game state, utilities, and operations. Scene Management …

codeAPI Reference
May 4, 2026

s&box ResourceLibrary: Loading and Accessing Game Resources

s&box ResourceLibrary: Loading and Accessing Game Resources (and ) provides access to all loaded resources. Loading Resources ```csharp // Synchronous get (retu…

codeAPI Reference
May 4, 2026

s&box NetworkMode Enum and INetworkListener: Controlling Network Participation

s&box NetworkMode Enum: Controlling How GameObjects Are Networked controls how a participates in the network. Usage NetworkMode.Object The object has an owner (…

codeAPI Reference
May 4, 2026

s&box Inspector Attributes: Complete Reference for Component Properties

s&box Inspector Attributes: Complete Reference for Component Properties These attributes control how properties appear in the s&box editor inspector. Display At…