Module:Quotes

Documentation for this module may be created at Module:Quotes/doc

local Utils = require('Module:Utils')
local format = require('Module:StringInterpolation').format
local getArgs = require('Module:GetArgs')
local Ship = require('Module:Ship')

function format_category(name)
    return "[[" .. "Category:" .. name .. "]]"
end

local templates = {
    header = [[{| class="wikitable typography-xl-optout" style="width:100%;"
! style="width:10%;" | Event
!Japanese
!English
! style="${note_style}" | Note]],
    footer = "|}",
    audio_file = "${ship}${suffix}-${line}.ogg",
    audio_button = [=[<span class="audio-button click-parent">[[Media:${audio_file}|Play]]</span>]=],
    line_link = "[${link} ${line}]",
    remodel_row_style = [[style="border-left: 15px solid #aaa;"]],
    spoiler = [[<span style="background-color:#3a3a3a">${text}</span>]],
    incomplete_style = "background:#fee;",
    incomplete_category = format_category("Ship pages with incomplete quotes"),
    row = [=[|- ${style}
| nowrap="nowrap" |${audio_button} ${line}
| colspan="${ja_colspan}" style="${ja_style}" |<span lang="ja" style="font-family: sans-serif;">${ja}</span>
${en_cell}|${note}]=],
    note = [[|-
| colspan="5" |　⇧ ${note}]],
}

local lines = {
    { name = "Introduction" },
    { name = "Library" },
    { name = "Secretary 1" },
    { name = "Secretary 2" },
    { name = "Secretary 3" },
    { name = "Idle", extra = true  },
    { name = "Secretary Married", spoiler = true },
    { name = "Wedding", spoiler = true },
    { name = "Looking At Scores" },
    { name = "Joining A Fleet" },
    { name = "Equipment 1" },
    { name = "Equipment 2" },
    { name = "Equipment 3", note = "shared with expedition selection, resource collection, instant repair and development" },
    { name = "Supply" },
    { name = "Docking Minor" },
    { name = "Docking Major" },
    { name = "Docking Complete", extra = true },
    { name = "Construction" },
    { name = "Returning From Sortie" },
    { name = "Starting A Sortie" },
    { name = "Battle Start" },
    { name = "Air Battle", extra = true },
    { name = "Attack", note = "shared with [[Combat#Artillery_Spotting|day]]/[[Combat#Night_Special_Attack_Modifier|night]] special attacks, [[Expedition#Support_expedition|support expedition team]] arrival" },
    { name = "Night Battle" },
    { name = "Night Attack" },
    { name = "MVP" },
    { name = "Minor Damage 1" },
    { name = "Minor Damage 2" },
    { name = "Major Damage" },
    { name = "Sunk", spoiler = true },
}

local audio_suffixes = {
    ["Kai"] = "Kai",
    ["Kai Ni"] = "Kai2",
}

function format_text(text, line)
    return text and line.spoiler and format{templates.spoiler, text = text} or text or ""
end

function isCarrier(base_ship_name, remodel)
    local ship = Ship(base_ship_name .. "/" .. (remodel or ""))
    return ship:type() == 11 or ship:type() == 16 or ship:type() == 18
end

-- Global variable, potentially altered by insertRow, checked by Quotes.ShipQuotes.
local complete = true

function insertRow(result, remodel, args, line, count)
    local remodel_string = remodel and "/" .. remodel or ""
    local ja, en, note = args[line.name .. remodel_string], args[line.name .. remodel_string .. "/En"], args[line.name .. remodel_string .. "/Note"]
    local jaEn = args[line.name .. remodel_string .. "/Both"]
    local link = args[line.name .. remodel_string .. "/Link"]
    local is_empty_pre_kai_line = not remodel and not ja and not en and not jaEn and (args[line.name .. "/Kai"] or args[line.name .. "/Kai/En"] or args[line.name .. "/Kai/Both"])

    if line.name == "Night Attack" then
         line.extra = isCarrier(args.ship, remodel)
    elseif line.name == "Air Battle" then
         line.extra = not isCarrier(args.ship, remodel)
    end

    if (not remodel and not line.extra or jaEn or ja or en or note) and not is_empty_pre_kai_line then
        local line_name = count == 0 and (remodel and line.name .. " (" .. remodel .. ")" or line.name) or remodel or line.name
        local ja_style = not jaEn and (not ja or ja == "" or ja == "?") and templates.incomplete_style
        local en_style = not jaEn and (not en or en == "" or en == "?") and templates.incomplete_style
        local jaEn_style = jaEn and (jaEn == "" or jaEn == "?") and templates.incomplete_style
        if ja_style or en_style or jaEn_style then
            complete = false
        end
        table.insert(result, format{
            templates.row,
            style = remodel and count > 0 and templates.remodel_row_style or "",
            audio_button = args.no_audio and "" or format{
                templates.audio_button,
                audio_file = format{
                    templates.audio_file,
                    ship = args.ship,
                    suffix = audio_suffixes[remodel] or "",
                    line = line.name,
                },
            },
            line = link and format{templates.line_link, link = link, line = line_name} or line_name,
            ja = format_text(jaEn or ja, line),
            ja_colspan = jaEn and "2" or "1",
            ja_style = ja_style or jaEn_style or "",
            en_cell = jaEn and "" or '| style="' .. (en_style or "") .. '"|' .. format_text(en, line) .. "\n",
            note = format_text(note, line),
        })
        return 1
    end
    return 0
end

local Quotes = {}

function Quotes.ShipQuotes(frame, args)
    args = args or Utils.getTemplateArgs(frame)
    args.explicit.ship = args.implicit.pagename or args.explicit.ship or ""
    local result = {}
    table.insert(result, format{templates.header, note_style = args.explicit.note_style or ""})
    for _, line in pairs(lines) do
        local added = insertRow(result, nil, args.explicit, line, 0)
        added = added + insertRow(result, "Kai", args.explicit, line, added)
        added = added + insertRow(result, "Kai Ni", args.explicit, line, added)
        if line.note and added > 0 then
            table.insert(result, format{templates.note, note = line.note})
        end
    end
    table.insert(result, templates.footer)
    if not complete then
        table.insert(result, templates.incomplete_category)
    end
    return table.concat(result, "\n")
end

-- Quotes.t = Quotes.ShipQuotes(nil, {explicit = {}, implicit = {pagename = "Ayanami"}})

return Quotes