Rally Enums
Defines enumeration constants for the rally system: pacenote audio modes, trigger types, and slow corner release types.
Defines enumeration constants for the rally system: pacenote audio modes, trigger types, and slow corner release types.
Public API
Pacenote Audio Modes (M.pacenoteAudioMode)
| Key | Value | Description |
|---|---|---|
auto | 1 | Automatic mode selection |
freeform | 2 | Freeform (unstructured) audio |
structuredOnline | 3 | Structured with online TTS |
structuredOffline | 4 | Structured with offline/pre-recorded TTS |
custom | 5 | Custom audio files |
Name lookup: M.pacenoteAudioModeNames[mode] → string name
Trigger Types (M.triggerType)
| Key | Value | Description |
|---|---|---|
dynamic | 1 | Speed-based timing (default) - triggers based on time-to-corner-start |
csImmediate | 15 | Immediate trigger - fires as soon as evaluated (only for first pacenote) |
Name lookup: M.triggerTypeName[type] → descriptive string
Slow Corner Release Types (M.slowCornerReleaseType)
| Key | Value | Description |
|---|---|---|
csStatic | 20 | Release at corner start position |
csHalf | 30 | Release halfway between corner start and end (default) |
ceMinus5 | 40 | Release 5 meters before corner end |
ceStatic | 50 | Release at corner end position |
Name lookup: M.slowCornerReleaseTypeName[type] → descriptive string
How It Works
These enums are used throughout the rally system:
- Audio mode determines how pacenote audio is generated - from auto-selection to fully custom files
- Trigger type controls when the co-driver audio fires relative to vehicle position and speed
- Slow corner release determines when visual pacenote indicators are cleared for slow corners
Usage Examples
local RallyEnums = require('/lua/ge/extensions/gameplay/rally/enums')
-- Check trigger type
if triggerType == RallyEnums.triggerType.dynamic then
-- use speed-based timing
end
-- Get mode name
local modeName = RallyEnums.pacenoteAudioModeNames[RallyEnums.pacenoteAudioMode.auto]
-- modeName == "auto"Notes
- Several trigger types are commented out (
csStatic=20,csHalf=30,ceMinus5=40,ceStatic=50) - they exist asslowCornerReleaseTypeinstead - Driveline mode enum (
recce/route) is defined but commented out - Values are integers for efficient comparison; name tables provide human-readable labels
See Also
- Rally Audio Manager - Related reference
- Rally Camera Path Player - Related reference
- Rally Client - Related reference
- Gameplay Systems Guide - Guide
Rally Cut Capture
Captures vehicle position/rotation snapshots ("cuts") during recce recording sessions. Each cut is written as a JSON line to a file for later processing by the transcription pipeline.
Rally Extension Helper
Stub extension for rally gameplay. Provides empty `load` and `unload` lifecycle hooks. Currently contains no functional logic - serves as a placeholder for future rally extension management.