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 "ViewModel" 13 results closeClear
codeAPI Reference
May 12, 2026

s&box ICameraSetup: Camera setup callbacks

ICameraSetup API Reference ICameraSetup is an interface for receiving callbacks during camera setup, allowing fine-grained control over camera effects before, d…

codeAPI Reference
May 12, 2026

s&box ICameraSetup: Camera render hooks

Interface for camera setup hooks that allow fine-grained control over camera effects. Implement to modify the camera at specific stages of the render pipeline. …

terminalCode Example
May 12, 2026

s&box DemoRecording with DefaultMovieRecorderOptions

s&box DemoRecording with DefaultMovieRecorderOptions This example shows how to configure s&box's MovieRecorder system using the [DefaultMovieRecorderOptions] at…

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…

terminalCode Example
May 3, 2026

BaseWeapon and BaseCarryable Weapon Framework

BaseWeapon and BaseCarryable - Weapon Framework Base classes for creating weapons in s&box. Provides ammo management, view/world models, and input handling. Bas…

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…

terminalCode Example
May 4, 2026

Sandbox: BaseCarryable — unified AimRay, WeaponModel resolution, and seat-aware damage

BaseCarryable — Unified Weapon Base with AimRay and Seat Support is the root class for all holdable items. It handles viewmodel/worldmodel management, a unified…

codeAPI Reference
May 12, 2026

Throwable enum

Throwable Enum Types of throwable weapons for s&box viewmodel animation selection. Values HEGrenade - High-explosive grenade SmokeGrenade - Smoke grenade StunGr…

codeAPI Reference
May 12, 2026

ReloadSoundEntry record struct

ReloadSoundEntry Record Struct Defines a timed sound event to play during s&box weapon reload animations. Properties Time () - Seconds after reload starts to pl…

terminalCode Example
May 4, 2026

Sandbox: Physgun — grab, freeze, launch, and pull mechanics

Physgun — Grab, Freeze, Launch, and Pull Mechanics The Physgun () is a that lets players grab, move, freeze, and launch physics objects. It uses a struct to tra…

menu_bookDocumentation
May 4, 2026

RenderOptions: Game, Overlay, Bloom, AfterUI Render Layers — and Renderer.Attributes for Shader Parameters

RenderOptions: Render Layers for SceneObjects controls which render layers a component's appears in. It's exposed as a property on all subclasses. Render Layers…

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