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
Results for "use" in menu_bookDocumentation 278 results closeClear
menu_bookDocumentation
May 4, 2026

Component.GetComponent, GetComponentInChildren, GetComponentInParent — FindMode and RequireComponent

Component.GetComponent, GetComponentInChildren, GetComponentInParent — FindMode Reference Components provide convenient lookup methods for finding other compone…

menu_bookDocumentation
May 4, 2026

Application Context Flags: IsDedicatedServer, IsHeadless, IsEditor, IsVR — Runtime Context in s&box

Application Context Flags: IsDedicatedServer, IsHeadless, IsEditor, IsVR is a static class in s&box that exposes runtime context flags. These are set at startup…

menu_bookDocumentation
May 4, 2026

Rigidbody Component: Networked Velocity, Proxy Physics Simulation, Impact Damage, and SmoothMove

Rigidbody Component: Networking, Velocity Sync, and Proxy Physics Simulation The component is the primary way to add physics simulation to a . It implements and…

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

s&box Hotload System: How Code Reloading Works, SkipHotload, ConVar Persistence, and NetworkObject.OnHotload

s&box Hotload System: How Code Reloading Works s&box supports live code reloading (hotload) without restarting the game. Understanding how it works helps avoid …

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

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

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

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

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

s&box SpriteRenderer: Billboard Modes, Animation Control, Broadcast Events, and Rendering Options

s&box SpriteRenderer: Animated Sprites, Billboard Modes, and Broadcast Events renders a asset in the s&box world with support for animation, billboarding, and f…

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

menu_bookDocumentation
May 12, 2026

s&box PackageSortMode: Package sorting modes

PackageSortMode Enum PackageSortMode is a typed enum for package sorting modes in the s&box package browser. It provides a type-safe way to specify how packages…

menu_bookDocumentation
May 12, 2026

s&box LocalProps: Built-in prop definitions

LocalProps Static Class LocalProps is a static class that defines hardcoded models that ship with the game and are not available on the workshop. These models a…

menu_bookDocumentation
May 12, 2026

s&box PostProcessGroup: Post-process categories

PostProcessGroup Enum Documentation PostProcessGroup is an enum that categorizes post-processing effects for organization in the spawn menu and asset browser. I…

menu_bookDocumentation
May 20, 2026

Sync Properties: Networked State with Change Detection and Collections

The attribute on a Component property sends its latest value to other players each time it changes. Only the owner of the object can change synced properties. B…

menu_bookDocumentation
May 20, 2026

Scene Events: Interface-Based Broadcasting and Listening

s&box uses interface-based events to broadcast and listen to events within a scene. Events are sent to active Components and GameObjectSystems — they are NOT se…

menu_bookDocumentation
May 20, 2026

Async Tasks and Coroutines in s&box Components

Async tasks in s&box run on the main thread by default, operating like coroutines. They are the recommended replacement for coroutines. Basic Async Method Frame…

menu_bookDocumentation
May 20, 2026

Time Utilities: TimeSince, TimeUntil, and Frame-Rate Independence

s&box provides time utilities for cooldowns, countdowns, and frame-rate independent movement without manual bookkeeping. Time.Delta Seconds since last frame. Mu…

menu_bookDocumentation
May 20, 2026

Custom GameResource Assets: Define, Create, and Access Custom Asset Types

Define custom asset types as subclasses. They get a nice inspector window, are hotloaded in-game, and are stored as JSON files with a custom extension. Creating…