cp_basedefence_callbacks.cpp

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

#include "../../cl_shared.h"
#include "../../ui/ui_dataids.h"
#include "cp_campaign.h"
#include "cp_basedefence_callbacks.h"
#include "cp_fightequip_callbacks.h"
#include "cp_mapfightequip.h"
#include "cp_ufo.h"
#include "cp_missions.h"

static aircraftItemType_t BDEF_GetItemTypeFromID (const char* type)
{
    assert(type);
    if (Q_streq(type, "missile"))
        return AC_ITEM_BASE_MISSILE;
    else if (Q_streq(type, "laser"))
        return AC_ITEM_BASE_LASER;

    return MAX_ACITEMS;
}
static const char* BDEF_GetIDFromItemType (aircraftItemType_t type)
{
    switch (type) {
    case AC_ITEM_BASE_MISSILE:
        return "missile";
    case AC_ITEM_BASE_LASER:
        return "laser";
    default:
        return "unknown";
    }
}

static void BDEF_UpdateAircraftItemList (const aircraftSlot_t* slot)
{
    linkedList_t* itemList = nullptr;
    technology_t** list;

    assert(slot);

    /* Add all items corresponding to airequipID to list */
    list = AII_GetCraftitemTechsByType(slot->type);

    /* Copy only those which are researched to buffer */
    while (*list) {
        if (AIM_SelectableCraftItem(slot, *list))
            cgi->LIST_AddString(&itemList, _((*list)->name));
        list++;
    }

    /* copy buffer to mn.menuText to display it on screen */
    cgi->UI_RegisterLinkedListText(TEXT_LIST, itemList);
}

static void BDEF_SelectItem_f (void)
{
    aircraftSlot_t* slot;
    installation_t* installation = INS_GetCurrentSelectedInstallation();
    base_t* base = B_GetCurrentSelectedBase();
    aircraftItemType_t bdefType;
    int slotIDX;
    int itemIDX;

    if (cgi->Cmd_Argc() < 4) {
        cgi->Com_Printf("Usage: %s <type> <slotIDX> <itemIDX>\n", cgi->Cmd_Argv(0));
        return;
    }

    bdefType = BDEF_GetItemTypeFromID(cgi->Cmd_Argv(1));
    slotIDX = atoi(cgi->Cmd_Argv(2));
    itemIDX = atoi(cgi->Cmd_Argv(3));

    if (bdefType == MAX_ACITEMS) {
        cgi->Com_Printf("BDEF_AddItem_f: Invalid defence type.\n");
        return;
    }

    if (slotIDX >= 0) {
        const objDef_t* item;
        slot = (installation) ? BDEF_GetInstallationSlotByIDX(installation, bdefType, slotIDX) : BDEF_GetBaseSlotByIDX(base, bdefType, slotIDX);
        item = (slot) ? ( (slot->nextItem) ? slot->nextItem : slot->item ) : nullptr;
        UP_AircraftItemDescription(item);
    } else if (itemIDX >= 0) {
        technology_t** list;
        technology_t* itemTech = nullptr;
        int i = 0;

        slot = (installation) ? BDEF_GetInstallationSlotByIDX(installation, bdefType, 0) : BDEF_GetBaseSlotByIDX(base, bdefType, 0);
        list = AII_GetCraftitemTechsByType(bdefType);
        while (*list && i <= itemIDX) {
            if (AIM_SelectableCraftItem(slot, *list)) {
                itemTech = *list;
                i++;
                break;
            }
            list++;
        }
        UP_AircraftItemDescription((itemTech) ? INVSH_GetItemByIDSilent(itemTech->provides) : nullptr);
    } else {
        cgi->Com_Printf("BDEF_AddItem_f: Invalid item-space.\n");
    }
}

static void BDEF_AddSlotToSlotList (const aircraftSlot_t* slot, linkedList_t** slotList)
{
    char defBuffer[512];
    const int size = cgi->LIST_Count(*slotList) + 1;
    if (!slot->item) {
        Com_sprintf(defBuffer, lengthof(defBuffer), _("%i: empty"), size);
        cgi->LIST_AddString(slotList, defBuffer);
    } else {
        const technology_t* tech;
        const char* status;
        if (!slot->installationTime)
            status = _("Working");
        else if (slot->installationTime > 0)
            status = _("Installing");
        else if (slot->nextItem)
            status = _("Replacing");
        else
            status = _("Removing");

        if (slot->nextItem != nullptr)
            tech = RS_GetTechForItem(slot->nextItem);
        else
            tech = RS_GetTechForItem(slot->item);

        Com_sprintf(defBuffer, lengthof(defBuffer), "%i: %s (%s)", size, _(tech->name), status);
        cgi->LIST_AddString(slotList, defBuffer);
    }
}

static void BDEF_FillSlotList (const baseWeapon_t* batteries, int maxBatteries, linkedList_t** slotList)
{
    BDEF_UpdateAircraftItemList(&batteries->slot);

    for (int i = 0; i < maxBatteries; i++, batteries++) {
        const aircraftSlot_t* slot = &batteries->slot;
        BDEF_AddSlotToSlotList(slot, slotList);
    }
}

static void BDEF_BaseDefenceMenuUpdate_f (void)
{
    char type[MAX_VAR];
    base_t* base = B_GetCurrentSelectedBase();
    installation_t* installation = INS_GetCurrentSelectedInstallation();
    aircraftItemType_t bdefType;
    linkedList_t* slotList = nullptr;
    const bool missileResearched = RS_IsResearched_ptr(RS_GetTechByID("rs_building_missile"));
    const bool laserResearched = RS_IsResearched_ptr(RS_GetTechByID("rs_building_laser"));

    if (cgi->Cmd_Argc() != 2)
        type[0] = '\0';
    else
        Q_strncpyz(type, cgi->Cmd_Argv(1), sizeof(type));

    /* don't let old links appear on this menu */
    cgi->UI_ResetData(TEXT_BASEDEFENCE_LIST);
    cgi->UI_ResetData(TEXT_LIST);
    cgi->UI_ResetData(TEXT_ITEMDESCRIPTION);

    /* base or installation should not be nullptr because we are in the menu of this base or installation */
    if (!base && !installation)
        return;

    /* base and installation should not both be set. This function requires one or the other set. */
    if (base && installation) {
        Sys_Error("BDEF_BaseDefenceMenuUpdate_f: Both the base and installation are set");
        return;
    }

    cgi->Cvar_Set("mn_target", _("None"));
    cgi->UI_ExecuteConfunc("setautofire disable");
    if (installation) {
        /* Every slot aims the same target */
        if (installation->numBatteries) {
            cgi->UI_ExecuteConfunc("setautofire %i", installation->batteries[0].autofire);

            if (installation->batteries[0].target)
                cgi->Cvar_Set("mn_target", "%s", UFO_GetName(installation->batteries[0].target));
        }
    } else if (base) {
        bool autofire = false;
        /* Every slot aims the same target */
        if (base->numBatteries) {
            autofire |= base->batteries[0].autofire;
            if (base->batteries[0].target)
                cgi->Cvar_Set("mn_target", "%s", UFO_GetName(base->batteries[0].target));
        }
        if (base->numLasers) {
            autofire |= base->lasers[0].autofire;
            if (base->lasers[0].target && !base->batteries[0].target)
                cgi->Cvar_Set("mn_target", "%s", UFO_GetName(base->lasers[0].target));
        }
        if (base->numBatteries || base->numLasers)
            cgi->UI_ExecuteConfunc("setautofire %i", autofire);
    }

    /* Check if we can change to laser or missile */
    if (base) {
        cgi->UI_ExecuteConfunc("set_defencetypes %s %s",
                (!missileResearched) ? "na" : (base && base->numBatteries > 0) ? "enable" : "disable",
                (!laserResearched) ? "na" : (base && base->numLasers > 0) ? "enable" : "disable");
    } else if (installation) {
        cgi->UI_ExecuteConfunc("set_defencetypes %s %s",
                (!missileResearched) ? "na" : (installation && installation->installationStatus == INSTALLATION_WORKING
                        && installation->numBatteries > 0) ? "enable" : "disable", "na");
    }

    if (Q_streq(type, "missile"))
        bdefType = AC_ITEM_BASE_MISSILE;
    else if (Q_streq(type, "laser"))
        bdefType = AC_ITEM_BASE_LASER;
    else    /* info page */
        return;

    /* Check that the base or installation has at least 1 battery */
    if (base) {
        if (base->numBatteries + base->numLasers < 1) {
            cgi->Com_Printf("BDEF_BaseDefenceMenuUpdate_f: there is no defence battery in this base: you shouldn't be in this function.\n");
            return;
        }
    } else if (installation) {
        if (installation->installationStatus != INSTALLATION_WORKING) {
            cgi->Com_Printf("BDEF_BaseDefenceMenuUpdate_f: installation isn't working: you shouldn't be in this function.\n");
            return;
        } else if (installation->installationTemplate->maxBatteries < 1) {
            cgi->Com_Printf("BDEF_BaseDefenceMenuUpdate_f: there is no defence battery in this installation: you shouldn't be in this function.\n");
            return;
        }
    }

    if (installation) {
        /* we are in the installation defence menu */
        if (installation->installationTemplate->maxBatteries == 0) {
            cgi->LIST_AddString(&slotList, _("No defence of this type in this installation"));
        } else {
            BDEF_FillSlotList(installation->batteries, installation->installationTemplate->maxBatteries, &slotList);
        }
    } else if (bdefType == AC_ITEM_BASE_MISSILE) {
        /* we are in the base defence menu for missile */
        if (base->numBatteries == 0) {
            cgi->LIST_AddString(&slotList, _("No defence of this type in this base"));
        } else {
            BDEF_FillSlotList(base->batteries, base->numActiveBatteries, &slotList);
        }
    } else if (bdefType == AC_ITEM_BASE_LASER) {
        /* we are in the base defence menu for laser */
        if (base->numLasers == 0) {
            cgi->LIST_AddString(&slotList, _("No defence of this type in this base"));
        } else {
            BDEF_FillSlotList(base->lasers, base->numActiveLasers, &slotList);
        }
    } else {
        cgi->Com_Printf("BDEF_BaseDefenceMenuUpdate_f: unknown bdefType.\n");
        return;
    }
    cgi->UI_RegisterLinkedListText(TEXT_BASEDEFENCE_LIST, slotList);
}

static void BDEF_AddItem_f (void)
{
    aircraftSlot_t* slot;
    installation_t* installation = INS_GetCurrentSelectedInstallation();
    base_t* base = B_GetCurrentSelectedBase();
    technology_t** list;
    technology_t* itemTech = nullptr;
    aircraftItemType_t bdefType;
    int slotIDX;

    if ((!base && !installation) || (base && installation)) {
        cgi->Com_Printf("Exiting early base and installation both true or both false\n");
        return;
    }

    if (cgi->Cmd_Argc() < 3) {
        cgi->Com_Printf("Usage: %s <type> <slotIDX>\n", cgi->Cmd_Argv(0));
        return;
    }

    bdefType = BDEF_GetItemTypeFromID(cgi->Cmd_Argv(1));
    slotIDX = atoi(cgi->Cmd_Argv(2));

    if (bdefType == MAX_ACITEMS) {
        cgi->Com_Printf("BDEF_AddItem_f: Invalid defence type.\n");
        return;
    }

    if (slotIDX < 0) {
        return;
    } else {
        int maxWeapon;
        if (base)
            maxWeapon = (bdefType == AC_ITEM_BASE_MISSILE) ? base->numActiveBatteries : base->numActiveLasers;
        else
            maxWeapon = installation->numBatteries;
        if (slotIDX >= maxWeapon)
            return;
    }

    slot = (installation) ? BDEF_GetInstallationSlotByIDX(installation, bdefType, slotIDX) : BDEF_GetBaseSlotByIDX(base, bdefType, slotIDX);

    if (!slot) {
        cgi->Com_Printf("BDEF_AddItem_f: Invalid slot.\n");
        return;
    }

    list = AII_GetCraftitemTechsByType(bdefType);
    while (*list) {
        if (AIM_SelectableCraftItem(slot, *list)) {
            itemTech = *list;
            break;
        }
        list++;
    }

    if (!itemTech)
        return;

    if (!slot->nextItem) {
        /* we add the weapon, shield, item, or base defence if slot is free or the installation of
         * current item just began */
        if (!slot->item || (slot->item && slot->installationTime == slot->item->craftitem.installationTime)) {
            AII_RemoveItemFromSlot(base, slot, false);
            AII_AddItemToSlot(base, itemTech, slot, false); /* Aircraft stats are updated below */
            AII_AutoAddAmmo(slot);
        } else if (slot->item == INVSH_GetItemByID(itemTech->provides)) {
            /* the added item is the same than the one in current slot */
            if (slot->installationTime == -slot->item->craftitem.installationTime) {
                /* player changed his mind: he just want to re-add the item he just removed */
                slot->installationTime = 0;
            } else if (!slot->installationTime) {
                /* player try to add a weapon he already have: just skip */
            }
        } else {
            /* We start removing current item in slot, and the selected item will be installed afterwards */
            slot->installationTime = -slot->item->craftitem.installationTime;
            AII_AddItemToSlot(base, itemTech, slot, true);
            AII_AutoAddAmmo(slot);
        }
    } else {
        /* remove weapon and ammo of next item */
        AII_RemoveItemFromSlot(base, slot, false);
        AII_AddItemToSlot(base, itemTech, slot, true);
        AII_AutoAddAmmo(slot);
    }

    /* Reinit menu */
    cgi->Cmd_ExecuteString("basedef_updatemenu %s", BDEF_GetIDFromItemType(slot->type));
}

static void BDEF_RemoveItem_f (void)
{
    aircraftSlot_t* slot;
    installation_t* installation = INS_GetCurrentSelectedInstallation();
    base_t* base = B_GetCurrentSelectedBase();
    aircraftItemType_t bdefType;
    int slotIDX;

    if ((!base && !installation) || (base && installation)) {
        cgi->Com_Printf("Exiting early base and install both true or both false\n");
        return;
    }

    if (cgi->Cmd_Argc() < 3) {
        cgi->Com_Printf("Usage: %s <type> <slotIDX>\n", cgi->Cmd_Argv(0));
        return;
    }

    bdefType = BDEF_GetItemTypeFromID(cgi->Cmd_Argv(1));
    slotIDX = atoi(cgi->Cmd_Argv(2));

    if (bdefType == MAX_ACITEMS) {
        cgi->Com_Printf("BDEF_AddItem_f: Invalid defence type.\n");
        return;
    }

    if (slotIDX < 0) {
        return;
    } else {
        int maxWeapon;
        if (base)
            maxWeapon = (bdefType == AC_ITEM_BASE_MISSILE) ? base->numActiveBatteries : base->numActiveLasers;
        else
            maxWeapon = installation->numBatteries;
        if (slotIDX >= maxWeapon)
            return;
    }

    slot = (installation) ? BDEF_GetInstallationSlotByIDX(installation, bdefType, slotIDX) : BDEF_GetBaseSlotByIDX(base, bdefType, slotIDX);

    if (!slot) {
        cgi->Com_Printf("BDEF_AddItem_f: Invalid slot.\n");
        return;
    }

    if (!slot->item)
        return;

    if (!slot->nextItem) {
        /* we change the weapon, shield, item, or base defence that is already in the slot */
        /* if the item has been installed since less than 1 hour, you don't need time to remove it */
        if (slot->installationTime < slot->item->craftitem.installationTime) {
            slot->installationTime = -slot->item->craftitem.installationTime;
            AII_RemoveItemFromSlot(base, slot, true); /* we remove only ammo, not item */
        } else {
            AII_RemoveItemFromSlot(base, slot, false); /* we remove weapon and ammo */
        }
    } else {
        /* we change the weapon, shield, item, or base defence that will be installed AFTER the removal
         * of the one in the slot atm */
        AII_RemoveItemFromSlot(base, slot, false); /* we remove weapon and ammo */
        /* if you canceled next item for less than 1 hour, previous item is still functional */
        if (slot->installationTime == -slot->item->craftitem.installationTime) {
            slot->installationTime = 0;
        }
    }
    cgi->Cmd_ExecuteString("basedef_updatemenu %s", BDEF_GetIDFromItemType(slot->type));
}

static void BDEF_RemoveBattery_f (void)
{
    basedefenceType_t basedefType;
    int baseIdx;
    base_t* base;

    if (cgi->Cmd_Argc() < 3) {
        cgi->Com_Printf("Usage: %s <basedefType> <baseIdx>", cgi->Cmd_Argv(0));
        return;
    } else {
        char type[MAX_VAR];

        Q_strncpyz(type, cgi->Cmd_Argv(1), sizeof(type));
        if (Q_streq(type, "missile"))
            basedefType = BASEDEF_MISSILE;
        else if (Q_streq(type, "laser"))
            basedefType = BASEDEF_LASER;
        else if (Q_streq(type, "random"))
            basedefType = BASEDEF_RANDOM;
        else
            return;
        baseIdx = atoi(cgi->Cmd_Argv(2));
    }

    /* Check that the baseIdx exists */
    if (baseIdx < 0 || baseIdx >= B_GetCount()) {
        cgi->Com_Printf("BDEF_RemoveBattery_f: baseIdx %i doesn't exist: there is only %i bases in game.\n",
                baseIdx, B_GetCount());
        return;
    }

    base = B_GetFoundedBaseByIDX(baseIdx);
    if (!base) {
        cgi->Com_Printf("BDEF_RemoveBattery_f: baseIdx %i is not founded.\n", baseIdx);
        return;
    }

    if (basedefType == BASEDEF_RANDOM) {
        /* Type of base defence to destroy is randomly selected */
        if (base->numBatteries <= 0 && base->numLasers <= 0) {
            cgi->Com_Printf("No base defence to destroy\n");
            return;
        } else if (base->numBatteries <= 0) {
            /* only laser battery is possible */
            basedefType = BASEDEF_LASER;
        } else if (base->numLasers <= 0) {
            /* only missile battery is possible */
            basedefType = BASEDEF_MISSILE;
        } else {
            /* both type are possible, choose one randomly */
            basedefType = (basedefenceType_t)(rand() % 2 + BASEDEF_MISSILE);
        }
    } else {
        /* Check if the removed building was under construction */
        buildingType_t type;
        int workingNum, max;
        building_t* building;

        switch (basedefType) {
        case BASEDEF_MISSILE:
            type = B_DEFENCE_MISSILE;
            max = base->numBatteries;
            break;
        case BASEDEF_LASER:
            type = B_DEFENCE_LASER;
            max = base->numLasers;
            break;
        default:
            cgi->Com_Printf("BDEF_RemoveBattery_f: base defence type %i doesn't exist.\n", basedefType);
            return;
        }

        building = nullptr;
        workingNum = 0;
        while ((building = B_GetNextBuildingByType(base, building, type)))
            if (building->buildingStatus == B_STATUS_WORKING)
                workingNum++;

        if (workingNum == max) {
            /* Removed building was under construction, do nothing */
            return;
        } else if (workingNum != max - 1) {
            /* Should never happen, we only remove building one by one */
            cgi->Com_Printf("BDEF_RemoveBattery_f: Error while checking number of batteries (%i instead of %i) in base '%s'.\n",
                workingNum, max, base->name);
            return;
        }

        /* If we reached this point, that means we are removing a working building: continue */
    }

    BDEF_RemoveBattery(base, basedefType, -1);
}

static void BDEF_AddBattery_f (void)
{
    basedefenceType_t basedefType;
    base_t* base;
    const char* type;

    if (cgi->Cmd_Argc() < 3) {
        cgi->Com_Printf("Usage: %s <basedefType> <baseIdx>", cgi->Cmd_Argv(0));
        return;
    }

    type = cgi->Cmd_Argv(1);
    if (Q_streq(type, "missile"))
        basedefType = BASEDEF_MISSILE;
    else if (Q_streq(type, "laser"))
        basedefType = BASEDEF_LASER;
    else if (Q_streq(type, "random"))
        basedefType = BASEDEF_RANDOM;
    else {
        cgi->Com_Printf("BDEF_AddBattery_f: base defence type %s doesn't exist.\n", type);
        return;
    }

    base = B_GetBaseByIDX(atoi(cgi->Cmd_Argv(2)));
    if (base == nullptr) {
        cgi->Com_Printf("BDEF_AddBattery_f: Invalid base index given\n");
        return;
    }

    BDEF_AddBattery(basedefType, base);
}

static void BDEF_SetAutoFire (baseWeapon_t* weapon, bool state)
{
    assert(weapon);
    weapon->autofire = state;
    if (!weapon->autofire) {
        weapon->target = nullptr;
        cgi->Cvar_Set("mn_target", _("None"));
    }
}

static void BDEF_UpdateActiveBattery_f (void)
{
    base_t* base;
    const char* type;
    int count;

    if (cgi->Cmd_Argc() < 3) {
        cgi->Com_Printf("Usage: %s <basedefType> <baseIdx>", cgi->Cmd_Argv(0));
        return;
    }

    base = B_GetBaseByIDX(atoi(cgi->Cmd_Argv(2)));
    if (base == nullptr) {
        cgi->Com_Printf("BDEF_UpdateActiveBattery_f: Invalid base index given\n");
        return;
    }

    type = cgi->Cmd_Argv(1);
    if (Q_streq(type, "missile")) {
        B_CheckBuildingTypeStatus(base, B_DEFENCE_MISSILE, B_STATUS_WORKING, &count);
        base->numActiveBatteries = std::min(count, base->numBatteries);
    } else if (Q_streq(type, "laser")) {
        B_CheckBuildingTypeStatus(base, B_DEFENCE_LASER, B_STATUS_WORKING, &count);
        base->numActiveLasers = std::min(count, base->numLasers);
    } else {
        cgi->Com_Printf("BDEF_UpdateActiveBattery_f: base defence type %s doesn't exist.\n", type);
        return;
    }
}

static void BDEF_ChangeAutoFire (void)
{
    installation_t* installation = INS_GetCurrentSelectedInstallation();
    base_t* base = B_GetCurrentSelectedBase();
    int i;

    if (!base && !installation)
        return;
    if (base && installation)
        return;
    if (cgi->Cmd_Argc() < 2)
        return;

    if (base) {
        for (i = 0; i < base->numBatteries; i++)
            BDEF_SetAutoFire(&base->batteries[i], atoi(cgi->Cmd_Argv(1)));
        for (i = 0; i < base->numLasers; i++)
            BDEF_SetAutoFire(&base->lasers[i], atoi(cgi->Cmd_Argv(1)));
    } else if (installation) {
        for (i = 0; i < installation->numBatteries; i++)
            BDEF_SetAutoFire(&installation->batteries[i], atoi(cgi->Cmd_Argv(1)));
    }
}

static const cmdList_t baseDefenseCmds[] = {
    {"add_battery", BDEF_AddBattery_f, "Add a new battery to base"},
    {"remove_battery", BDEF_RemoveBattery_f, "Remove a battery from base"},
    {"basedef_updatemenu", BDEF_BaseDefenceMenuUpdate_f, "Inits base defence menu"},
    {"basedef_selectitem", BDEF_SelectItem_f, nullptr},
    {"basedef_additem", BDEF_AddItem_f, "Add item to slot"},
    {"basedef_removeitem", BDEF_RemoveItem_f, "Remove item from slot"},
    {"basedef_autofire", BDEF_ChangeAutoFire, "Change autofire option for selected defence system"},
    {"basedef_updatebatteries", BDEF_UpdateActiveBattery_f, "Updates the active defence systems counters"},
    {nullptr, nullptr, nullptr}
};
void BDEF_InitCallbacks (void)
{
    cgi->Cmd_TableAddList(baseDefenseCmds);
}

void BDEF_ShutdownCallbacks (void)
{
    cgi->Cmd_TableRemoveList(baseDefenseCmds);
}