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 "events" 113 results closeClear
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…

menu_bookDocumentation
May 4, 2026

Sound.Play and SoundHandle: 3D Audio, Volume, Pitch, Occlusion, UI Sounds, and Dedicated Server Behavior

Sound.Play and SoundHandle: Audio Playback in s&box is the static entry point for audio playback. is the returned handle for controlling a playing sound. Playin…

menu_bookDocumentation
May 4, 2026

s&box Hotload System: How Code Reloading Works, SkipHotload, ConVar Persistence, and NetworkObject.OnHotload

s&box Hotload System: How Code Reloading Works s&box supports live code reloading (hotload) without restarting the game. Understanding how it works helps avoid …

menu_bookDocumentation
May 4, 2026

SceneAnimationSystem: Threaded Animation, Bone Merge Order, Procedural Bones, and Ragdoll Physics Step

SceneAnimationSystem: Threaded Animation Updates and Bone Merge Order drives all animation updates. It runs at (after , before ). Threading Model Animation upda…

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…

terminalCode Example
May 3, 2026

GameManager INetworkListener Pattern

GameManager INetworkListener Pattern Game manager implementing connection lifecycle with player spawning and cleanup. Implemented Interfaces INetworkListener - …

codeAPI Reference
May 12, 2026

s&box SpeechLayer: NPC speech and subtitles

NPC behavior layer that manages speech state, plays sound files, and renders subtitle text above the NPC's head. Properties Methods Behavior Resolves a random s…

menu_bookDocumentation
May 20, 2026

Component Interfaces: IDamageable, ICollisionListener, ExecuteInEditor

s&box provides several built-in component interfaces for physics, damage, networking, and editor execution. ExecuteInEditor Runs component methods (OnAwake, OnE…

menu_bookDocumentation
May 20, 2026

PlayerController: Physics-Based Character with Events Interface

The component is a physics-based first/third person player controller. Add it to a scene and be running around with no programming required. Core Features Physi…

menu_bookDocumentation
May 20, 2026

ISceneStartup: Host and Client Scene Initialization Events

is a scene event interface for listening to scene initialization on host and client. It runs when pressing play in editor, loading a game, or joining a server. …

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…

menu_bookDocumentation
May 20, 2026

UI Style Properties: CSS Reference with Custom Pseudo-Classes and Sound Events

s&box UI styling follows web CSS conventions with some differences. Everything is flex by default. Key custom properties include / for hover/click sounds, , and…

menu_bookDocumentation
May 20, 2026

Animation System: Animgraph, Skeletal Animation, IK, and Ragdolls

s&box uses Valve's Animgraph system for character animation, providing a powerful node-based animation state machine. Key Features Animgraph — node-based animat…

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…

codeAPI Reference
May 3, 2026

Sandbox.UI.Panel

Sandbox.UI.Panel Base class for UI panels. Overview Panel is the base class for all UI in s&box. Create panels using Razor (.razor) files or dynamically in code…

menu_bookDocumentation
May 12, 2026

s&box NpcConVars: Global NPC AI settings

NpcConVars Static Class NpcConVars is a static class that defines console variables controlling global NPC AI behavior in s&box. These ConVars can be set via co…

codeAPI Reference
May 3, 2026

GameManager.Spawn RPC with Ident Parsing

GameManager.Spawn RPC Broadcast RPC for spawning entities from string identifiers with automatic weapon pickup detection. Ident Format - Spawn a prop from asset…

codeAPI Reference
May 4, 2026

s&box TimeSince and TimeUntil: Convenient Time Measurement Structs

s&box TimeSince and TimeUntil: Convenient Time Measurement Structs Both structs use internally and support implicit conversion from /. TimeSince Measures time e…

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

Platform Chat: Built-in Text Chat with IChatEvent Filtering

s&box includes a built-in platform chat system for multiplayer games. Messages are routed through the host, validated, filtered via Steam's text filter, and dis…