Display Data Module

Persistent display settings, favourites, and recent items manager for grid selectors.

Overview

displayDataModule provides a factory that creates instances managing display preferences (group mode, sort order, tile size), favourite tracking, and recent item history. Data is persisted to a JSON file.

Module path: lua/ge/extensions/ui/gridSelectorUtils/displayDataModule.lua (loaded via require)

Exports (M)

Instance Methods

Internals

Persistence

Data is saved to a JSON file (e.g., /settings/gameplaySelectorData.json):

local data = {
  favourites = favourites,         -- {itemKey: timestamp}
  recentItems = recentItems,       -- ordered list of keys
  version = currentVersion,
  displayData = displayData        -- {groupMode: "system", ...}
}
jsonWriteFile(dataFile, data, true, nil, true)

Version Migration

An updateDisplayDataFunction callback handles migrations when saved data is older:

if data.version < currentVersion then
  data.displayData = updateDisplayDataFunction(data.displayData, data.version, currentVersion)
end

Option Types

Options support dropdown, checkbox, and number types. Options with settingsKey sync to engine settings. Special handling:

• showAuxContent defaults based on shipping_build
• showCareerContent respects shipping status

Recent Items

Recent items are stored as an ordered list (LIFO), capped at 100:

local function trackRecentItem(itemKey)
  local idx = arrayFindValueIndex(recentItems, itemKey)
  if idx then table.remove(recentItems, idx) end
  table.insert(recentItems, 1, itemKey)
  while #recentItems > maxRecentItems do
    table.remove(recentItems, #recentItems)
  end
end

How It Works

1. Backend creates instance: displayDataModule.create("/settings/data.json", options, migrateFn, "mySelector", 11)
2. First getDisplayData() loads from disk, applies defaults, handles migrations
3. UI reads options via getDisplayDataOptions() for rendering controls
4. Setting changes call setDisplayDataOption(key, value) → persist + hook
5. Favourites/recents are tracked alongside display data in the same file

Additional Exports

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

• M.create

See Also

• Button Module - Related reference
• Filter Module - Related reference
• Tiles Module - Related reference
• UI System Guide - Guide