cp_market.cpp

Go to the documentation of this file.

/*
Copyright (C) 2002-2023 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 "../../DateTime.h"
#include "../../cl_shared.h"
#include "cp_campaign.h"
#include "cp_market.h"
#include "cp_popup.h"
#include "save/save_market.h"

#define BID_FACTOR 0.9

#define BS_GetMarket() (&ccs.eMarket)

bool BS_IsOnMarket (const objDef_t* item)
{
    assert(item);
    return !(item->isVirtual || item->notOnMarket);
}

int BS_GetItemOnMarket (const objDef_t* od)
{
    const market_t* market = BS_GetMarket();
    return BS_IsOnMarket(od) ? market->numItems[od->idx] : 0;
}

void BS_AddItemToMarket (const objDef_t* od, int amount)
{
    market_t* market = BS_GetMarket();
    assert(amount >= 0);
    market->numItems[od->idx] += amount;
}

static void BS_RemoveItemFromMarket (const objDef_t* od, int amount)
{
    market_t* market = BS_GetMarket();

    assert(amount >= 0);

    market->numItems[od->idx] = std::max(market->numItems[od->idx] - amount, 0);
}

int BS_GetItemSellingPrice (const objDef_t* od)
{
    const market_t* market = BS_GetMarket();
    return market->bidItems[od->idx];
}

int BS_GetItemBuyingPrice (const objDef_t* od)
{
    const market_t* market = BS_GetMarket();
    return market->askItems[od->idx];
}

bool BS_AircraftIsOnMarket (const aircraft_t* aircraft)
{
    if (AIR_IsUFO(aircraft))
        return false;
    if (aircraft->price == -1)
        return false;

    return  true;
}

int BS_GetAircraftOnMarket (const aircraft_t* aircraft)
{
    const humanAircraftType_t type = cgi->Com_DropShipShortNameToID(aircraft->id);
    const market_t* market = BS_GetMarket();

    return BS_AircraftIsOnMarket(aircraft) ? market->numAircraft[type] : 0;
}

static void BS_AddAircraftToMarket (const aircraft_t* aircraft, int amount)
{
    const humanAircraftType_t type = cgi->Com_DropShipShortNameToID(aircraft->id);
    market_t* market = BS_GetMarket();
    assert(amount >= 0);
    assert(!AIR_IsUFO(aircraft));
    market->numAircraft[type] += amount;
}

static void BS_RemoveAircraftFromMarket (const aircraft_t* aircraft, int amount)
{
    const humanAircraftType_t type = cgi->Com_DropShipShortNameToID(aircraft->id);
    market_t* market = BS_GetMarket();

    assert(amount >= 0);
    assert(!AIR_IsUFO(aircraft));

    market->numAircraft[type] = std::max(market->numAircraft[type] - amount, 0);
}

int BS_GetAircraftSellingPrice (const aircraft_t* aircraft)
{
    const humanAircraftType_t type = cgi->Com_DropShipShortNameToID(aircraft->id);
    const market_t* market = BS_GetMarket();
    int sellPrice = market->bidAircraft[type];

    assert(!AIR_IsUFO(aircraft));

    if (aircraft->tpl != aircraft) {
        int i;

        if (aircraft->stats[AIR_STATS_DAMAGE] > 0)
            sellPrice *= (float)aircraft->damage / aircraft->stats[AIR_STATS_DAMAGE];

        if (aircraft->shield.item)
            sellPrice += BS_GetItemSellingPrice(aircraft->shield.item);
        if (aircraft->shield.ammo)
            sellPrice += BS_GetItemSellingPrice(aircraft->shield.ammo);

        for (i = 0; i < aircraft->maxWeapons; i++) {
            if (aircraft->weapons[i].item)
                sellPrice += BS_GetItemSellingPrice(aircraft->weapons[i].item);
            if (aircraft->weapons[i].ammo)
                sellPrice += BS_GetItemSellingPrice(aircraft->weapons[i].ammo);
        }

        for (i = 0; i < aircraft->maxElectronics; i++) {
            if (aircraft->electronics[i].item)
                sellPrice += BS_GetItemSellingPrice(aircraft->electronics[i].item);
            if (aircraft->electronics[i].ammo)
                sellPrice += BS_GetItemSellingPrice(aircraft->electronics[i].ammo);
        }
    }
    return sellPrice;
}

int BS_GetAircraftBuyingPrice (const aircraft_t* aircraft)
{
    const humanAircraftType_t type = cgi->Com_DropShipShortNameToID(aircraft->id);
    const market_t* market = BS_GetMarket();
    assert(!AIR_IsUFO(aircraft));
    return market->askAircraft[type];
}

static void BS_ProcessCraftItemSale (const objDef_t* craftitem, const int numItems)
{
    if (craftitem) {
        BS_AddItemToMarket(craftitem, numItems);
        CP_UpdateCredits(ccs.credits + BS_GetItemSellingPrice(craftitem) * numItems);
    }
}

bool BS_BuyAircraft (const aircraft_t* aircraftTemplate, base_t* base)
{
    if (!base)
        cgi->Com_Error(ERR_DROP, "BS_BuyAircraft: No base given.");
    if (!aircraftTemplate)
        cgi->Com_Error(ERR_DROP, "BS_BuyAircraft: No aircraft template given.");

    const int amount = BS_GetAircraftOnMarket(aircraftTemplate);
    if (amount <= 0)
        return false;

    const int price = BS_GetAircraftBuyingPrice(aircraftTemplate);
    if (ccs.credits < price)
        return false;

    /* Hangar capacities are being updated in AIR_NewAircraft().*/
    BS_RemoveAircraftFromMarket(aircraftTemplate, 1);
    CP_UpdateCredits(ccs.credits - price);
    AIR_NewAircraft(base, aircraftTemplate);

    return true;
}

bool BS_SellAircraft (aircraft_t* aircraft)
{
    int j;

    if (AIR_GetTeamSize(aircraft) > 0)
        return false;

    if (!AIR_IsAircraftInBase(aircraft))
        return false;

    /* sell off any items which are mounted on it */
    for (j = 0; j < aircraft->maxWeapons; j++) {
        const aircraftSlot_t* slot = &aircraft->weapons[j];
        BS_ProcessCraftItemSale(slot->item, 1);
        BS_ProcessCraftItemSale(slot->ammo, 1);
    }

    BS_ProcessCraftItemSale(aircraft->shield.item, 1);
    /* there should be no ammo here, but checking can't hurt */
    BS_ProcessCraftItemSale(aircraft->shield.ammo, 1);

    for (j = 0; j < aircraft->maxElectronics; j++) {
        const aircraftSlot_t* slot = &aircraft->electronics[j];
        BS_ProcessCraftItemSale(slot->item, 1);
        /* there should be no ammo here, but checking can't hurt */
        BS_ProcessCraftItemSale(slot->ammo, 1);
    }

    /* the capacities are also updated here */
    BS_AddAircraftToMarket(aircraft, 1);
    CP_UpdateCredits(ccs.credits + BS_GetAircraftSellingPrice(aircraft));
    AIR_DeleteAircraft(aircraft);

    return true;
}

bool BS_BuyUGV (const ugv_t* ugv, base_t* base)
{
    const objDef_t* ugvWeapon;

    if (!ugv)
        cgi->Com_Error(ERR_DROP, "BS_BuyUGV: Called on nullptr UGV!");
    if (!base)
        cgi->Com_Error(ERR_DROP, "BS_BuyUGV: Called on nullptr base!");
    ugvWeapon = INVSH_GetItemByID(ugv->weapon);
    if (!ugvWeapon)
        cgi->Com_Error(ERR_DROP, "BS_BuyItem_f: Could not get weapon '%s' for ugv/tank '%s'.", ugv->weapon, ugv->id);

    if (ccs.credits < ugv->price)
        return false;
    if (E_CountUnhiredRobotsByType(ugv) <= 0)
        return false;
    if (BS_GetItemOnMarket(ugvWeapon) <= 0)
        return false;
    if (CAP_GetFreeCapacity(base, CAP_ITEMS) < UGV_SIZE + ugvWeapon->size)
        return false;
    if (!E_HireRobot(base, ugv))
        return false;

    BS_RemoveItemFromMarket(ugvWeapon, 1);
    CP_UpdateCredits(ccs.credits - ugv->price);
    B_AddToStorage(base, ugvWeapon, 1);

    return true;
}

bool BS_SellUGV (Employee* robot)
{
    const objDef_t* ugvWeapon;
    const ugv_t* ugv;
    base_t* base;

    if (!robot)
        cgi->Com_Error(ERR_DROP, "Selling nullptr UGV!");
    if (!robot->getUGV())
        cgi->Com_Error(ERR_DROP, "Selling invalid UGV with UCN: %i", robot->chr.ucn);
    ugv = robot->getUGV();
    base = robot->baseHired;

    /* Check if we have a weapon for this ugv in the market to sell it. */
    ugvWeapon = INVSH_GetItemByID(ugv->weapon);
    if (!ugvWeapon)
        cgi->Com_Error(ERR_DROP, "BS_BuyItem_f: Could not get wepaon '%s' for ugv/tank '%s'.", ugv->weapon, ugv->id);

    if (!robot->unhire()) {
        cgi->Com_DPrintf(DEBUG_CLIENT, "Couldn't sell/fire robot/ugv.\n");
        return false;
    }

    BS_AddItemToMarket(ugvWeapon, 1);
    CP_UpdateCredits(ccs.credits + ugv->price);
    B_AddToStorage(base, ugvWeapon, -1);

    return true;
}

bool BS_BuyItem (const objDef_t* od, base_t* base, int count)
{
    if (!od)
        cgi->Com_Error(ERR_DROP, "BS_BuyItem: Called on nullptr objDef!");
    if (!base)
        cgi->Com_Error(ERR_DROP, "BS_BuyItem: Called on nullptr base!");

    if (count <= 0)
        return false;
    if (!BS_IsOnMarket(od))
        return false;
    if (ccs.credits < BS_GetItemBuyingPrice(od) * count)
        return false;
    if (BS_GetItemOnMarket(od) < count)
        return false;
    if (CAP_GetFreeCapacity(base, CAP_ITEMS) < od->size * count)
        return false;

    B_AddToStorage(base, od, count);
    BS_RemoveItemFromMarket(od, count);
    CP_UpdateCredits(ccs.credits - BS_GetItemBuyingPrice(od) * count);

    return true;
}

bool BS_SellItem (const objDef_t* od, base_t* base, int count)
{
    if (!od)
        cgi->Com_Error(ERR_DROP, "BS_SellItem: Called on nullptr objDef!");

    if (count <= 0)
        return false;
    if (!BS_IsOnMarket(od))
        return false;

    if (base) {
        if (B_ItemInBase(od, base) < count)
            return false;
        B_AddToStorage(base, od, -count);
    }

    BS_AddItemToMarket(od, count);
    CP_UpdateCredits(ccs.credits + BS_GetItemSellingPrice(od) * count);

    return true;
}

bool BS_SaveXML (xmlNode_t* parent)
{
    int i;
    xmlNode_t* node;
    const market_t* market = BS_GetMarket();

    /* store market */
    node = cgi->XML_AddNode(parent, SAVE_MARKET_MARKET);
    for (i = 0; i < cgi->csi->numODs; i++) {
        const objDef_t* od = INVSH_GetItemByIDX(i);
        if (BS_IsOnMarket(od)) {
            xmlNode_t* snode = cgi->XML_AddNode(node, SAVE_MARKET_ITEM);
            cgi->XML_AddString(snode, SAVE_MARKET_ID, od->id);
            cgi->XML_AddIntValue(snode, SAVE_MARKET_NUM, market->numItems[i]);
            cgi->XML_AddIntValue(snode, SAVE_MARKET_BID, market->bidItems[i]);
            cgi->XML_AddIntValue(snode, SAVE_MARKET_ASK, market->askItems[i]);
            cgi->XML_AddDoubleValue(snode, SAVE_MARKET_EVO, market->currentEvolutionItems[i]);
            cgi->XML_AddBoolValue(snode, SAVE_MARKET_AUTOSELL, market->autosell[i]);
        }
    }
    const int maxAircraft = cgi->Com_GetHumanAircraftIdsNum();
    for (i = 0; i < maxAircraft; i++) {
        if (market->bidAircraft[i] > 0 || market->askAircraft[i] > 0) {
            xmlNode_t* snode = cgi->XML_AddNode(node, SAVE_MARKET_AIRCRAFT);
            const char* shortName = cgi->Com_DropShipTypeToShortName((humanAircraftType_t)i);
            cgi->XML_AddString(snode, SAVE_MARKET_ID, shortName);
            cgi->XML_AddIntValue(snode, SAVE_MARKET_NUM, market->numAircraft[i]);
            cgi->XML_AddIntValue(snode, SAVE_MARKET_BID, market->bidAircraft[i]);
            cgi->XML_AddIntValue(snode, SAVE_MARKET_ASK, market->askAircraft[i]);
            cgi->XML_AddDoubleValue(snode, SAVE_MARKET_EVO, market->currentEvolutionAircraft[i]);
        }
    }
    return true;
}

bool BS_LoadXML (xmlNode_t* parent)
{
    xmlNode_t* node, *snode;
    market_t* market = BS_GetMarket();

    node = cgi->XML_GetNode(parent, SAVE_MARKET_MARKET);
    if (!node)
        return false;

    for (snode = cgi->XML_GetNode(node, SAVE_MARKET_ITEM); snode; snode = cgi->XML_GetNextNode(snode, node, SAVE_MARKET_ITEM)) {
        const char* s = cgi->XML_GetString(snode, SAVE_MARKET_ID);
        const objDef_t* od = INVSH_GetItemByID(s);

        if (!od) {
            cgi->Com_Printf("BS_LoadXML: Could not find item '%s'\n", s);
            continue;
        }

        market->numItems[od->idx] = cgi->XML_GetInt(snode, SAVE_MARKET_NUM, 0);
        market->bidItems[od->idx] = cgi->XML_GetInt(snode, SAVE_MARKET_BID, 0);
        market->askItems[od->idx] = cgi->XML_GetInt(snode, SAVE_MARKET_ASK, 0);
        market->currentEvolutionItems[od->idx] = cgi->XML_GetDouble(snode, SAVE_MARKET_EVO, 0.0);
        market->autosell[od->idx] = cgi->XML_GetBool(snode, SAVE_MARKET_AUTOSELL, false);
    }
    for (snode = cgi->XML_GetNode(node, SAVE_MARKET_AIRCRAFT); snode; snode = cgi->XML_GetNextNode(snode, node, SAVE_MARKET_AIRCRAFT)) {
        const char* s = cgi->XML_GetString(snode, SAVE_MARKET_ID);
        const humanAircraftType_t type = cgi->Com_DropShipShortNameToID(s);

        market->numAircraft[type] = cgi->XML_GetInt(snode, SAVE_MARKET_NUM, 0);
        market->bidAircraft[type] = cgi->XML_GetInt(snode, SAVE_MARKET_BID, 0);
        market->askAircraft[type] = cgi->XML_GetInt(snode, SAVE_MARKET_ASK, 0);
        market->currentEvolutionAircraft[type] = cgi->XML_GetDouble(snode, SAVE_MARKET_EVO, 0.0);
    }

    return true;
}

void BS_InitMarket (const campaign_t* campaign)
{
    int i;
    market_t* market = BS_GetMarket();

    for (i = 0; i < cgi->csi->numODs; i++) {
        const objDef_t* od = INVSH_GetItemByIDX(i);
        if (market->askItems[i] == 0) {
            market->askItems[i] = od->price;
            market->bidItems[i] = floor(market->askItems[i] * BID_FACTOR);
        }

        if (campaign->marketDef->numItems[i] <= 0)
            continue;

        if (RS_IsResearched_ptr(RS_GetTechForItem(od))) {
            /* the other relevant values were already set above */
            market->numItems[i] = campaign->marketDef->numItems[i];
        } else {
            cgi->Com_Printf("BS_InitMarket: Could not add item %s to the market - not marked as researched in campaign %s\n",
                    od->id, campaign->id);
        }
    }

    const int maxAircraft = cgi->Com_GetHumanAircraftIdsNum();
    for (i = 0; i < maxAircraft; i++) {
        const char* name = cgi->Com_DropShipTypeToShortName((humanAircraftType_t)i);
        const aircraft_t* aircraft = AIR_GetAircraft(name);
        if (market->askAircraft[i] == 0) {
            market->askAircraft[i] = aircraft->price;
            market->bidAircraft[i] = floor(market->askAircraft[i] * BID_FACTOR);
        }

        if (campaign->marketDef->numAircraft[i] <= 0)
            continue;

        if (RS_IsResearched_ptr(aircraft->tech)) {
            /* the other relevant values were already set above */
            market->numAircraft[i] = campaign->marketDef->numAircraft[i];
        } else {
            cgi->Com_Printf("BS_InitMarket: Could not add aircraft %s to the market - not marked as researched in campaign %s\n",
                    aircraft->id, campaign->id);
        }
    }
}

void CP_CampaignRunMarket (campaign_t* campaign)
{
    int i;
    const float TYPICAL_TIME = 10.f;            
    const int RESEARCH_LIMIT_DELAY = 30;        
    market_t* market = BS_GetMarket();

    assert(campaign->marketDef);
    assert(campaign->asymptoticMarketDef);

    for (i = 0; i < cgi->csi->numODs; i++) {
        const objDef_t* od = INVSH_GetItemByIDX(i);
        const technology_t* tech = RS_GetTechForItem(od);
        int asymptoticNumber;

        if (RS_IsResearched_ptr(tech) && (campaign->marketDef->numItems[i] != 0 || ccs.date.getDateAsDays() > tech->researchedDate.getDateAsDays() + RESEARCH_LIMIT_DELAY)) {
            /* if items are researched for more than RESEARCH_LIMIT_DELAY or was on the initial market,
             * there number tend to the value defined in equipment.ufo.
             * This value is the asymptotic value if it is not 0, or initial value else */
            asymptoticNumber = campaign->asymptoticMarketDef->numItems[i] ? campaign->asymptoticMarketDef->numItems[i] : campaign->marketDef->numItems[i];
        } else {
            /* items that have just been researched don't appear on market, but they can disappear */
            asymptoticNumber = 0;
        }

        /* Store the evolution of the market in currentEvolution */
        market->currentEvolutionItems[i] += (asymptoticNumber - market->numItems[i]) / TYPICAL_TIME;

        /* Check if new items appeared or disappeared on market */
        if (fabs(market->currentEvolutionItems[i]) >= 1.0f) {
            const int num = (int)(market->currentEvolutionItems[i]);
            if (num >= 0)
                BS_AddItemToMarket(od, num);
            else
                BS_RemoveItemFromMarket(od, -num);
            market->currentEvolutionItems[i] -= num;
        }
    }

    const int maxAircraft = cgi->Com_GetHumanAircraftIdsNum();
    for (i = 0; i < maxAircraft; i++) {
        const humanAircraftType_t type = (humanAircraftType_t)i;
        const char* aircraftID = cgi->Com_DropShipTypeToShortName(type);
        const aircraft_t* aircraft = AIR_GetAircraft(aircraftID);
        const technology_t* tech = aircraft->tech;
        int asymptoticNumber;

        if (RS_IsResearched_ptr(tech) && (campaign->marketDef->numAircraft[i] != 0 || ccs.date.getDateAsDays() > tech->researchedDate.getDateAsDays() + RESEARCH_LIMIT_DELAY)) {
            /* if aircraft is researched for more than RESEARCH_LIMIT_DELAY or was on the initial market,
             * there number tend to the value defined in equipment.ufo.
             * This value is the asymptotic value if it is not 0, or initial value else */
            asymptoticNumber = campaign->asymptoticMarketDef->numAircraft[i] ? campaign->asymptoticMarketDef->numAircraft[i] : campaign->marketDef->numAircraft[i];
        } else {
            /* items that have just been researched don't appear on market, but they can disappear */
            asymptoticNumber = 0;
        }
        /* Store the evolution of the market in currentEvolution */
        market->currentEvolutionAircraft[i] += (asymptoticNumber - market->numAircraft[i]) / TYPICAL_TIME;

        /* Check if new items appeared or disappeared on market */
        if (fabs(market->currentEvolutionAircraft[i]) >= 1.0f) {
            const int num = (int)(market->currentEvolutionAircraft[i]);
            if (num >= 0)
                BS_AddAircraftToMarket(aircraft, num);
            else
                BS_RemoveAircraftFromMarket(aircraft, -num);
            market->currentEvolutionAircraft[i] -= num;
        }
    }
}

bool BS_BuySellAllowed (const base_t* base)
{
    return !B_IsUnderAttack(base) && B_GetBuildingStatus(base, B_STORAGE);
}