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

FindMode and Component Lookup: GetComponent, GetAll, ComponentList, and Hierarchy Search

FindMode and Component Lookup: GetComponent, GetAll, and ComponentList s&box uses a flags enum to control how component searches traverse the hierarchy. Underst…

menu_bookDocumentation
May 12, 2026

s&box WeaponConVars: Global weapon settings

WeaponConVars Static Class WeaponConVars is a static class that defines console variables controlling global weapon behavior in s&box. These ConVars can be set …

codeAPI Reference
May 12, 2026

s&box PostProcessManager: Post-processing resource management

PostProcessManager API Reference PostProcessManager is a GameObjectSystem that manages post-processing resources with preview, toggle, and camera attachment. Ty…

menu_bookDocumentation
May 12, 2026

s&box NpcConVars: Global NPC AI settings

NpcConVars Static Class NpcConVars is a static class that defines console variables controlling global NPC AI behavior in s&box. These ConVars can be set via co…

menu_bookDocumentation
May 4, 2026

Component Lifecycle: Full Callback Order — OnAwake, OnEnabled, OnStart, OnUpdate, OnFixedUpdate, OnDisabled, OnDestroy

Component Lifecycle: Full Callback Order s&box components have a well-defined lifecycle. Understanding the exact order prevents subtle bugs. Callback Order Key …

menu_bookDocumentation
May 12, 2026

s&box GamePreferences: User preferences

GamePreferences Static Class GamePreferences is a static class that defines the local user's preferences for the game. These ConVars control player-specific set…

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…

codeAPI Reference
May 12, 2026

s&box PointLightEntity: Controllable point light

PointLightEntity Component API Reference PointLightEntity is a controllable point light that can be toggled and configured via player input. It wraps a PointLig…

menu_bookDocumentation
May 4, 2026

GameObjectFlags: DontDestroyOnLoad, NotNetworked, Absolute, and Destroy vs DestroyImmediate

GameObjectFlags: Controlling GameObject Behavior is a flags enum that controls special behaviors for GameObjects. Values Usage ```csharp // Survive scene loads …

codeAPI Reference
May 12, 2026

s&box FuncMover: Moving and rotating objects

FuncMover Component API Reference FuncMover is a Component that moves and rotates a GameObject with configurable linear and rotational movement patterns. Type S…

menu_bookDocumentation
May 4, 2026

Inspector Attributes: Group, Title, Icon, Range, InfoBox, Feature, and More

Inspector Attributes: Controlling How Properties Appear in the Editor s&box provides a rich set of attributes to control how component properties appear in the …

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…

codeAPI Reference
May 12, 2026

s&box IResourcePreview: Resource preview interface

IResourcePreview Interface API Reference IResourcePreview is an interface for GameResources that want to enable in-picker previewing. When the user clicks an it…

menu_bookDocumentation
May 4, 2026

Prop Component: Procedural Components, Damage System, Gib Spawning, and DamageInfo Patterns

Prop Component: Procedural Physics, Gibs, Damage, and Network Patterns The component is a high-level s&box component that automatically creates , , and componen…

menu_bookDocumentation
May 20, 2026

Component Methods: OnLoad, OnAwake, OnStart, OnUpdate, OnFixedUpdate Lifecycle

Component lifecycle methods you can override: OnLoad (async) Called after deserialization for loading. Loading screen stays open until all OnLoad tasks complete…

menu_bookDocumentation
May 12, 2026

s&box ServerSettings: Server-controlled settings

ServerSettings Static Class ServerSettings is a static class that defines server-controlled settings replicated to all clients. These ConVars control game-wide …

codeAPI Reference
May 12, 2026

s&box Ownable: Ownership tracking component

Ownable Component API Reference Ownable is a Component that tracks which Connection (player) spawned a GameObject, enabling prop protection and ownership checks…

terminalCode Example
May 4, 2026

Sandbox: ToolMode system — creating custom Tool Gun modes

ToolMode System — Creating Custom Tool Gun Modes is the base class for all Tool Gun tools in Sandbox. Tools are components on the Toolgun and are enabled/disabl…

menu_bookDocumentation
May 4, 2026

s&box Component Lifecycle: Exact Execution Order and Internal Guards

s&box Component Lifecycle: Exact Execution Order and Internal Guards Derived directly from and in the s&box engine source. Execution Order **** — Called once wh…

menu_bookDocumentation
May 4, 2026

Component.GetComponent, GetComponentInChildren, GetComponentInParent — FindMode and RequireComponent

Component.GetComponent, GetComponentInChildren, GetComponentInParent — FindMode Reference Components provide convenient lookup methods for finding other compone…