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 "player" 239 results closeClear
terminalCode Example
May 3, 2026

Collision and Triggers

Working with physics collisions and trigger volumes. Collision Components Basic Collision Trigger Volumes Triggers detect overlap without blocking movement: Col…

codeAPI Reference
May 12, 2026

s&box SaveSystem: Scene save/load

SaveSystem GameObjectSystem API Reference SaveSystem is a saving/loading system that captures the differences between the current scene state and the original s…

codeAPI Reference
May 12, 2026

s&box MountMetadata: Mount fallback rendering

MountMetadata Component API Reference MountMetadata is attached to mount-spawned props to show a graceful bounding box and hint the player which game it's from …

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

Your First Project - s&box Documentation

Your First Project Creating Game Objects In s&box, everything in your scene is a GameObject. GameObjects can have Components attached to them that provide funct…

terminalCode Example
May 3, 2026

PlayerInventory Weapon Switching

PlayerInventory Weapon Switching Weapon switching with host authority and IPlayerEvents delegation. Key Features Sync'd ActiveWeapon with Change callback for ne…

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

Scene.Trace: Raycasting, Shape Sweeps, Tag Filters, SceneTraceResult Fields, and FindInPhysics

Scene.Trace: Raycasting and Shape Sweeps in s&box is the entry point for all physics traces in s&box. It returns a builder that uses a fluent API. Basic Usage F…

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

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

LocalData persistence for server-side data

LocalData Persistence in s&box LocalData provides server-side data persistence that survives server restarts. It's useful for storing configuration, ban lists, …

menu_bookDocumentation
May 5, 2026

File System - s&box Assets Documentation

File System s&box provides several file systems for different purposes - data persistence, mounted content, and organization. File Systems Data File System For …

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…

codeAPI Reference
May 12, 2026

s&box EntitySpawnerEntity: Entity spawner

EntitySpawnerEntity Component API Reference EntitySpawnerEntity is a world-placed SENT that spawns another SENT at its location. Can be triggered manually via p…

codeAPI Reference
May 12, 2026

s&box BaseCarryable.IEvent: World model events

BaseCarryable.IEvent Interface API Reference BaseCarryable.IEvent is an interface for receiving world model lifecycle events on carryable objects (weapons, item…

codeAPI Reference
May 3, 2026

Global.ISpawnEvents Spawn Event Interface

Global.ISpawnEvents Interface Scene-wide event interface for listening to spawn operations. Implement on components to receive pre/post spawn callbacks. Interfa…

codeAPI Reference
May 12, 2026

s&box ControlSystem: Chair control management

GameObjectSystem that manages chair control with seat priority sorting. Routes player input to controllable objects using ClientInput.PushScope(). Behavior Sort…

terminalCode Example
May 3, 2026

Controller Input

Handle gamepad/controller input in s&box. Detecting Controllers Analog Inputs Auto-Mapped Input Haptics/Rumble Motion Controls Local Multiplayer

menu_bookDocumentation
May 3, 2026

Component Lifecycle Methods Reference

Component Lifecycle Methods s&box Components have a well-defined lifecycle with specific methods you can override for different phases of initialization and upd…