Vehicle Selector – Vehicle Operations

Handles vehicle spawning, replacing, cloning, and management actions in the vehicle selector.

Overview

ui_vehicleSelector_vehicleOperations provides all the action buttons for the vehicle selector: spawning new vehicles, replacing the current one, cloning, removing, resetting, random selection, and saving configs. Uses a fade/waiting screen for smooth transitions.

Extension path: lua/ge/extensions/ui/vehicleSelector/vehicleOperations.lua

Exports (M)

Data Fields

Internals

Spawn/Replace Flow

1. User clicks Spawn or Replace button.
2. UI state changes to "play", then guihooks.trigger("app:waiting", true).
3. A callbackAfterFade is set with the actual spawn/replace logic.
4. When onScreenFadeState(1) or onUiWaitingState fires, the callback runs.
5. Calls core_vehicles.spawnNewVehicle or core_vehicles.replaceVehicle.
6. Fires appropriate extension hooks and disables waiting state.

Management Buttons

getManagementDetails creates these buttons (when enabled):

• Save as default.pc (dev only) - core_vehicle_partmgmt.savedefault()
• Load default.pc (dev only) - core_vehicles.spawnDefault()
• Save current config - navigates to save UI
• Clone Current - core_vehicles.cloneCurrent()
• Select Random - picks random config passing current filters
• Reset All - resetGameplay(-1)
• Remove All - core_vehicles.removeAll()
• Remove Current - core_vehicles.removeCurrent()
• Remove Others - core_vehicles.removeAllExceptCurrent()

Paint Handling

When additionalData is provided (paint names), the spawn/replace functions look up paint objects from the model's paint table and pass them as spawn options.

How It Works

1. makeSpawningButtons creates "Spawn New" and "Replace Current" (primary, double-click) buttons.
2. Each button is registered via buttonInstance.addButton(callback, meta).
3. On click, executeButton(id, additionalData) runs the callback.
4. If filterResetOnSpawn is enabled, filters are cleared after spawning.
5. Recent vehicle tracking is called on spawn/replace.

Lua Examples

-- Execute a button by ID
extensions.ui_vehicleSelector_vehicleOperations.executeButton(1, {
  paint = "Red", paint2 = "Black"
})

-- Get management details
local mgmt = extensions.ui_vehicleSelector_vehicleOperations.getManagementDetails()
print(mgmt.details.currentVehicleName)

Hooks

Additional Exports

The following exports are available but not yet documented in detail:

• M.addButton
• M.clearButtonFunctions
• M.customDetailsButtons
• M.detailsButtonForFreeroam
• M.executeButton
• M.executeDoubleClick
• M.getCurrentVehicleThumb
• M.getFreeButtonId
• M.getManagementDetails
• M.getVehicleName
• M.makeSpawningButtons
• M.onScreenFadeState
• M.onUiWaitingState
• M.setCustomDetailsButtons
• M.setDetailsButtonForFreeroam
• M.setManagementButtonsEnabled