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 "property" in menu_bookDocumentation 164 results closeClear
menu_bookDocumentation
May 20, 2026

PlayerController: Built-in First/Third Person Controller with Physics, Input, and Camera

The PlayerController component is a first and third person player controller built into s&box. It is physics-based (a special RigidBody) with built-in input, ca…

menu_bookDocumentation
May 20, 2026

WebSocket Connections with Auth Token Authentication in s&box

s&box supports WebSocket connections to external servers for custom networking or persistent data outside the local filesystem. Basic Connection and Messaging U…

menu_bookDocumentation
May 3, 2026

Terrain System

Terrain System Create expansive outdoor environments with real-time terrain editing, heightmap import, and multi-layer materials. Features Creating Terrain Add …

menu_bookDocumentation
May 20, 2026

Console Variables and Commands: ConVar and ConCmd with Flags

Console variables () and commands () let you create tweakable settings and runnable commands accessible from the s&box console. Console Commands Static methods …

menu_bookDocumentation
May 20, 2026

Achievements: Score-Based and Stat-Based Player Unlocks

s&box achievements allow players to unlock rewards with configurable scores. The API lives in . Score Each achievement has a score (5-100). Low values for easy …

menu_bookDocumentation
May 3, 2026

Particle Effects System

Particle Effects System CPU-simulated, fully controllable particle system for effects like fire, smoke, sparks, and explosions. Architecture The particle system…

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…

menu_bookDocumentation
May 5, 2026

Code Generation - s&box Documentation

Official s&box documentation for Code Generation - compile-time code generation. Code Generation covers the source generator system in s&box. The generator crea…

menu_bookDocumentation
May 20, 2026

VirtualGrid: Virtualized Grid Panel for Large Item Collections

is a s&box UI Panel that virtualizes large item collections — only rendering visible cells. If you have thousands of items, it creates only the few on screen an…

menu_bookDocumentation
May 5, 2026

NavMesh Agent - s&box Gameplay Documentation

NavMesh Agent The NavMeshAgent component provides automatic navigation along the NavMesh. It handles pathfinding, obstacle avoidance, and smooth movement to tar…

menu_bookDocumentation
May 20, 2026

PostProcessVolume: Camera-Based Effect Blending with Box, Sphere, and Infinite Modes

The component in s&box applies post-processing effects to cameras inside its volume. Effect components can be on the same GameObject or child GameObjects. Volum…

menu_bookDocumentation
May 12, 2026

s&box ServerSettings: Server-controlled settings

ServerSettings Static Class ServerSettings is a static class that defines server-controlled settings replicated to all clients. These ConVars control game-wide …

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…

menu_bookDocumentation
May 4, 2026

s&box Easing Functions: Sandbox.Utility.Easing — Quadratic, Exponential, Bounce, Sine, and CSS-Style Name Lookup

s&box Easing Functions: Sandbox.Utility.Easing for Transitions and Animations provides standard easing functions used throughout s&box's UI system and available…

menu_bookDocumentation
May 5, 2026

Hotloading — live code reloading, IL fast path, and common pitfalls

Hotloading — Live Code Reloading s&box recompiles and live-reloads your assembly whenever you save a or file. You don't need to restart the editor for most chan…

menu_bookDocumentation
May 3, 2026

Undo System

Undo System Implement undo/redo functionality in editor tools. Basic Scope Capturing GameObject Changes GameObjectUndoFlags Capturing Creations Capturing Destru…

menu_bookDocumentation
May 4, 2026

Component Lifecycle: Full Callback Order — OnAwake, OnEnabled, OnStart, OnUpdate, OnFixedUpdate, OnDisabled, OnDestroy

Component Lifecycle: Full Callback Order s&box components have a well-defined lifecycle. Understanding the exact order prevents subtle bugs. Callback Order Key …

menu_bookDocumentation
May 4, 2026

Scene.Load and Scene.LoadFromFile: Loading Scenes, DontDestroyOnLoad, and the Loading Sequence

Scene.Load and Scene.LoadFromFile: Loading Scenes Locally loads a scene file into the current scene. This is a local-only operation — it does not bring other cl…

menu_bookDocumentation
May 5, 2026

Network visibility — culling networked objects per client with INetworkVisible

Network Visibility — Culling Networked Objects Per Client Network visibility controls whether a networked object sends updates (Sync Vars, transforms) to a spec…

menu_bookDocumentation
May 4, 2026

NetworkMode, NetworkFlags, OwnerTransfer, NetworkOrphaned — Complete Networking Enum Reference

NetworkMode, NetworkFlags, OwnerTransfer, and NetworkOrphaned — Complete Reference NetworkMode Controls how a is networked. Set via . Once a is a , only the hos…