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

s&box DupeCategory: Workshop duper categories

s&box DupeCategory Enum DupeCategory is an enum used to categorize workshop dupes for filtering and browsing. Each category has an associated icon for UI displa…

menu_bookDocumentation
May 12, 2026

s&box StackDirection: Stacker tool directions

s&box StackDirection Enum StackDirection is an enum used by the Stacker tool to specify which axis to stack objects along. It defines the six cardinal direction…

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…

codeAPI Reference
May 12, 2026

s&box BaseToggle: Toggle state base class

Abstract base class for toggle state with [Sync] support and event callbacks. Properties Methods Usage Inherit from this class for any component that needs a sy…

menu_bookDocumentation
May 20, 2026

Razor Panels: HTML/CSS UI with C# in s&box

s&box UI can be created using Razor syntax — web-like HTML/CSS combined with C#. Panels are not rendered via a HTML renderer; the syntax is a convenience layer …

menu_bookDocumentation
May 20, 2026

Scene Events: Interface-Based Broadcasting and Listening

s&box uses interface-based events to broadcast and listen to events within a scene. Events are sent to active Components and GameObjectSystems — they are NOT se…

menu_bookDocumentation
May 20, 2026

Styling Panels: SCSS, Inline Styles, and Code-Based Styling

s&box panels can be styled using SCSS stylesheets, inline styles, style blocks, or direct code manipulation. The styling system uses CSS-like syntax but is rend…

menu_bookDocumentation
May 20, 2026

Localization: Multi-Language Token System for UI Text

s&box supports localization via JSON token files. Any displayed string beginning with is treated as a localization token and automatically replaced with the use…

menu_bookDocumentation
May 20, 2026

CodeGenerator: Compile-Time Method and Property Wrapping via Attributes

The attribute in s&box lets you create custom attributes that wrap methods and properties at compile time. This is the mechanism behind properties and — you can…

menu_bookDocumentation
May 20, 2026

Prefab Instance Overrides: Property, Component, and GameObject Customization

Prefab instance overrides in s&box allow you to customize individual instances of a prefab without affecting the original or other instances. The instance remem…

menu_bookDocumentation
May 20, 2026

Leaderboard Web API: Public REST Endpoint with Aggregation and Filtering

The s&box leaderboard Web API is publicly accessible for querying player rankings based on stats. Endpoint Parameters stat — stat name to base the leaderboard o…

menu_bookDocumentation
May 20, 2026

Creating Terrain: Heightmap Setup, World Scale, and Asset Reuse

To add Terrain to your s&box scene, right-click in the Hierarchy and select 3D Object → Terrain. The inspector prompts you to create, import, or link an existin…

menu_bookDocumentation
May 4, 2026

ComponentFlags: Hidden, NotSaved, NotNetworked, NotCloned — Controlling Component Behavior

ComponentFlags: Controlling Component Serialization, Networking, and Visibility is a flags enum on that controls how a component behaves in the editor, serializ…

codeAPI Reference
May 3, 2026

Sandbox.Vector3

Sandbox.Vector3 3D vector for positions, directions, and offsets. Overview Vector3 is the primary type for 3D coordinates and directions in s&box. Creation Cons…

menu_bookDocumentation
May 4, 2026

NetworkOrphaned: Controlling What Happens to a Networked Object When Its Owner Disconnects

NetworkOrphaned: What Happens When an Owner Disconnects When a networked 's owner disconnects, the enum controls what happens to the object. Options How It Work…

menu_bookDocumentation
May 4, 2026

s&box Component Lifecycle: Exact Execution Order and Internal Guards

s&box Component Lifecycle: Exact Execution Order and Internal Guards Derived directly from and in the s&box engine source. Execution Order **** — Called once wh…

menu_bookDocumentation
May 4, 2026

NetworkObject: Ownership, Proxy State, and Automatic Culling

NetworkObject Ownership, Proxy State, and Culling Derived from in the s&box engine source. Ownership Model Every networked has a (internal) that tracks: **** — …

terminalCode Example
May 4, 2026

Sandbox: BaseCarryable — unified AimRay, WeaponModel resolution, and seat-aware damage

BaseCarryable — Unified Weapon Base with AimRay and Seat Support is the root class for all holdable items. It handles viewmodel/worldmodel management, a unified…

menu_bookDocumentation
May 20, 2026

Controller Input: Analog Sticks, Haptics, Motion Controls, and Local Multiplayer

s&box supports gamepad/controller input with analog sticks, haptics/rumble, motion controls, and local multiplayer. Detecting Controller Check to see if the pla…

menu_bookDocumentation
May 20, 2026

Indirect Light Volumes: Probe-Based Global Illumination and Bounce Lighting

Indirect Light Volumes in s&box use a grid of probes to sample indirect light from all directions. When rendering, the system interpolates between nearby probes…