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 "box" in menu_bookDocumentation 275 results closeClear
menu_bookDocumentation
May 20, 2026

Component Editor Tools: Selection-Based Scene View UI and Gizmos

Component Editor Tools in s&box are always active when a specific Component is selected. They create UI in the scene view and can override input. An example is …

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

Binary Serialization: BlobData for Large GameResource Data Storage

When JSON files grow too large in s&box, you can store data as a binary blob using the class. This works with GameResource assets and provides custom serializat…

menu_bookDocumentation
May 20, 2026

TemporaryEffect: Auto-Cleanup for Particle and Sound Prefabs

The TemporaryEffect component in s&box is added to prefabs containing ParticleEffects and Sounds. It automatically deletes the GameObject after all particles ar…

menu_bookDocumentation
May 20, 2026

Video: VideoPlayer Decoding and VideoWriter Encoding with Streaming Support

s&box provides VideoPlayer for decoding video and VideoWriter for encoding video frames. VideoPlayer Decodes video files or URLs, exposing the current frame as …

menu_bookDocumentation
May 20, 2026

GameResource Extensions: Appending Data to Existing Assets Without Modification

ResourceExtensions in s&box append additional data to existing GameResources without modifying the original class or assets. Useful for adding properties to Clo…

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

BeamEffect: Animated Line Renderer for Tracers, Lasers, and Beams

The BeamEffect in s&box is an animated LineRenderer for creating beams, tracers, and lasers. It supports multiple beams, fade over time, scale over time, and te…

menu_bookDocumentation
May 4, 2026

Sandbox: PlayerInventory — weapon slots, pickup, drop, and loadout persistence

Sandbox PlayerInventory — Weapon Slots, Pickup, Drop, and Loadout Persistence manages up to 6 weapon slots, handles pickup/drop logic, and delegates loadout sav…

menu_bookDocumentation
May 4, 2026

Sandbox: BanSystem — persistent ban list with INetworkListener.AcceptConnection

Sandbox BanSystem — Persistent Ban List with INetworkListener is a that implements to intercept incoming connections and reject banned players before they join.…

menu_bookDocumentation
May 4, 2026

Sandbox: Map entities — Door, Button, FuncMover, TriggerPush, TriggerTeleport

Sandbox Map Entities — Door, Button, FuncMover, TriggerPush, TriggerTeleport These components implement interactive map elements. They live in the namespace and…

menu_bookDocumentation
May 4, 2026

Sandbox: CleanupSystem — full scene cleanup and per-player cleanup with Ownable

Sandbox CleanupSystem — Scene Cleanup and Per-Player Cleanup is a that handles cleaning up spawned objects. It distinguishes between "baseline" objects (part of…

menu_bookDocumentation
May 4, 2026

Sandbox: Hydraulic tool — motorized SliderJoint with LineRenderer shaft

Sandbox Hydraulic Tool — Motorized SliderJoint Constraints The Hydraulic tool creates a between two objects with a component that can extend and retract the joi…

menu_bookDocumentation
May 4, 2026

Sandbox: SaveSystem — scene diff save/load with versioning and ISaveEvents

Sandbox SaveSystem — Scene Diff Save/Load The captures the difference between the current scene state and the original scene file. This means saves are compact …

menu_bookDocumentation
May 4, 2026

Sandbox: Weld tool — FixedJoint constraint with EasyMode rotation

Sandbox Weld Tool — Constraint Creation with EasyMode Rotation The Weld tool creates constraints between two GameObjects. It has an EasyMode that lets the playe…