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 "Overlay" 20 results closeClear
menu_bookDocumentation
May 12, 2026

s&box WheelOverlay: Direction arrow overlay

WheelOverlay Static Class WheelOverlay is an internal static class that draws a spinning direction arrow overlay on wheel faces. Used by the Wheel tool to visua…

menu_bookDocumentation
May 12, 2026

s&box SnapGrid: World-space snap grid overlay

SnapGrid: World-Space Snap Grid Overlay SnapGrid is a sealed class that manages a world-space snap grid overlay projected onto a surface plane. It is used by th…

terminalCode Example
May 5, 2026

WorldPanel and ScreenPanel — HUD overlays and 3D world-space UI with Razor PanelComponent

WorldPanel and ScreenPanel — UI in the World s&box UI uses (Razor) attached to either a (HUD overlay) or (3D world-space UI). The same component works with both…

menu_bookDocumentation
May 12, 2026

s&box PostProcessGroup: Post-process categories

PostProcessGroup Enum Documentation PostProcessGroup is an enum that categorizes post-processing effects for organization in the spawn menu and asset browser. I…

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…

menu_bookDocumentation
May 20, 2026

Platform Chat - Built-in Multiplayer Text Chat System

Built-in text chat for multiplayer games. Messages are routed through the host, validated, filtered, and displayed via the standard overlay UI - no game code re…

terminalCode Example
May 5, 2026

Custom editor tools — EditorTool, Gizmo drawing, scene tracing, and overlay UI

Custom Editor Tools Editor tools appear in the s&box toolbar and let you build scene editing workflows — painting, placement, custom gizmos. They must live in a…

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…

menu_bookDocumentation
May 4, 2026

SceneCamera: World-to-Screen, Screen-to-World, Render Hooks, and Camera Properties

SceneCamera: World-to-Screen, Screen-to-World, and Render Hooks is the main camera class in s&box. It wraps a native frustum and provides coordinate conversion,…

codeAPI Reference
May 12, 2026

s&box MountMetadata: Mount fallback rendering

MountMetadata Component API Reference MountMetadata is attached to mount-spawned props to show a graceful bounding box and hint the player which game it's from …

menu_bookDocumentation
May 4, 2026

s&box CameraComponent: Screen/World Conversion, RenderToTexture, Priority, Viewport, and Oblique Projection

s&box CameraComponent: Screen/World Conversion, RenderToTexture, and Priority wraps a and provides the main rendering configuration for a s&box scene. Every sce…

groupsCommunity
May 5, 2026

s&box built-in component quick reference — rendering, physics, navigation, UI, and audio

s&box Component Quick Reference A cheat sheet of the most commonly used built-in components and what they do. Rendering Lighting Physics Navigation UI Audio Gam…

menu_bookDocumentation
May 3, 2026

Editor Tools

Editor Tools Create custom tools for the s&box editor. Creating a Tool Scene Access Gizmo Drawing Preventing Selection Overlay UI Editor Project Setup Tools mus…

terminalCode Example
May 4, 2026

Sandbox: Duplicator tool — copy, paste, and save contraptions with DuplicationData

Duplicator Tool — Copy, Paste, and Save Contraptions The Duplicator tool copies a contraption (a connected graph of GameObjects) to JSON and pastes it back. It …

menu_bookDocumentation
May 4, 2026

RenderOptions: Game, Overlay, Bloom, AfterUI Render Layers — and Renderer.Attributes for Shader Parameters

RenderOptions: Render Layers for SceneObjects controls which render layers a component's appears in. It's exposed as a property on all subclasses. Render Layers…

codeAPI Reference
May 12, 2026

s&box ScheduleBase: NPC schedule base class

Abstract base class for NPC schedules. A schedule executes a sequence of tasks with cancellation support. Properties Methods Behavior Executes tasks sequentiall…

codeAPI Reference
May 12, 2026

s&box BaseNpcLayer: NPC behavior layer base

Abstract base class for NPC behavior layers. Layers provide specific services (navigation, senses, speech) for tasks to use. Properties Methods Usage Inherit fr…

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

HudPainter: Immediate-Mode HUD Drawing in s&box

Each has a property (HudPainter) for immediate-mode drawing onto the screen. More efficient than UI panels since there's no layout, stylesheets, or interactivit…

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…