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 "Get()" 321 results closeClear
codeAPI Reference
May 12, 2026

s&box IInspectorEditor: Custom inspector panels

IInspectorEditor Interface API Reference IInspectorEditor is an interface for custom inspector panels that can edit selected GameObjects in the s&box editor. Pa…

codeAPI Reference
May 12, 2026

s&box AmmoInventory: Shared ammo pools

AmmoInventory Component API Reference AmmoInventory stores shared ammo pools on a player, keyed by AmmoResource. Add this component to the player prefab alongsi…

menu_bookDocumentation
May 12, 2026

s&box Throwable: Grenade type enum

Throwable Enum Documentation Throwable is an enum that defines the type of throwable weapon for viewmodels. It is used by the ViewModel component to specify whi…

menu_bookDocumentation
May 12, 2026

s&box ThrowType: Grenade throw distance

ThrowType Enum Documentation ThrowType is an enum that defines how a grenade is thrown by the HandGrenadeWeapon. It controls the throw distance and trajectory b…

codeAPI Reference
May 12, 2026

s&box BaseToggle: Toggle state base class

Abstract base class for toggle state with [Sync] support and event callbacks. Properties Methods Usage Inherit from this class for any component that needs a sy…

codeAPI Reference
May 12, 2026

s&box TaskBase: NPC task base class

Abstract base class for NPC tasks. Tasks are executed as part of a Schedule and return a TaskStatus to indicate their state. Properties Methods TaskStatus Enum …

codeAPI Reference
May 12, 2026

s&box LinkedGameObjectBuilder: Connected object collection

Utility class for collecting connected GameObjects. Used by the Duplicator to find all objects that should be included in a duplication. Properties Methods Beha…

menu_bookDocumentation
May 20, 2026

Physics Triggers: Enter, Exit Events and Polling in s&box

A trigger is a collider that detects when physics objects enter or exit it without blocking movement. Useful for pickup zones, death planes, checkpoints, and ar…

menu_bookDocumentation
May 20, 2026

Network Events: INetworkListener and INetworkSpawn Interfaces

React to players joining and leaving by implementing or on a component in the scene. INetworkListener Example Spawn a player object when someone joins: INetwork…

menu_bookDocumentation
May 20, 2026

Scenes: Loading, Component Lookup, and GameObject Directory

A Scene is a collection of GameObjects that represents the game world. Every Component and GameObject has a property for accessing the current scene, and you ca…

menu_bookDocumentation
May 20, 2026

NavMesh Agent: AI Pathfinding with Crowd Avoidance

The component moves a GameObject along the NavMesh automatically with built-in crowd avoidance. Agents try to avoid bumping into each other when multiple agents…

menu_bookDocumentation
May 20, 2026

WebSocket Connections with Auth Token Authentication in s&box

s&box supports WebSocket connections to external servers for custom networking or persistent data outside the local filesystem. Basic Connection and Messaging U…

menu_bookDocumentation
May 20, 2026

VirtualGrid: Virtualized Grid Panel for Large Item Collections

is a s&box UI Panel that virtualizes large item collections — only rendering visible cells. If you have thousands of items, it creates only the few on screen an…

menu_bookDocumentation
May 20, 2026

File System: Sandboxed Virtual Filesystems for Data Persistence

Standard .NET access is restricted in s&box. Instead, use the provided virtual filesystems that sandbox access to specific game directories. Available File Syst…

menu_bookDocumentation
May 20, 2026

Prefabs: Reusable GameObjects with Runtime Spawning via Clone

A prefab is a GameObject that can be used in multiple places — across scenes or instantiated at runtime. Assets Prefabs are saved as PrefabFile assets. To creat…

menu_bookDocumentation
May 20, 2026

Creating Post-Process Effects: BasePostProcess with Volume Blending and Shaders

Create custom post-processing effects in s&box by deriving from . This enables volume-based blending and custom shader rendering. The Component Key Methods GetW…

menu_bookDocumentation
May 20, 2026

Binary Serialization: BlobData for Large GameResource Data Storage

When JSON files grow too large in s&box, you can store data as a binary blob using the class. This works with GameResource assets and provides custom serializat…

menu_bookDocumentation
May 20, 2026

Triggers: Non-Blocking Collision Detection with ITriggerListener

A trigger is a collider that detects when other physics objects enter or exit it without blocking their movement. Useful for pickup zones, death planes, checkpo…

menu_bookDocumentation
May 20, 2026

Network Ownership: Taking, Dropping, and Transferring Object Control

Networked GameObjects can be owned by a connection. Objects owned by a connection are simulated by that connection — their position and sync variables are contr…

menu_bookDocumentation
May 20, 2026

Network Events: INetworkListener for Player Join, Leave, and Active Callbacks

Implement or on a component to react to players joining and leaving the game. INetworkListener Example Spawn a player object when someone joins: INetworkListene…