RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

Server CommandsGE UtilitiesGame Engine MainNavigation GraphScreenshot CaptureServerServer ConnectionSpawnpoint ManagerSimulation TimeVehicle SpawningSuspension Frequency Tester
Gameplay AchievementGameplay CityDiscoverForce FieldGarage ModeMarker InteractionParking SystemGameplay Playmode MarkersGameplay PoliceGameplay RallyGameplay Rally LoopGameplay Raw POIsGameplay Skidpad TestSpeed Trap LeaderboardsSpeed Traps and CamerasGameplay StatisticsTaxi Ride SystemTraffic SystemVehicle PerformanceWalking
Rally Audio ManagerRally Camera Path PlayerRally ClientRally Cut CaptureRally EnumsRally Extension HelperRally GeometryRally ManagerRecce ManagerRecce AppRecce SettingsRally Settings ManagerSnap-to-RoadTraffic Exclusion ZonesRally UtilityRally Vehicle CaptureRally Vehicle Tracker

UI

Resources

BeamNG Game Engine Lua Cheat SheetGE Developer RecipesMCP Server Setup

// RLS.STUDIOS=true

Premium Mods for BeamNG.drive. Career systems, custom vehicles, and immersive gameplay experiences.

Index

HomeProjectsPatreon

Socials

DiscordPatreon (RLS)Patreon (Vehicles)

© 2026 RLS Studios. All rights reserved.

Modding since 2024

API ReferenceGE Extensionsgameplayrally

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)

KeyValueDescription
auto1Automatic mode selection
freeform2Freeform (unstructured) audio
structuredOnline3Structured with online TTS
structuredOffline4Structured with offline/pre-recorded TTS
custom5Custom audio files

Name lookup: M.pacenoteAudioModeNames[mode] → string name

Trigger Types (M.triggerType)

KeyValueDescription
dynamic1Speed-based timing (default) - triggers based on time-to-corner-start
csImmediate15Immediate trigger - fires as soon as evaluated (only for first pacenote)

Name lookup: M.triggerTypeName[type] → descriptive string

Slow Corner Release Types (M.slowCornerReleaseType)

KeyValueDescription
csStatic20Release at corner start position
csHalf30Release halfway between corner start and end (default)
ceMinus540Release 5 meters before corner end
ceStatic50Release at corner end position

Name lookup: M.slowCornerReleaseTypeName[type] → descriptive string

How It Works

These enums are used throughout the rally system:

  1. Audio mode determines how pacenote audio is generated - from auto-selection to fully custom files
  2. Trigger type controls when the co-driver audio fires relative to vehicle position and speed
  3. 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 as slowCornerReleaseType instead
  • 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.

On this page

Public APIPacenote Audio Modes (M.pacenoteAudioMode)Trigger Types (M.triggerType)Slow Corner Release Types (M.slowCornerReleaseType)How It WorksUsage ExamplesNotesSee Also