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 "GameObject" 255 results closeClear
menu_bookDocumentation
May 20, 2026

Prefab Templates: Adding Custom Prefabs to the s&box Create Menu

s&box Prefab Templates let you add custom prefabs to the GameObject Create menu in the scene editor. Setup Enable "Show In Menu" on a Prefab File in the inspect…

menu_bookDocumentation
May 20, 2026

Custom Particle Controller: Code-Based Particle Simulation with Threading

The s&box particle system allows custom code-based particle controllers by inheriting from . Add the component to a GameObject with a ParticleEffect to control …

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…

codeAPI Reference
May 3, 2026

Player Component with Static Accessors

Player Component Main player component that manages health, damage, camera, and interfaces with the inventory system. Static Accessors Key Properties HUD Visibi…

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…

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: **** — …

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…

terminalCode Example
May 5, 2026

BeamEffect — laser and energy beams between two points

BeamEffect — Laser and Energy Beams renders a beam between two points in the world. Use it for lasers, electricity, tractor beams, or any line-based visual effe…

terminalCode Example
May 5, 2026

Spatial audio components — SoundPoint, SoundBox, SoundscapeTrigger, DspVolume, and AudioListener

Spatial Audio Components s&box provides several components for placing audio in the world. All are alternatives to for persistent, positioned audio sources. Sou…

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…

codeAPI Reference
May 4, 2026

s&box DamageInfo: Extensible Damage Data Class and IDamageable Interface

s&box DamageInfo: Extensible Damage Data Class is a class (not a struct) so it can be subclassed for game-specific damage types. Definition Usage IDamageable In…

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

GameObjectSystem: Auto-Instantiation, Host-Controlled [Sync], RPCs, Stage Hooks, and Configuration Priority

GameObjectSystem: Auto-Instantiation, [Sync] Properties, and RPCs is a scene-level singleton that is automatically instantiated once per scene. Every non-abstra…

menu_bookDocumentation
May 4, 2026

NavMeshAgent: MoveTo, WishVelocity Pattern, Off-Mesh Links, Area Constraints, and Path Queries

NavMeshAgent: Navigation, WishVelocity, Links, and Path Control is the s&box component for AI navigation using the scene's navmesh. It uses DotRecast (Detour/Cr…

menu_bookDocumentation
May 5, 2026

Indirect Light Volumes (DDGI) — dynamic global illumination probe grid

Indirect Light Volumes (DDGI) places a probe grid for dynamic global illumination — light bouncing off surfaces tints nearby objects, and sunlight fades natural…

terminalCode Example
May 20, 2026

NavMesh Links: Custom Jump and Ladder Traversal for AI Agents

NavMesh Links connect disconnected NavMesh regions (jumps, ladders, teleports). By default agents linearly interpolate between endpoints, but you can implement …

menu_bookDocumentation
May 20, 2026

IsValid: Safe Null and Destroyed Object Checking in s&box

In s&box, destroying a or doesn't erase the C# reference — the variable still holds a non-null but dead object. Use instead of null checks. Common Patterns Guar…

menu_bookDocumentation
May 4, 2026

NetworkSpawn, Ownership Transfer, and Network.Refresh in s&box

NetworkSpawn and Ownership Transfer in s&box Spawning a Networked Object Ownership Transfer Modes (OwnerTransfer) Taking and Dropping Ownership Checking Ownersh…

menu_bookDocumentation
May 4, 2026

ModelRenderer: Body Groups, Material Override, Material Groups, Shadow Modes, and LOD Override

ModelRenderer: Body Groups, Material Override, Shadow Modes, and LOD renders a static (non-skinned) model in the world. It creates a in the . Basic Usage Body G…

menu_bookDocumentation
May 4, 2026

ClothingContainer: Apply, ApplyAsync, CreateFromConnection, RemoveUnownedItems, and Body Group Masking

ClothingContainer: Avatar Dressing System — Apply, CreateFromConnection, and RemoveUnownedItems manages a player's avatar outfit. It handles clothing compatibil…