JBeam Stats

Generates statistics about all JBeam files in the game - part counts, section usage, line counts, and modifier counts.

Overview

util_jbeamStats scans all .jbeam files and produces aggregate statistics including total files, parts, sections, rows per section, line counts, root parts, and modifier usage. Used by the documentation creator for the official docs.

Extension path: lua/ge/extensions/util/jbeamStats.lua

Exports (M)

Internals

Statistics Collected

Counting Logic

For each JBeam file:

1. Parse JSON content.
2. For each part, iterate sections.
3. Table sections with array headers: count data rows (subtract 1 for header).
4. Non-array entries in table sections count as modifiers.
5. Root parts are identified by slotType == "main".

How It Works

1. Call getStats().
2. All .jbeam files are found via FS:findFiles.
3. Each file is decoded and analyzed.
4. Returns a comprehensive statistics table.

Lua Examples

-- Get JBeam statistics
local stats = extensions.util_jbeamStats.getStats()
print("Total files: " .. stats.totalJbeamFiles)
print("Total parts: " .. stats.partCount)
print("Total lines: " .. stats.totalLineCount)
print("Root parts: " .. stats.totalRootParts)

-- Write to file for documentation
jsonWriteFile('jbeam_stats.json', stats, true)

-- Check most common sections
for _, entry in ipairs(stats.sectionCountOrdered) do
  print(entry[1] .. ": " .. entry[2])
end

Additional Exports

• M.getStats - (undocumented)