civ7-modding-tools/src/builders/UnitBuilder.ts

Mod generation tool for Civilization 7.

import * as lodash from "lodash";

import { TClassProperties, TObjectValues, TPartialRequired } from "../types";
import {
    DatabaseNode,
    IconDefinitionNode,
    TagNode,
    TIconDefinitionNode, TUnitAdvisoryNode,
    TUnitCostNode,
    TUnitNode,
    TUnitReplaceNode,
    TUnitStatNode,
    TUnitUpgradeNode,
    TVisualRemapNode,
    TypeNode,
    TypeTagNode, UnitAdvisoryNode,
    UnitCostNode,
    UnitNode,
    UnitReplaceNode,
    UnitStatNode,
    UnitUpgradeNode,
    VisualRemapNode
} from "../nodes";
import { ACTION_GROUP_ACTION, KIND, UNIT_CLASS } from "../constants";
import { locale, trim } from "../utils";
import { XmlFile } from "../files";
import { TUnitLocalization, UnitLocalization } from "../localizations";

import { BaseBuilder } from "./BaseBuilder";

type TUnitBuilder = TClassProperties<UnitBuilder>

export class UnitBuilder extends BaseBuilder<TUnitBuilder> {
    _current: DatabaseNode = new DatabaseNode();
    _localizations: DatabaseNode = new DatabaseNode();
    _icons: DatabaseNode = new DatabaseNode();
    _visualRemap: DatabaseNode | null = null;

    unit: TPartialRequired<TUnitNode, 'unitType'> = { unitType: 'UNIT_CUSTOM' }
    unitStat: Partial<TUnitStatNode> = {};
    unitCost: Partial<TUnitCostNode> = {};
    icon: TPartialRequired<TIconDefinitionNode, 'path'> = {
        path: 'fs://game/civ_sym_han'
    }
    unitReplace: TPartialRequired<TUnitReplaceNode, 'replacesUnitType'> | null = null;
    unitUpgrade: TPartialRequired<TUnitUpgradeNode, 'upgradeUnit'> | null = null;
    visualRemap: TPartialRequired<TVisualRemapNode, 'to'> | null = null;
    unitAdvisories: TPartialRequired<TUnitAdvisoryNode, 'advisoryClassType'>[] = [];
    localizations: TUnitLocalization[] = [];

    typeTags: TObjectValues<typeof UNIT_CLASS>[] = [];

    constructor(payload: Partial<TUnitBuilder> = {}) {
        super();
        this.fill(payload);
    }

    migrate() {
        this._current.fill({
            types: [
                new TypeNode({
                    type: this.unit.unitType,
                    kind: KIND.UNIT
                })
            ],
            units: [
                new UnitNode({
                    name: locale(this.unit.unitType, 'name'),
                    description: locale(this.unit.unitType, 'description'),
                    ...this.unit,
                })
            ],
            tags: [
                new TagNode({
                    category: 'UNIT_CLASS',
                    tag: this.unit.unitType.replace('UNIT_', 'UNIT_CLASS_')
                })
            ],
            typeTags: [
                new TypeTagNode({
                    type: this.unit.unitType,
                    tag: this.unit.unitType.replace('UNIT_', 'UNIT_CLASS_')
                }),
                ...this.typeTags.map(item => new TypeTagNode({
                    type: this.unit.unitType,
                    tag: item
                }))
            ],
            unitStats: [new UnitStatNode({
                ...this.unit,
                ...this.unitStat
            })],
            unitCosts: [new UnitCostNode({
                ...this.unit,
                ...this.unitCost
            })],
            unitReplaces: this.unitReplace ? [new UnitReplaceNode({
                civUniqueUnitType: this.unit.unitType,
                ...this.unitReplace
            })] : [],
            unitUpgrades: this.unitUpgrade ? [new UnitUpgradeNode({
                unit: this.unit.unitType,
                ...this.unitUpgrade
            })] : [],
            unitAdvisories: this.unitAdvisories.map(item => new UnitAdvisoryNode({
                unitType: this.unit.unitType,
                ...item
            }))
        })

        if (this.visualRemap) {
            this._visualRemap = new DatabaseNode({
                visualRemaps: [
                    new VisualRemapNode({
                        id: `REMAP_${this.unit.unitType}`,
                        displayName: locale(this.unit.unitType, 'name'),
                        kind: 'UNIT',
                        from: this.unit.unitType,
                        ...this.visualRemap
                    })
                ]
            })
        }

        this._icons.fill({
            iconDefinitions: [new IconDefinitionNode({
                id: this.unit.unitType,
                ...this.icon,
            })]
        })

        this._localizations.fill({
            englishText: this.localizations.map(item => {
                return new UnitLocalization({
                    prefix: this.unit.unitType,
                    ...item
                });
            }).flatMap(item => item.getNodes())
        });

        return this;
    }


    build() {
        const path = `/units/${lodash.kebabCase(trim(this.unit.unitType))}/`;
        return [
            new XmlFile({
                path,
                name: 'current.xml',
                content: this._current.toXmlElement(),
                actionGroups: [this.actionGroupBundle.current],
                actionGroupActions: [ACTION_GROUP_ACTION.UPDATE_DATABASE]
            }),
            new XmlFile({
                path,
                name: 'visual-remap.xml',
                content: this._visualRemap?.toXmlElement(),
                actionGroups: [this.actionGroupBundle.current],
                actionGroupActions: [ACTION_GROUP_ACTION.UPDATE_VISUAL_REMAPS]
            }),
            new XmlFile({
                path,
                name: 'localization.xml',
                content: this._localizations.toXmlElement(),
                actionGroups: [this.actionGroupBundle.shell, this.actionGroupBundle.always],
                actionGroupActions: [ACTION_GROUP_ACTION.UPDATE_TEXT]
            }),
            new XmlFile({
                path,
                name: 'icons.xml',
                content: this._icons.toXmlElement(),
                actionGroups: [this.actionGroupBundle.shell, this.actionGroupBundle.current],
                actionGroupActions: [ACTION_GROUP_ACTION.UPDATE_ICONS]
            }),
        ]
    }
}