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 "resource" 56 results closeClear
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 AmmoInventory: Shared ammo pools

AmmoInventory Component API Reference AmmoInventory stores shared ammo pools on a player, keyed by AmmoResource. Add this component to the player prefab alongsi…

menu_bookDocumentation
May 4, 2026

GameResource: Custom Asset Types, PostLoad, PostReload, ResourceLibrary.Get, and Resource Networking

GameResource: Custom Asset Types, PostLoad, and Resource Networking is the base class for all JSON-based assets in s&box (prefabs, scene files, custom assets). …

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

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

menu_bookDocumentation
May 5, 2026

Game Resources - s&box Documentation

Official s&box documentation for Game Resources - custom asset types. GameResource allows defining custom asset types that can be created in the editor and load…

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

IDefinitionResource interface

IDefinitionResource Interface Interface for s&box game resources that have title and description metadata. Properties Title () - Display title for the resource …

menu_bookDocumentation
May 20, 2026

Game Mounts: Creating Custom Asset Mounts for External Games

The s&box mount system is extensible — anyone can write a mount to add support for a new game or engine. A mount detects a game's install directory via Steam, s…

menu_bookDocumentation
May 12, 2026

s&box ISpawnerExtensions: Creating spawner instances

ISpawnerExtensions: Creating ISpawner Instances ISpawnerExtensions provides an extension method to create ISpawner instances from type strings, supporting vario…

groupsCommunity
May 3, 2026

Project Structure Recommendations

Project Structure Recommendations Community guide for organizing s&box projects based on Facepunch examples and successful community projects. Recommended Folde…

menu_bookDocumentation
May 20, 2026

GameResource Extensions: Appending Data to Existing Assets Without Modification

ResourceExtensions in s&box append additional data to existing GameResources without modifying the original class or assets. Useful for adding properties to Clo…

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…

terminalCode Example
May 10, 2026

s&box JSONObject Save Data Helper for Components

This s&box-focused sample shows how to programmatically construct and deconstruct JSON for component save data. It is useful for player saves, world unlock stat…

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…

menu_bookDocumentation
May 4, 2026

IHotloadManaged: Preserving and Restoring State Across s&box Hotloads

IHotloadManaged: Preserving State Across s&box Hotloads When a class is hotloaded in s&box, all live instances are replaced with new instances of the updated ty…

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