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 "GameObject" 255 results closeClear
menu_bookDocumentation
May 4, 2026

s&box ISceneEvent: Scene-Wide and Per-Object Event Broadcasting

s&box ISceneEvent<T>: Scene-Wide and Per-Object Event Broadcasting is the base interface for all scene event systems. It provides static methods for broadcastin…

codeAPI Reference
May 12, 2026

s&box SensesLayer: NPC environmental scanning

NPC behavior layer that handles awareness and environmental scanning. Caches visible/audible objects by tag for efficient querying. Properties Methods Behavior …

codeAPI Reference
May 12, 2026

s&box BasePickup: Pickup item base

BasePickup Abstract Class API Reference BasePickup is an abstract Component for items that can be picked up by players. Implements ITriggerListener and ICollisi…

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

Component Execution Order: Lifecycle Flow and GameObjectSystem Ordering

s&box component execution order determines when lifecycle methods are called. You should not rely on the order in which the same callback gets invoked for diffe…

terminalCode Example
May 3, 2026

Camera and View Control

Working with cameras and player viewpoints in s&box. Main Camera Access Creating a Player Camera First-Person Camera Screen to World Ray World to Screen Camera …

groupsCommunity
May 3, 2026

Performance Best Practices

s&box Performance Best Practices Community guide for writing performant s&box code based on engine behavior and developer recommendations. Object Pooling Avoid …

menu_bookDocumentation
May 4, 2026

Component Marker Interfaces: ExecuteInEditor, DontExecuteOnServer, IDamageable, INetworkSpawn, IPressable, INetworkVisible

Component Marker Interfaces: ExecuteInEditor, DontExecuteOnServer, IDamageable, INetworkSpawn, IPressable s&box uses marker interfaces nested inside the class t…

codeAPI Reference
May 12, 2026

s&box IKillSource: Kill feed attacker interface

IKillSource Interface API Reference IKillSource is an interface for Components that can appear as an attacker in the kill feed. Implement on Player, Npc, explos…

terminalCode Example
May 4, 2026

Sandbox: ISpawner interface — custom spawner pattern with ISpawnEvents

ISpawner Interface — Custom Spawner Pattern The interface defines the contract for anything that can be spawned via the spawn menu. Implementations include , , …

codeAPI Reference
May 3, 2026

ToolMode Base Class for Toolgun Modes

ToolMode Base Class Abstract base class for creating toolgun modes in s&box. Handles input registration, action dispatch, and HUD rendering. Class Overview Acti…

menu_bookDocumentation
May 4, 2026

Sandbox: PlayerInventory — weapon slots, pickup, drop, and loadout persistence

Sandbox PlayerInventory — Weapon Slots, Pickup, Drop, and Loadout Persistence manages up to 6 weapon slots, handles pickup/drop logic, and delegates loadout sav…

codeAPI Reference
May 4, 2026

s&box SoundHandle: Full Audio Playback Control API

s&box SoundHandle: Full Audio Playback Control API is returned by and gives full control over a playing sound. Playing Sounds SoundHandle Properties Stopping St…

menu_bookDocumentation
May 4, 2026

Collider Component: Triggers, Surface Properties, Keyframe Bodies, Concave Shapes, and Tag Propagation

Collider Component: Triggers, Surface Properties, and Keyframe Bodies The abstract base class is the foundation for all physics colliders in s&box (, , , , ). T…

codeAPI Reference
May 12, 2026

s&box PhysicalProperties: Physical property persistence

PhysicalProperties Component API Reference PhysicalProperties is a Component that persists physical properties (mass, gravity, health) across duplication and ne…

menu_bookDocumentation
May 3, 2026

VR Development

VR Development Build virtual reality experiences with OpenXR support, tracked devices, and VR-specific components. Setup Enable VR in your project settings. s&b…

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…

menu_bookDocumentation
May 4, 2026

ModelRenderer Material Overrides: MaterialOverride, SetMaterialOverride by Tag, Per-Index Materials Accessor, and Attachments

ModelRenderer Material Overrides: MaterialOverride, SetMaterialOverride, and Materials Accessor provides several ways to override materials on a model. Global M…

terminalCode Example
May 12, 2026

CleanupSystem: Map reset and baseline restoration

CleanupSystem: Map Reset and Baseline Restoration This example shows the CleanupSystem which tracks the baseline scene state and allows resetting the map to its…

menu_bookDocumentation
May 3, 2026

ActionGraph - Visual Scripting System

ActionGraph - Visual Scripting System Create game logic using node-based visual scripting without writing code. Overview ActionGraph lets you: Build gameplay lo…