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 "back" 53 results closeClear
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…

menu_bookDocumentation
May 4, 2026

MainThread.Queue: Running Code on the Main Thread from Worker Threads

MainThread.Queue: Running Code on the Main Thread from Worker Threads s&box is single-threaded for game logic. If you have code running on a worker thread (e.g.…

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…

terminalCode Example
May 12, 2026

s&box Vector3 extension for aim cone randomization

s&box Vector3 Extension for Aim Cone Randomization This example shows extension methods for adding random spread to Vector3 direction vectors using s&box's Game…

terminalCode Example
May 3, 2026

Storage (UGC)

Manage user-generated content, save games, and player creations. Creating Entries Entry Properties Reading Files Listing Entries Deleting Entries Steam Workshop…

terminalCode Example
May 3, 2026

BanSystem Pattern for Player Management

BanSystem - Player Ban Management A GameObjectSystem that manages player bans with persistent storage. Demonstrates , persistence, and RPC commands. Implementat…

menu_bookDocumentation
May 5, 2026

Ownership - s&box Networking Documentation

Ownership Network ownership determines which client or the host has authority over a networked GameObject. The owner controls synced properties and can send RPC…

terminalCode Example
May 3, 2026

Input Handling Code Examples

Input Handling Code Examples Comprehensive input examples covering buttons, analog sticks, mouse, controller, and VR input. Default Input Actions

terminalCode Example
May 5, 2026

Unit tests in s&box — MSTest setup, engine initialization, and component testing

Unit Tests in s&box s&box supports MSTest-based unit tests. Create a directory in your project folder and restart the editor — a test project is generated autom…

terminalCode Example
May 10, 2026

Reusable World-Space Interaction Prompt Framework

A small, compartmentalized interaction framework can be built from three pieces: : the base component placed on objects the player can use. : the player-side ra…

menu_bookDocumentation
May 4, 2026

[Sync] Attribute: SyncFlags.FromHost, SyncFlags.Interpolate, SyncFlags.Query — How Property Sync Works

[Sync] Attribute: SyncFlags and How Property Synchronization Works The attribute marks a component property for automatic network synchronization from the owner…

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…

menu_bookDocumentation
May 4, 2026

Network Visibility Culling: AlwaysTransmit, INetworkVisible, CullDelay, and PVS-Based Object Culling

Network Visibility Culling: How s&box Decides What to Send to Each Client s&box has a built-in network visibility culling system that avoids sending updates for…

menu_bookDocumentation
May 4, 2026

GameResource: Custom Asset Types, PostLoad, PostReload, ResourceLibrary.Get, and Resource Networking

GameResource: Custom Asset Types, PostLoad, and Resource Networking is the base class for all JSON-based assets in s&box (prefabs, scene files, custom assets). …

menu_bookDocumentation
May 4, 2026

SkinnedModelRenderer Animation Parameters: Set, SetIk, SetLookDirection, Pre-Spawn Caching, and ClearParameters

SkinnedModelRenderer Animation Parameters: Set, SetIk, SetLookDirection, and Pre-Spawn Caching stores animation parameters in a dictionary and applies them to t…

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

Sync Properties: Automatic Property Replication with [Sync] Attribute

Adding the attribute to a property on a Component will have its latest value sent to other players each time it changes. Only the owner of the object can change…

codeAPI Reference
May 12, 2026

s&box ICleanupEvents: Cleanup event callbacks

ICleanupEvents API Reference ICleanupEvents is an interface for receiving callbacks when the scene is cleaned up (map reset). Type Signature Method - Called aft…

menu_bookDocumentation
May 4, 2026

ISceneCollisionEvents, IScenePhysicsEvents, ISceneLoadingEvents — Physics and Loading Callbacks

ISceneCollisionEvents and IScenePhysicsEvents: Physics Callbacks ISceneCollisionEvents Implement this interface on a component to receive collision callbacks. U…

menu_bookDocumentation
May 4, 2026

NetList and NetDictionary: Delta Sync, OnChanged Callbacks, Write Guard, and CanWriteChanges

NetList and NetDictionary: Networked Collections with Delta Sync and are s&box networked collection types for use with . They only send changes (deltas) over th…