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 "Created" 238 results closeClear
menu_bookDocumentation
May 4, 2026

Component Lifecycle: Full Callback Order — OnAwake, OnEnabled, OnStart, OnUpdate, OnFixedUpdate, OnDisabled, OnDestroy

Component Lifecycle: Full Callback Order s&box components have a well-defined lifecycle. Understanding the exact order prevents subtle bugs. Callback Order Key …

codeAPI Reference
May 12, 2026

s&box TriggerTeleport: Trigger-based teleportation

TriggerTeleport Component API Reference TriggerTeleport is a Component that teleports objects that enter its trigger collider to a target GameObject. Type Signa…

menu_bookDocumentation
May 4, 2026

GameObject.Network Accessor — IsProxy, IsOwner, TakeOwnership, DropOwnership, Refresh, and IGameObjectNetworkEvents

GameObject.Network Accessor — Ownership, Spawning, and Proxy Detection is a that provides all network-related operations for a . It always resolves to the netwo…

menu_bookDocumentation
May 4, 2026

Component.OnLoad: Async Loading Pattern — LoadingContext, Scene.IsLoading, and Loading Screen Integration

Component.OnLoad: Async Loading Pattern for Components Components can perform async loading work by overriding . This is the correct way to load resources async…

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…

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

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

GameObject.Clone: Two-Pass Cloning, CloneConfig, NotCloned Flag, and Reference Rewiring

GameObject.Clone: Spawning Prefabs and Cloning GameObjects with CloneConfig is the primary way to instantiate prefabs and duplicate GameObjects in s&box. It per…

menu_bookDocumentation
May 4, 2026

s&box Source Generator: IUpdateSubscriber, WrappedPropertySet, and How [Sync]/[Rpc.*] Work at Compile Time

s&box Source Generator: How [CodeGenerator] Works for [Sync] and [Rpc.*] The Roslyn source generator transforms your C# code at compile time. Understanding this…

menu_bookDocumentation
May 4, 2026

s&box CameraComponent: Screen/World Conversion, RenderToTexture, Priority, Viewport, and Oblique Projection

s&box CameraComponent: Screen/World Conversion, RenderToTexture, and Priority wraps a and provides the main rendering configuration for a s&box scene. Every sce…

menu_bookDocumentation
May 4, 2026

SkinnedModelRenderer: Bone Merge, Animation Parameters, Sequences, Attachments, and Animation Events

SkinnedModelRenderer: Bone Merge, Animation Parameters, and Attachments extends for models with bones and animations. It integrates with the for threaded animat…

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

Game Resources - s&box Documentation

Official s&box documentation for Game Resources - custom asset types. GameResource allows defining custom asset types that can be created in the editor and load…

menu_bookDocumentation
May 4, 2026

Game Static Class: ActiveScene, ChangeScene, TypeLibrary, Cookies, and Core State Properties

Game Static Class: ActiveScene, ChangeScene, TypeLibrary, and Core State The static class is the primary entry point for global game state in s&box. Core State …

menu_bookDocumentation
May 4, 2026

ScreenPanel and WorldPanel: AutoScale Strategies, ZIndex, LookAtCamera, and Interaction Range

ScreenPanel and WorldPanel: UI Components in s&box Scenes ScreenPanel is the root component for 2D screen-space UI. It renders attached children to the screen. …

menu_bookDocumentation
May 4, 2026

BasePostProcess: Custom Post-Processing with GetWeighted, BlitMode, and PostProcessVolume Blending

BasePostProcess<T>: Custom Post-Processing Effects with Volume Blending is the current (non-obsolete) base class for post-processing effects in s&box. It replac…

menu_bookDocumentation
May 5, 2026

Console Variables - s&box Documentation

Official s&box documentation for Console Variables (ConVar) and Console Commands (ConCmd). ConVar creates variables that can be modified through the console and…

codeAPI Reference
May 12, 2026

s&box ScriptedEmitterModel: Model-based emitter resource

ScriptedEmitterModel GameResource API Reference ScriptedEmitterModel is a GameResource for model-based particle/VFX emitters. It implements IDefinitionResource …

codeAPI Reference
May 12, 2026

s&box BasePickup: Trigger and collision-based pickup system

BasePickup API Reference BasePickup is an abstract Component for creating trigger or collision-based pickups (weapons, ammo, items). Type Signature Required Com…

menu_bookDocumentation
May 5, 2026

Getting Started - s&box Documentation

Getting Started S&box is coded in C#. Under the hood, it uses the Source 2 engine (CS2, HL:Alyx, DOTA2) and some of its systems: rendering, resources, physics, …