API ReferenceGE Extensionscore
Core Snapshot
Manages saving and loading game snapshots (camera state) via the online API.
Manages saving and loading game snapshots (camera state) via the online API.
Overview
Extension: core_snapshot - Provides snapshot create/load functionality. Snapshots capture camera position/rotation and are persisted via the BeamNG online API (s2/v4). Also handles beamng: scheme commands for snapshot loading.
Public Functions
| Function | Description |
|---|---|
M.createSnapshot(scheme, saveToServer) | Saves current camera state and uploads to server |
M.loadSnapshot(snapshotId) | Downloads and applies a snapshot by ID |
M.onSnapshotSchemeCommand(command, data, isStartingArg) | Handles loadSnapshot scheme commands |
M.onSerialize() | Returns serialization data (ignoreStartupCmd flag) |
M.onDeserialized(d) | Restores serialization state |
Snapshot Data Structure
A snapshot contains:
| Field | Description |
|---|---|
camPos | Camera position {x, y, z} |
camRot | Camera rotation {x, y, z, w} quaternion |
Usage Examples
-- Create and upload a snapshot
core_snapshot.createSnapshot()
-- Load a snapshot by ID
core_snapshot.loadSnapshot('abc123')Hooks
| Hook | When |
|---|---|
onSnapshotLoad | After snapshot data is applied |
onSnapshotCreate | After snapshot data is captured |
See Also
- Scheme Command Server - URI scheme handler