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

Inventory Hotbar UI Component

Inventory HUD with Hotbar A Razor PanelComponent that displays player inventory slots as a hotbar with mouse wheel and number key support. Implementation Key Fe…

terminalCode Example
May 4, 2026

Sandbox: BaseBulletWeapon — hitscan shooting with BulletConfiguration, recoil, and IronSightsWeapon

BaseBulletWeapon — Hitscan Shooting with Recoil and Camera Noise extends and implements hitscan bullet firing with configurable aim cone, recoil, and camera noi…

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

terminalCode Example
May 10, 2026

Extensible Player Data Save Hooks for World Components

This pattern lets gameplay components plug into a player's save/load flow without putting every feature directly inside one large class. The framework has three…

codeAPI Reference
May 3, 2026

Player Component with Static Accessors

Player Component Main player component that manages health, damage, camera, and interfaces with the inventory system. Static Accessors Key Properties HUD Visibi…

codeAPI Reference
May 3, 2026

BasePickup with ITriggerListener and ICollisionListener

BasePickup Abstract Class Abstract base for item pickups using trigger and collision detection with host-only consumption. Key Patterns **** — trigger volume pi…

codeAPI Reference
May 4, 2026

s&box TimeSince and TimeUntil: Convenient Time Measurement Structs

s&box TimeSince and TimeUntil: Convenient Time Measurement Structs Both structs use internally and support implicit conversion from /. TimeSince Measures time e…

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…

terminalCode Example
May 18, 2026

Randomized Clothing for NPC Citizens using Dresser.Randomize() on Prefabs

Overview This demonstrates how to create NPC citizen prefabs with randomized clothing using the built-in component. Each time the prefab spawns or is enabled, i…

menu_bookDocumentation
May 5, 2026

NavMesh Agent - s&box Gameplay Documentation

NavMesh Agent The NavMeshAgent component provides automatic navigation along the NavMesh. It handles pathfinding, obstacle avoidance, and smooth movement to tar…

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 …

terminalCode Example
May 5, 2026

BeamEffect — laser and energy beams between two points

BeamEffect — Laser and Energy Beams renders a beam between two points in the world. Use it for lasers, electricity, tractor beams, or any line-based visual effe…

terminalCode Example
May 12, 2026

CameraNoiseSystem example: Camera effects

CameraNoiseSystem Example: Camera Effects CameraNoiseSystem is a GameObjectSystem that applies temporary camera effects (shake, noise, etc.) by implementing ICa…

terminalCode Example
May 4, 2026

Sandbox: CameraNoiseSystem — screen shake, punch, and recoil with ICameraSetup

CameraNoiseSystem — Screen Shake, Punch, and Recoil Effects is a that implements to apply camera noise effects (shake, punch, recoil) each frame. Effects are in…

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…

terminalCode Example
May 3, 2026

WebSockets

Use WebSockets for real-time communication with external servers. Basic Setup With Auth Token Common Use Cases Custom networking — External matchmaking, chat se…

terminalCode Example
May 5, 2026

Physics joints — Fixed, Ball, Hinge, Slider, Spring, and Wheel

Physics Joints Joints connect two physics bodies together with constraints. All joint types are components added to a GameObject positioned at the joint's ancho…

terminalCode Example
May 3, 2026

Nameplate Component with Voice Activity

Nameplate with Voice Activity A Razor component that displays player nameplates above characters with voice chat visualization. Implementation SCSS Example Key …

menu_bookDocumentation
May 5, 2026

WebSockets - s&box Networking Documentation

WebSockets s&box supports WebSocket connections for real-time communication with external servers. Use for custom networking, persistent data, or integrating wi…

terminalCode Example
May 5, 2026

Rendering entities — TextRenderer, LineRenderer, SpriteRenderer, TrailRenderer, and ModelRenderer

Rendering Entities — Text, Line, Sprite, and Trail Renderers s&box provides several lightweight renderer components for common visual needs that don't require a…