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

SkinnedModelRenderer: Bone Merge, Animation Parameters, Sequences, Attachments, and Animation Events

SkinnedModelRenderer: Bone Merge, Animation Parameters, and Attachments extends for models with bones and animations. It integrates with the for threaded animat…

menu_bookDocumentation
May 20, 2026

Razor Panels: HTML/CSS UI with C# in s&box PanelComponent System

s&box Razor Panels use web-like HTML/CSS syntax with C# for UI creation. Panels are rendered natively (not via HTML renderer) — the syntax is a convenience laye…

menu_bookDocumentation
May 4, 2026

Joint Components: HingeJoint Motor Modes, BreakForce, Body Resolution, and Joint Creation Timing

Joint Components: HingeJoint, FixedJoint, and the Joint Base Class s&box provides physics joint components for constraining physics bodies. All joints extend th…

menu_bookDocumentation
May 5, 2026

Undo System - s&box Editor Documentation

Undo System The undo system allows you to make editor actions reversible. Users can press Ctrl+Z to undo changes made by your tools. Scope Based Undo Create an …

menu_bookDocumentation
May 3, 2026

Prefab Instance Overrides

Prefab Instance Overrides Customize individual prefab instances without affecting the original or other instances. Types of Overrides Visual Indicators Prefab i…

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

s&box HydraulicEntity: Hydraulic piston

HydraulicEntity Component API Reference HydraulicEntity is a Component that implements IPlayerControllable for hydraulic pistons. It controls a SliderJoint to e…

codeAPI Reference
May 12, 2026

s&box Propeller: Thruster-driven spinner

Propeller Component API Reference Propeller is a Component that spins a target model based on thruster output. The model spins around its local up axis proporti…

codeAPI Reference
May 12, 2026

s&box IToolActionEvents: Tool action callbacks

IToolActionEvents Interface API Reference IToolActionEvents allows listening to tool actions across the scene. Implement this on a Component to receive callback…

codeAPI Reference
May 12, 2026

s&box ScheduleBase: NPC schedule base class

Abstract base class for NPC schedules. A schedule executes a sequence of tasks with cancellation support. Properties Methods Behavior Executes tasks sequentiall…

menu_bookDocumentation
May 20, 2026

Networked Objects: Spawning, Network Modes, and Interpolation

Any GameObject can become networked by calling . It will then be sent to all clients and can have Sync Properties and RPC Messages. Spawning a Networked Object …

menu_bookDocumentation
May 20, 2026

Razor Panels: HTML/CSS UI with C# in s&box

s&box UI can be created using Razor syntax — web-like HTML/CSS combined with C#. Panels are not rendered via a HTML renderer; the syntax is a convenience layer …

menu_bookDocumentation
May 20, 2026

Async Tasks and Coroutines in s&box Components

Async tasks in s&box run on the main thread by default, operating like coroutines. They are the recommended replacement for coroutines. Basic Async Method Frame…

menu_bookDocumentation
May 20, 2026

Playing Sounds: SoundHandle, GameObject.PlaySound, and Audio Components

s&box provides several ways to play sounds: fire-and-forget at a position, controlled via , attached to a , or via scene components. SoundEvent Assets Sounds 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…

codeAPI Reference
May 20, 2026

SceneTraceResult: All Fields and Properties from Trace Hits

is returned by and contains all information about a trace hit. Key Fields Common Usage Pattern

menu_bookDocumentation
May 4, 2026

s&box SceneNetworkSystem: Scene Loading and Snapshot Protocol

s&box SceneNetworkSystem: Scene Loading and Snapshot Protocol is the core networking system that manages scene loading, object spawning, and snapshot synchroniz…

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

IGameObjectNetworkEvents: Ownership Change and Control Transfer Events

lets Components on a networked GameObject react to ownership changes. The events are targeted only at the specific GameObject whose ownership is changing. Inter…

menu_bookDocumentation
May 5, 2026

GameObjectSystem - s&box Scene Documentation

GameObjectSystem GameObjectSystems are global systems that operate on groups of GameObjects. Unlike Components which are attached to single GameObjects, systems…