auto_stories

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
in menu_bookDocumentation 352 results closeClear
menu_bookDocumentation
May 4, 2026

SkinnedModelRenderer: Animation Events (Footstep, Sound, Generic, AnimTag) and Sequence Playback

SkinnedModelRenderer Animation Events and Sequence Playback Animation Events exposes callbacks for animation events defined in the model's animation graph or se…

menu_bookDocumentation
May 4, 2026

SkinnedModelRenderer Animation Parameters: Set, SetIk, SetLookDirection, Pre-Spawn Caching, and ClearParameters

SkinnedModelRenderer Animation Parameters: Set, SetIk, SetLookDirection, and Pre-Spawn Caching stores animation parameters in a dictionary and applies them to t…

menu_bookDocumentation
May 4, 2026

SceneAnimationSystem: Threaded Animation, Bone Merge Order, Procedural Bones, and Ragdoll Physics Step

SceneAnimationSystem: Threaded Animation Updates and Bone Merge Order drives all animation updates. It runs at (after , before ). Threading Model Animation upda…

menu_bookDocumentation
May 4, 2026

RenderOptions: Game, Overlay, Bloom, AfterUI Render Layers — and Renderer.Attributes for Shader Parameters

RenderOptions: Render Layers for SceneObjects controls which render layers a component's appears in. It's exposed as a property on all subclasses. Render Layers…

menu_bookDocumentation
May 4, 2026

ScenePhysicsSystem: Physics Sub-Stepping at 120Hz, Collision Event Routing, Keyframe Colliders, and Editor Physics

ScenePhysicsSystem: How Physics Steps Work in s&box is the built-in that drives physics simulation. Understanding it explains the physics step order and collisi…

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

Joint Components: HingeJoint Motor Modes, BreakForce, Body Resolution, and Joint Creation Timing

Joint Components: HingeJoint, FixedJoint, and the Joint Base Class s&box provides physics joint components for constraining physics bodies. All joints extend th…

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

Scene Object Index: How Scene.GetAll Works — Type Hierarchy Indexing, Update Sets, and Hotload Safety

Scene Object Index: How Scene.GetAll<T> Works and Why It's Fast is the primary way to find all active components or systems of a type in the scene. Understandin…

menu_bookDocumentation
May 4, 2026

Component Marker Interfaces: ExecuteInEditor, DontExecuteOnServer, IDamageable, INetworkSpawn, IPressable, INetworkVisible

Component Marker Interfaces: ExecuteInEditor, DontExecuteOnServer, IDamageable, INetworkSpawn, IPressable s&box uses marker interfaces nested inside the class t…

menu_bookDocumentation
May 4, 2026

TemporaryEffect Component: Auto-Destroy, ITemporaryEffect, BecomeOrphan, and Editor Behavior

TemporaryEffect Component: Auto-Destroy with ITemporaryEffect Support destroys a after a set time, optionally waiting for child effects (particles, sounds) to f…

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…

menu_bookDocumentation
May 4, 2026

Networking Static Class: IsHost, IsClient, CreateLobby, Connect, SetData, and Debug Convars

Networking Static Class: IsHost, IsClient, CreateLobby, Connect, and Server Data The static class manages the multiplayer session in s&box. Session State Note: …

menu_bookDocumentation
May 4, 2026

Connection Class: Local, Host, All, Find, Permissions, Kicking, and Visibility Origins

Connection Class: Local, Host, All, Find, and Permissions represents a network connection to a player. It's the primary way to identify and interact with player…

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

s&box Sandbox Security Model: Assembly Whitelist, Blocked APIs, Reflection Restrictions, and Safe Assembly Caching

s&box Sandbox Security Model: Assembly Access Control and Whitelisted APIs s&box uses a whitelist-based security model to prevent game code from accessing dange…

menu_bookDocumentation
May 4, 2026

s&box Easing Functions: Sandbox.Utility.Easing — Quadratic, Exponential, Bounce, Sine, and CSS-Style Name Lookup

s&box Easing Functions: Sandbox.Utility.Easing for Transitions and Animations provides standard easing functions used throughout s&box's UI system and available…

menu_bookDocumentation
May 4, 2026

RealTime vs Time: Wall-Clock vs Scene Time — RealTimeSince, RealTimeUntil, GlobalNow, and SmoothDelta

RealTime vs Time: Wall-Clock vs Scene Time — When to Use Each s&box has two time systems. Choosing the wrong one is a common source of bugs. Time (Scene Time) ,…

menu_bookDocumentation
May 4, 2026

s&box MathX: Remap, LerpInverse, ExponentialDecay, SmoothDamp, SpringDamp, DeltaDegrees, and Unit Conversion

s&box MathX: Math Utility Extensions for Game Development is a static class providing math utilities not in or . Most methods are also extension methods, so you…

menu_bookDocumentation
May 4, 2026

[Change] Attribute: Callbacks When Properties Change — Works with [Sync] and [ConVar], Priority, and All-Client Firing

[Change] Attribute: Callbacks When Properties Change The attribute invokes a method whenever a property's value changes. It works with any property but is espec…