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 "Component" 432 results closeClear
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…

menu_bookDocumentation
May 5, 2026

Terrain System — heightmap creation, material painting, and sculpting

Terrain System s&box terrain is a heightmap-based landscape system with material painting, sculpting tools, and built-in LOD. Terrain data is stored in a reusab…

groupsCommunity
May 5, 2026

Scene setup checklist — minimum viable scene with lighting, post-processing, and physics

Scene Setup Checklist for New Projects A quick reference for the components every new s&box scene typically needs. Minimum Viable Scene Lighting Post-Processing…

terminalCode Example
May 5, 2026

EnvmapProbe — local reflection captures with Static, Dynamic, and OnDemand modes

EnvmapProbe — Reflection Captures in s&box is a built-in s&box component that captures a cubemap at its world position for local specular reflections. The engin…

terminalCode Example
May 3, 2026

Working with Models and Rendering

Guide to displaying 3D models in s&box. ModelRenderer Component Loading Models SkinnedMeshRenderer (Animated Models) Dynamic Model Creation LODs (Level of Detai…

menu_bookDocumentation
May 5, 2026

Custom Snapshot Data - s&box Networking Documentation

Custom Snapshot Data For advanced networking, you can write and read custom data in network snapshots. This allows efficient synchronization of complex game sta…

codeAPI Reference
May 12, 2026

s&box PostProcessResource: Post-processing effect GameResource

PostProcessResource GameResource API Reference PostProcessResource is a GameResource that defines a post-processing effect with a prefab, used by the PostProces…

menu_bookDocumentation
May 4, 2026

Engine Frame Loop Order: FrameStart, Scene Tick, and FrameEnd Sequence

Engine Frame Loop Order The s&box engine frame loop runs in a specific order each frame. Understanding this is important for knowing when your code runs relativ…

menu_bookDocumentation
May 5, 2026

Citizen Characters - s&box Assets Documentation

Citizen Characters The Citizen is s&box's default human character model. It provides a standardized base for player characters, NPCs, and customization through …

menu_bookDocumentation
May 4, 2026

DamageInfo: The Standard Damage Payload — Properties, Usage, and Custom Types

DamageInfo: The Standard Damage Payload is a class (not a struct) used to pass damage information between game systems. It is intentionally a class so games can…

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

menu_bookDocumentation
May 4, 2026

Scene.Push(), BatchGroup(), FindInPhysics, and FindAllWithTag — Scene Context Management

Scene.Push() and Scene.BatchGroup(): Scene Context Management Scene.Push() makes a scene the active scene for the duration of a scope. This is required when cre…

menu_bookDocumentation
May 5, 2026

Animation - s&box Documentation

Animation s&box supports skeletal animation for characters and objects. Animate models using imported animations, blend between states, and control playback fro…

menu_bookDocumentation
May 4, 2026

DisplayInfo: Querying s&box Type and Member Metadata (Title, Icon, Group, Tags)

DisplayInfo: Querying s&box Type and Member Metadata is an s&box struct that aggregates all display-related metadata from attributes on a type or member. The ed…

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…

codeAPI Reference
May 12, 2026

s&box SaveSystem: Scene save/load with metadata and event hooks

SaveSystem API Reference SaveSystem is a GameObjectSystem that captures differences between the current scene state and the original scene, enabling save/load f…

menu_bookDocumentation
May 4, 2026

SyncFlags.Interpolate: How Networked Property Interpolation Works — Supported Types, InterpolationBuffer, and Delay

SyncFlags.Interpolate: How Networked Property Interpolation Works When is applied to a property, proxy clients receive a smoothed value between network ticks ra…

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

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…