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

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

Math Types - s&box Documentation

Official s&box documentation for Math Types including Vector3, Rotation, Angles, and related types. Vector3 represents 3D positions and directions with X, Y, Z …

menu_bookDocumentation
May 20, 2026

NavMesh Agent: AI Pathfinding Component with Crowd Control

The s&box NavMeshAgent component moves GameObjects along the NavMesh automatically with built-in crowd control to avoid collisions between agents. Component Set…

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

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

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

Voice Component: Push-to-Talk, Lip Sync Visemes, ExcludeFilter, ShouldHearVoice, and Amplitude

Voice Component: Voice Chat, Lip Sync, and Viseme Morphs The component handles voice chat recording, transmission, and playback with optional lip sync. Basic Se…

menu_bookDocumentation
May 4, 2026

ConVar and ConCmd: Console Variables and Commands in s&box

ConVar and ConCmd: Console Variables and Commands s&box uses and attributes on static properties and methods to expose them to the console system. ConVar (Conso…

menu_bookDocumentation
May 20, 2026

Dedicated Server User Permissions: Claims-Based Access Control via Steam ID

On s&box Dedicated Servers, you can specify admin permissions per user via the file using Steam IDs and claims. Configuration Claims Claims are strings describi…

menu_bookDocumentation
May 4, 2026

Networking State in s&box: IsHost, IsClient, IsActive, and Lobby Management

Networking State in s&box: IsHost, IsClient, IsActive Understanding the networking state is critical for writing correct multiplayer code in s&box. Key Properti…

menu_bookDocumentation
May 5, 2026

Publishing Clothing - s&box Clothing Documentation

Publishing Clothing Publish clothing assets to sbox.game for players to use. Setting up your .Clothing File Create a clothing definition asset: Right-click in A…

menu_bookDocumentation
May 5, 2026

Components - s&box Documentation

Components A Component is added to a GameObject to provide functionality. This functionality can vary wildly. You could add a component that renders a model at …

menu_bookDocumentation
May 5, 2026

GameObject - s&box Documentation

GameObject A GameObject is the fundamental building block of scenes in s&box. GameObjects have a transform (position, rotation, scale), can have parents and chi…

menu_bookDocumentation
May 5, 2026

Hotloading - s&box Documentation

Hotloading Whenever you save a code file in your project (.cs or .razor files), we recompile and attempt to live-reload the changed assembly. This lets you quic…

menu_bookDocumentation
May 5, 2026

NetworkHelper — quick multiplayer setup with auto-server and player spawning

NetworkHelper — Quick Multiplayer Setup is a built-in s&box component that handles the boilerplate of starting a server and spawning players. It's the fastest w…

menu_bookDocumentation
May 20, 2026

Connection Permissions: CanSpawnObjects and CanRefreshObjects

The host can change permissions for a specific in s&box multiplayer. The ideal place to set these permissions is in the network event callback when a player con…

menu_bookDocumentation
May 20, 2026

Storage UGC: User-Generated Content with Steam Workshop Integration

The s&box Storage system provides a unified way to manage user-generated content in your game. Each storage entry is a self-contained folder with its own filesy…

menu_bookDocumentation
May 20, 2026

Creating Terrain: Heightmap Setup, World Scale, and Asset Reuse

To add Terrain to your s&box scene, right-click in the Hierarchy and select 3D Object → Terrain. The inspector prompts you to create, import, or link an existin…