Tile Clustering

Groups vehicle configurations into clustered tiles by brand/model or model key.

Overview

ui_vehicleSelector_tileClustering handles clustering individual vehicle configs into visual tiles for the vehicle selector grid. Supports two modes: brandSubModelOrModel (groups by brand + submodel) and model (groups by model key). Also computes favourite/recent stats and source icons for each cluster.

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

Exports (M)

Internals

Cluster Modes

clusterItems

Returns { [clusterLabel] = { configsByKey, count, list, years, value } }.

Tile Creation

Both createTileFromBrandSubModelOrModel and createTileFromModel produce tiles with:

• key, name, preview, subElementCount
• favouriteIdx, recentIdx, showFavouriteIconPercent
• gotoPath - navigation path for drilling into configs
• doubleClickDetails - model/config for double-click action
• Performance stats: Value, Weight, Top Speed, Power, 0-60 mph, etc.
• sourceIcons - array of {icon} or {svg} objects
• isAuxiliary - true only if all configs in cluster are auxiliary

Source Icons

getSources returns icons based on:

• BeamNG - Official → "beamNG"
• Custom → "wrench"
• Automation type → SVG path
• Has modID → "puzzleModule"
• Missing JBeam → "danger"

How It Works

1. clusterItems groups configs by the chosen mode function.
2. For each cluster, createTileFromClusteredItems builds a tile with preview, stats, and source icons.
3. The tile's gotoPath allows the UI to navigate into the cluster's configs.
4. Favourite/recent stats determine star icons and sorting priority.

Lua Examples

local tileClustering = require('/lua/ge/extensions/ui/vehicleSelector/tileClustering')

-- Cluster configs by brand+submodel
local clusters = tileClustering.clusterItems(configList, "brandSubModelOrModel")

-- Create a tile from a cluster
for label, cluster in pairs(clusters) do
  local tile = tileClustering.createTileFromClusteredItems(cluster, group, "brandSubModelOrModel")
end

Additional Exports

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

• M.clusterItems
• M.createTileFromClusteredItems
• M.getClusterModeFunction
• M.getClusteredItemsFavouriteIconPercent
• M.getClusteredItemsStats
• M.getSources

See Also

• Vehicle Selector – Details Interaction - Related reference
• Vehicle Selector – General - Related reference
• Vehicle Selector – Tile Grouping - Related reference
• UI System Guide - Guide