Freeroam Configurator Options

Provides default freeroam configuration options for traffic and time-of-day settings. Responds to the freeroam configurator's option gathering and application hooks.

Hooks

Options Provided

Traffic (order 100)

Key: traffic_trafficMode

Disabled with a notice if the level doesn't support traffic.

Time of Day (order 200)

Key: environment_timeOfDay - Uses level-defined time-of-day presets from core_levels.getTimeOfDayOptions().

Key: environment_timePlay - Time progression speed: disabled, slow, normal, fast.

Disabled with a notice if the level has no time-of-day options.

How It Works

1. onFreeroamConfiguratorGetOptions checks level.supportsTraffic and available time presets
2. Builds select-type option UI structures with labels, icons, and values
3. onFreeroamConfiguratorApplyOptions maps UI selections to spawningOptionsHelper fields
4. Traffic mode police sets both traffic enabled + police ratio of 0.25

Usage Examples

-- Options are gathered automatically via hook
local options = {}
extensions.hook("onFreeroamConfiguratorGetOptions", level, options)

-- Options are applied via hook before freeroam starts
extensions.hook("onFreeroamConfiguratorApplyOptions", {
  traffic_trafficMode = "enabled",
  environment_timeOfDay = "sunset",
  environment_timePlay = "slow"
})

Notes

• Uses translateHelper for localized labels
• Part of the modular freeroam configurator system - additional option providers can be added in configuratorOptions/

See Also

• Freeroam Guide - Guide