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 "performance" 56 results closeClear
menu_bookDocumentation
May 5, 2026

NavMesh Areas — blocking and cost-modifying regions for AI pathfinding

NavMesh Areas components modify NavMesh generation and agent pathfinding costs within a defined region. Use them to create no-go zones, water areas, or danger z…

menu_bookDocumentation
May 5, 2026

Beams - s&box Rendering Documentation

Beams Beam effects create animated lines between points - useful for lasers, lightning, energy beams, and trails. BeamEffect Component Create beams using the Be…

codeAPI Reference
May 3, 2026

Sandbox.ParticleEffect

Sandbox.ParticleEffect Controls particle system playback. Overview ParticleEffect is the root component for playing particle effects (.vpcf files). Setup Playba…

codeAPI Reference
May 3, 2026

Sandbox.Light

Sandbox.Light Illuminates the scene. Overview Light component adds dynamic lighting to GameObjects. Supports point, spot, and directional lights. Setup Light Ty…

menu_bookDocumentation
May 5, 2026

Custom Snapshot Data - s&box Networking Documentation

Custom Snapshot Data For advanced networking, you can write and read custom data in network snapshots. This allows efficient synchronization of complex game sta…

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…

menu_bookDocumentation
May 5, 2026

Video - s&box Media Documentation

Video s&box can decode and play video files for cutscenes, UI elements, or in-world displays. VideoPlayer The VideoPlayer decodes video and exposes frames as a …

menu_bookDocumentation
May 4, 2026

Engine Frame Loop Order: FrameStart, Scene Tick, and FrameEnd Sequence

Engine Frame Loop Order The s&box engine frame loop runs in a specific order each frame. Understanding this is important for knowing when your code runs relativ…

menu_bookDocumentation
May 5, 2026

Physics Events - s&box Physics Documentation

Physics Events Receive callbacks for physics events in the scene. IScenePhysicsEvents Implement this interface on a component to receive scene-wide physics even…

codeAPI Reference
May 12, 2026

TraceAttackInfo record struct

TraceAttackInfo Record Struct Information about a trace-based attack in s&box, used to pass attack data through the weapon system. Properties Target () - The Ga…

menu_bookDocumentation
May 4, 2026

FindMode and Component Lookup: GetComponent, GetAll, ComponentList, and Hierarchy Search

FindMode and Component Lookup: GetComponent, GetAll, and ComponentList s&box uses a flags enum to control how component searches traverse the hierarchy. Underst…

menu_bookDocumentation
May 4, 2026

Inspector Attributes: Group, Title, Icon, Range, InfoBox, Feature, and More

Inspector Attributes: Controlling How Properties Appear in the Editor s&box provides a rich set of attributes to control how component properties appear in the …

menu_bookDocumentation
May 5, 2026

ActionGraph Component Actions - s&box Documentation

ActionGraph Component Actions Add ActionGraph behavior directly to GameObjects using the ActionGraph component. Component Actions The ActionGraph component lets…

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

ActionGraph — visual scripting with action nodes, delegates, and C# integration

ActionGraph — Visual Scripting ActionGraph is s&box's visual scripting system. Nodes represent actions or expressions, and links carry values or signals between…

menu_bookDocumentation
May 5, 2026

Razor Panels - s&box Documentation

Official s&box documentation for Razor Panels - the UI layout system. Razor Panels use a familiar HTML-like syntax with C# code-behind for building game interfa…

menu_bookDocumentation
May 4, 2026

RPC Security: How s&box Validates Incoming RPCs — Attribute Check, Permission Flags, Kick on Unauthorized

RPC Security: How s&box Validates Incoming RPCs Understanding how s&box validates incoming RPCs is important for writing secure multiplayer code. Validation Ste…

menu_bookDocumentation
May 4, 2026

Component.OnLoad: Async Loading Pattern — LoadingContext, Scene.IsLoading, and Loading Screen Integration

Component.OnLoad: Async Loading Pattern for Components Components can perform async loading work by overriding . This is the correct way to load resources async…

menu_bookDocumentation
May 4, 2026

GameObject.Clone: Two-Pass Cloning, CloneConfig, NotCloned Flag, and Reference Rewiring

GameObject.Clone: Spawning Prefabs and Cloning GameObjects with CloneConfig is the primary way to instantiate prefabs and duplicate GameObjects in s&box. It per…

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…