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 "Protected" 157 results closeClear
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). …

menu_bookDocumentation
May 4, 2026

Networking Static Class: IsHost, IsClient, CreateLobby, Connect, SetData, and Debug Convars

Networking Static Class: IsHost, IsClient, CreateLobby, Connect, and Server Data The static class manages the multiplayer session in s&box. Session State Note: …

menu_bookDocumentation
May 4, 2026

Voice Component: Push-to-Talk, Lip Sync Visemes, ExcludeFilter, ShouldHearVoice, and Amplitude

Voice Component: Voice Chat, Lip Sync, and Viseme Morphs The component handles voice chat recording, transmission, and playback with optional lip sync. Basic Se…

terminalCode Example
May 12, 2026

Slot-based inventory UI with BuildHash optimization

Slot-Based Inventory UI with BuildHash Optimization This example shows a slot-based inventory UI with BuildHash() optimization to prevent unnecessary rebuilds a…

menu_bookDocumentation
May 20, 2026

Custom GameResource Assets: Define, Create, and Access Custom Asset Types

Define custom asset types as subclasses. They get a nice inspector window, are hotloaded in-game, and are stored as JSON files with a custom extension. Creating…

terminalCode Example
May 20, 2026

NavMesh Links: Custom Jump and Ladder Traversal for AI Agents

NavMesh Links connect disconnected NavMesh regions (jumps, ladders, teleports). By default agents linearly interpolate between endpoints, but you can implement …

menu_bookDocumentation
May 20, 2026

Custom Assets: GameResource Definition with Inspector and Hotloading

Define custom asset types as in s&box. They provide inspector windows, are hotloaded in-game, and are stored as JSON files with custom extensions. Creating a Cu…

menu_bookDocumentation
May 20, 2026

Input System Overview: Button Queries, Analog Input, and Escape Override

The s&box Input class provides button queries, analog input, and escape key handling for gameplay. Button Queries Analog Input Custom Keys Configure input actio…

codeAPI Reference
May 3, 2026

Sandbox.VrAnchor

Sandbox.VrAnchor Locks VR player position. Overview VrAnchor locks the player's playspace to a GameObject's transform. Essential for seated VR, vehicles, and ro…

terminalCode Example
May 5, 2026

DebugOverlay — in-game visualization for spheres, lines, text, and traces

DebugOverlay — In-Editor and In-Game Visualization draws shapes, text, and traces in the world for debugging. All draws are temporary and disappear after a spec…

menu_bookDocumentation
May 4, 2026

s&box CharacterController: Physics-Free Movement Component

s&box CharacterController: Physics-Free Movement Component provides collision-constrained movement without a . It only moves when you explicitly call or . Key P…

menu_bookDocumentation
May 3, 2026

Post Processing System

Post Processing System Add visual effects like bloom, tonemapping, and film grain with post-processing volumes. Overview Post processing in s&box uses a volume-…

codeAPI Reference
May 12, 2026

s&box ScriptedEntity: Custom entity GameResource

ScriptedEntity GameResource API Reference ScriptedEntity is a GameResource that defines a spawnable entity with a prefab, used by the spawn menu to create custo…

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 AmmoResource: Shared ammo type GameResource

AmmoResource GameResource API Reference AmmoResource is a GameResource that defines a type of ammo that can be shared across weapons. Weapons that reference the…

menu_bookDocumentation
May 5, 2026

Texture Generators - s&box Editor Documentation

Texture Generators Create procedural textures in code. Generate textures from shapes, gradients, text, or any algorithm. Creating a Generator Inherit from : Pro…

terminalCode Example
May 5, 2026

Math types — Vector3, Rotation, Angles, Transform, TimeSince, and BBox

Math Types — Vector3, Rotation, Angles, and Transform s&box uses its own math types. Here's a practical reference for the ones you'll use constantly. Vector3 Ro…

codeAPI Reference
May 12, 2026

s&box BalloonDefinition: Balloon type GameResource

BalloonDefinition GameResource API Reference BalloonDefinition is a GameResource that defines a balloon type with a prefab, used by the Balloon tool to spawn ba…

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…

menu_bookDocumentation
May 20, 2026

NavMesh Links: Custom Agent Traversal with Jump, Ladder, and Physics Examples

NavMesh Links in s&box connect disconnected navigation areas, allowing agents to jump, climb ladders, or traverse gaps. Add a NavMeshLink component to a GameObj…