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 "display" 69 results closeClear
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 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…

terminalCode Example
May 3, 2026

Nameplate Component with Voice Activity

Nameplate with Voice Activity A Razor component that displays player nameplates above characters with voice chat visualization. Implementation SCSS Example Key …

terminalCode Example
May 3, 2026

Chat UI Pattern with RPC Broadcasting

Chat UI with RPC Broadcasting A Razor UI component for game chat that handles local input, RPC broadcasting, Steam filtering, and automatic message expiration. …

menu_bookDocumentation
May 12, 2026

s&box LocalProps: Built-in prop definitions

LocalProps Static Class LocalProps is a static class that defines hardcoded models that ship with the game and are not available on the workshop. These models a…

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…

terminalCode Example
May 12, 2026

s&box player management with RPC, ConCmd, and Connection APIs

s&box Player Management with RPC, ConCmd, and Connection APIs This example shows player kick/ban utilities using s&box's Connection, RPC, ConCmd, and Chat syste…

menu_bookDocumentation
May 4, 2026

Connection Class: Local, Host, All, Find, Permissions, Kicking, and Visibility Origins

Connection Class: Local, Host, All, Find, and Permissions represents a network connection to a player. It's the primary way to identify and interact with player…

codeAPI Reference
May 12, 2026

s&box ServerSettings: Replicated server-controlled settings

ServerSettings API Reference ServerSettings is a static class for server-controlled settings that are replicated to all clients. Type Signature Example Property…

codeAPI Reference
May 12, 2026

s&box ScriptedEmitterModel: Model-based emitter resource

ScriptedEmitterModel GameResource API Reference ScriptedEmitterModel is a GameResource for model-based particle/VFX emitters. It implements IDefinitionResource …

codeAPI Reference
May 12, 2026

s&box IKillSource: Kill feed attacker interface

IKillSource Interface API Reference IKillSource is an interface for Components that can appear as an attacker in the kill feed. Implement on Player, Npc, explos…

codeAPI Reference
May 12, 2026

s&box IInspectorEditor: Custom inspector panels

IInspectorEditor Interface API Reference IInspectorEditor is an interface for custom inspector panels that can edit selected GameObjects in the s&box editor. Pa…

codeAPI Reference
May 12, 2026

s&box BanSystem: Player ban management

BanSystem GameObjectSystem API Reference BanSystem holds a banlist and can ban users. Implements INetworkListener to reject banned connections. Bans are persist…

menu_bookDocumentation
May 12, 2026

s&box DupeMovement: Duper movement types

s&box DupeMovement Enum DupeMovement is an enum that describes the type of movement a duper contraption is designed for. This metadata helps users understand ho…

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 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…

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

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 …

codeAPI Reference
May 20, 2026

Connection API: Properties, Methods, and Common Multiplayer Patterns

The class represents a network connection (client or server). Used extensively in multiplayer for identifying players, checking permissions, and managing networ…