auto_stories

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 "properties" in codeAPI Reference 96 results closeClear
codeAPI Reference
May 12, 2026

s&box ScriptedEmitterModel: Model-based emitter resource

ScriptedEmitterModel GameResource API Reference ScriptedEmitterModel is a GameResource for model-based particle/VFX emitters. It implements IDefinitionResource …

codeAPI Reference
May 12, 2026

s&box HoverballDefinition: Hoverball type GameResource

HoverballDefinition GameResource API Reference HoverballDefinition is a GameResource that defines a hoverball type with a prefab, used by the Hoverball tool to …

codeAPI Reference
May 12, 2026

s&box BalloonDefinition: Balloon type GameResource

BalloonDefinition GameResource API Reference BalloonDefinition is a GameResource that defines a balloon type with a prefab, used by the Balloon tool to spawn ba…

codeAPI Reference
May 12, 2026

s&box EmitterEntity: Particle emitter entity

EmitterEntity Component API Reference EmitterEntity is a world-placed SENT that spawns and controls a particle/VFX emitter. The emitter prefab is defined by a S…

codeAPI Reference
May 12, 2026

s&box EntitySpawnerEntity: Entity spawner

EntitySpawnerEntity Component API Reference EntitySpawnerEntity is a world-placed SENT that spawns another SENT at its location. Can be triggered manually via p…

codeAPI Reference
May 12, 2026

s&box DynamiteEntity: Explosive entity

DynamiteEntity Component API Reference DynamiteEntity is a Component that implements IPlayerControllable and IDamageable for an explosive entity. It can be trig…

codeAPI Reference
May 12, 2026

s&box IDefinitionResource: Resource metadata interface

IDefinitionResource API Reference IDefinitionResource is an interface for game resources that have display metadata (title and description). Type Signature Prop…

codeAPI Reference
May 12, 2026

s&box PlayerFallDamage: Fall damage component

PlayerFallDamage Component API Reference PlayerFallDamage is a Component that applies fall damage to the player when they land. It implements Local.IPlayerEvent…

codeAPI Reference
May 12, 2026

s&box TriggerTeleport: Trigger-based teleportation

TriggerTeleport Component API Reference TriggerTeleport is a Component that teleports objects that enter its trigger collider to a target GameObject. Type Signa…

codeAPI Reference
May 3, 2026

Player Component with Static Accessors

Player Component Main player component that manages health, damage, camera, and interfaces with the inventory system. Static Accessors Key Properties HUD Visibi…

codeAPI Reference
May 12, 2026

s&box MountMetadata: Mount fallback rendering

MountMetadata Component API Reference MountMetadata is attached to mount-spawned props to show a graceful bounding box and hint the player which game it's from …

codeAPI Reference
May 3, 2026

Door Component with IPressable Interface

Door Component with IPressable Map entity door with animated open/close using curves and the IPressable interface. Key Features AnimationCurve for smooth motion…

codeAPI Reference
May 12, 2026

s&box SaveSystem: Scene save/load

SaveSystem GameObjectSystem API Reference SaveSystem is a saving/loading system that captures the differences between the current scene state and the original s…

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 TVEntity: Camera feed display

TVEntity Component API Reference TVEntity is a TV screen entity that displays the feed from a linked CameraEntity. Use the Linker tool to connect a Camera to th…

codeAPI Reference
May 12, 2026

s&box TriggerPush: Trigger-based push force

TriggerPush Component API Reference TriggerPush is a Component that pushes objects (players and rigidbodies) that enter its trigger collider. Type Signature Pro…

codeAPI Reference
May 12, 2026

s&box BallSocketPair: Hydraulic ball socket visual

BallSocketPair Component API Reference BallSocketPair is a Component that aligns two ball socket models towards each other and updates a line renderer between t…

codeAPI Reference
May 12, 2026

s&box GamePreferences: ConVar-based user settings with attributes

GamePreferences API Reference GamePreferences is a static class for defining user preferences using ConVar attributes with automatic persistence. Type Signature…

codeAPI Reference
May 12, 2026

s&box ServerSettings: Replicated server-controlled settings

ServerSettings API Reference ServerSettings is a static class for server-controlled settings that are replicated to all clients. Type Signature Example Property…

codeAPI Reference
May 3, 2026

PlayerData Component for Stats and Respawn

PlayerData Component Persistent player data component tracking stats (kills, deaths), respawn state, and providing connection lookup. Key Properties Connection …