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 "cleanup" 23 results closeClear
terminalCode Example
May 12, 2026

CleanupSystem: Map reset and baseline restoration

CleanupSystem: Map Reset and Baseline Restoration This example shows the CleanupSystem which tracks the baseline scene state and allows resetting the map to its…

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…

terminalCode Example
May 3, 2026

CleanupSystem Pattern for Map Reset and Scene Management

CleanupSystem - Scene State Management and Map Cleanup A that captures the baseline scene state and allows resetting the map to its original state. Removes spaw…

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…

groupsCommunity
May 4, 2026

Sandbox: Full codebase architecture — systems, player components, weapons, tools, NPCs

Sandbox Codebase Architecture Overview The Facepunch Sandbox game is a large reference implementation. Here's a map of the major systems and how they connect. C…

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…

terminalCode Example
May 3, 2026

NPC Ragdoll Creation with Clothing Preservation

NPC Ragdoll Creation with Clothing Pattern for creating ragdolls from NPCs including clothing preservation and bone merging. Key APIs **** — copies model, mater…

codeAPI Reference
May 12, 2026

s&box Tracer: Projectile trail renderer

Tracer Renderer Component API Reference Tracer is a Renderer component that creates a tracer effect (like bullet trails) that travels from its world position to…

codeAPI Reference
May 3, 2026

BaseConstraintToolMode for Constraint Tools

BaseConstraintToolMode Abstract Class Base class for two-stage constraint tools (weld, rope, elastic, etc.) with selection point handling. Class Overview Contro…

terminalCode Example
May 3, 2026

GameManager INetworkListener Pattern

GameManager INetworkListener Pattern Game manager implementing connection lifecycle with player spawning and cleanup. Implemented Interfaces INetworkListener - …

menu_bookDocumentation
May 3, 2026

Component Lifecycle Methods Reference

Component Lifecycle Methods s&box Components have a well-defined lifecycle with specific methods you can override for different phases of initialization and upd…

menu_bookDocumentation
May 20, 2026

Physics Triggers: Enter, Exit Events and Polling in s&box

A trigger is a collider that detects when physics objects enter or exit it without blocking movement. Useful for pickup zones, death planes, checkpoints, and ar…

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…

codeAPI Reference
May 3, 2026

LinkedGameObjectBuilder for Finding Connected Objects

LinkedGameObjectBuilder Utility class for building a set of connected GameObjects by traversing physics joints, constraints, and manual links. Class Definition …

terminalCode Example
May 4, 2026

Sandbox: ISpawner interface — custom spawner pattern with ISpawnEvents

ISpawner Interface — Custom Spawner Pattern The interface defines the contract for anything that can be spawned via the spawn menu. Implementations include , , …

groupsCommunity
May 3, 2026

Multiplayer Authority Patterns

Multiplayer Authority Patterns Community guide for structuring multiplayer code based on official networking documentation and proven patterns. Host-Authoritati…

terminalCode Example
May 3, 2026

Noclip MoveMode with Collision Toggle

Noclip MoveMode Implementation Custom movement mode for noclip/fly behavior with collision toggle. Key Patterns MoveMode inheritance — override , , priority — 1…

terminalCode Example
May 12, 2026

UndoSystem: Per-player undo functionality

UndoSystem: Per-Player Undo Functionality This example shows the UndoSystem which provides per-player undo stacks for tracking spawned objects and allowing play…

menu_bookDocumentation
May 5, 2026

Execution Order - s&box Documentation

Execution Order Understanding the order in which component methods are called. Flowchart Component lifecycle follows a specific order: Constructor — Object crea…

codeAPI Reference
May 3, 2026

Sandbox.ParticleEffect

Sandbox.ParticleEffect Controls particle system playback. Overview ParticleEffect is the root component for playing particle effects (.vpcf files). Setup Playba…