cp_cgame_callbacks.cpp

Go to the documentation of this file.

 
/*
Copyright (C) 2002-2025 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 "../../input/cl_keys.h"
#include "../../ui/ui_dataids.h"
#include "cp_cgame_callbacks.h"
#include "cp_campaign.h"
#include "cp_character.h"
#include "cp_missions.h"
#include "cp_mission_triggers.h"
#include "cp_team.h"
#include "cp_geoscape.h"
#include "../../battlescape/cl_hud.h"
#include "cp_mission_callbacks.h"
#include "cp_save_callbacks.h"
#include "cp_base_callbacks.h"
 
const cgame_import_t* cgi;

static void GAME_CP_Results_f (void)
{
    mission_t* mission = GEO_GetSelectedMission();
    battleParam_t* bp = &ccs.battleParameters;
 
    if (!mission)
        return;
 
    if (cgi->Cmd_Argc() < 2) {
        cgi->Com_Printf("Usage: %s <won:true|false> [retry:true|false]\n", cgi->Cmd_Argv(0));
        return;
    }
 
    /* check for retry */
    if (cgi->Cmd_Argc() >= 3 && cgi->Com_ParseBoolean(cgi->Cmd_Argv(2))) {
        if (bp->retriable) {
            /* don't collect things and update stats --- we retry the mission */
            CP_StartSelectedMission();
            return;
        } else {
            cgi->Com_Printf("Battle cannot be retried!\n");
        }
    }
 
    CP_MissionEnd(ccs.curCampaign, mission, bp, cgi->Com_ParseBoolean(cgi->Cmd_Argv(1)));
}

static inline const char* CP_ToDifficultyName (const int difficulty)
{
    switch (difficulty) {
    case -4:
        return _("Chicken-hearted");
    case -3:
        return _("Very Easy");
    case -2:
    case -1:
        return _("Easy");
    case 0:
        return _("Normal");
    case 1:
    case 2:
        return _("Hard");
    case 3:
        return _("Very Hard");
    case 4:
        return _("Insane");
    default:
        cgi->Com_Error(ERR_DROP, "Unknown difficulty id %i", difficulty);
    }
}

static void GAME_CP_GetCampaigns_f (void)
{
    cgi->UI_ExecuteConfunc("ui_clear_campaigns");
    for (int i = 0; i < ccs.numCampaigns; i++) {
        const campaign_t* c = &ccs.campaigns[i];
        if (c->visible)
            cgi->UI_ExecuteConfunc("ui_add_campaign %s \"%s\" \"%s\"", c->id, c->name, c->defaultCampaign ? "default" : "");
    }
}
 
#define MAXCAMPAIGNTEXT 4096
static char campaignDesc[MAXCAMPAIGNTEXT];
static void GAME_CP_CampaignDescription_f (void)
{
    const char* racetype;
    const campaign_t* campaign;
 
    if (cgi->Cmd_Argc() < 2 || Q_streq(cgi->Cmd_Argv(1), "")) {
        if (ccs.numCampaigns > 0)
            campaign = &ccs.campaigns[0];
        else
            campaign = nullptr;
    } else {
        campaign = CP_GetCampaign(cgi->Cmd_Argv(1));
    }
 
    if (!campaign) {
        cgi->Com_Printf("Invalid Campaign id: %s\n", cgi->Cmd_Argv(1));
        return;
    }
 
    if (campaign->team == TEAM_PHALANX)
        racetype = _("Human");
    else
        racetype = _("Aliens");
 
    const char* text = cgi->CL_Translate(campaign->text);
    Com_sprintf(campaignDesc, sizeof(campaignDesc), _("%s\n\nRace: %s\nRecruits: %i %s, %i %s, %i %s, %i %s\n"
        "Credits: %ic\nDifficulty: %s\n"
        "Min. happiness of nations: %i %%\n"
        "Max. allowed debts: %ic\n"
        "%s\n"), _(campaign->name), racetype,
        campaign->soldiers, ngettext("soldier", "soldiers", campaign->soldiers),
        campaign->scientists, ngettext("scientist", "scientists", campaign->scientists),
        campaign->workers, ngettext("worker", "workers", campaign->workers),
        campaign->pilots, ngettext("pilot", "pilots", campaign->pilots),
        campaign->credits, CP_ToDifficultyName(campaign->difficulty),
        (int)(round(campaign->minhappiness * 100.0f)), campaign->negativeCreditsUntilLost,
        text);
    cgi->UI_RegisterText(TEXT_STANDARD, campaignDesc);
}

static void GAME_CP_Start_f (void)
{
    campaign_t* campaign;
 
    campaign = CP_GetCampaign(cgi->Cmd_Argv(1));
    if (!campaign) {
        cgi->Com_Printf("Invalid Campaign id: %s\n", cgi->Cmd_Argv(1));
        return;
    }
 
    if (CP_IsRunning()) {
        cgi->Cmd_ExecuteString("game_exit");
        cgi->Cmd_ExecuteString("game_setmode campaign");
    }
    CP_CampaignInit(campaign, false);
 
    /* Intro sentences */
    cgi->Cbuf_AddText("seq_start intro\n");
}
 
static inline void AL_AddAlienTypeToAircraftCargo_ (void* data, const teamDef_t* teamDef, int amount, bool dead)
{
    AL_AddAlienTypeToAircraftCargo((aircraft_t*) data, teamDef, amount, dead);
}

void GAME_CP_Results (dbuffer* msg, int winner, int* numSpawned, int* numAlive, int numKilled[][MAX_TEAMS], int numStunned[][MAX_TEAMS], bool nextmap)
{
    int ownSurvived, ownKilled, ownStunned;
    int aliensSurvived, aliensKilled, aliensStunned;
    int civiliansSurvived, civiliansKilled, civiliansStunned;
    const int currentTeam = cgi->GAME_GetCurrentTeam();
    const bool won = (winner == currentTeam);
    const bool draw = (winner == -1 || winner == 0);
    aircraft_t* aircraft = GEO_GetMissionAircraft();
    battleParam_t* bp = &ccs.battleParameters;
 
    CHAR_ParseData(msg, &ccs.updateCharacters);
 
    ownSurvived = ownKilled = ownStunned = 0;
    aliensSurvived = aliensKilled = aliensStunned = 0;
    civiliansSurvived = civiliansKilled = civiliansStunned = 0;
 
    for (int i = 0; i <= MAX_TEAMS; i++) {
        if (i == currentTeam)
            ownSurvived = numAlive[i];
        else if (i == TEAM_CIVILIAN)
            civiliansSurvived = numAlive[i];
        else if (i < MAX_TEAMS)
            aliensSurvived += numAlive[i];
        for (int j = 0; j < MAX_TEAMS; j++)
            if (j == currentTeam) {
                ownKilled += numKilled[i][j];
                ownStunned += numStunned[i][j]++;
            } else if (j == TEAM_CIVILIAN) {
                civiliansKilled += numKilled[i][j];
                civiliansStunned += numStunned[i][j]++;
            } else {
                aliensKilled += numKilled[i][j];
                aliensStunned += numStunned[i][j]++;
            }
    }
    /* if we won, our stunned are alive */
    if (won) {
        ownSurvived += ownStunned;
        ownStunned = 0;
    } else {
        /* if we lost, they revive stunned */
        aliensStunned = 0;
    }
 
    /* we won, and we're not the dirty aliens */
    if (won)
        civiliansSurvived += civiliansStunned;
    else
        civiliansKilled += civiliansStunned;
 
    /* Collect items from the battlefield. */
    AII_CollectingItems(aircraft, won);
    if (won)
        /* Collect aliens from the battlefield. */
        cgi->CollectAliens(aircraft, AL_AddAlienTypeToAircraftCargo_);
 
    ccs.aliensKilled += aliensKilled;
 
    missionResults_t* results = &(bp->mission->missionResults);
    results->mission = bp->mission;
 
    if (nextmap) {
        assert(won || draw);
        results->aliensKilled += aliensKilled;
        results->aliensStunned += aliensStunned;
        results->aliensSurvived += aliensSurvived;
        results->ownKilled += ownKilled - numKilled[currentTeam][currentTeam] - numKilled[TEAM_CIVILIAN][currentTeam];
        results->ownStunned += ownStunned;
        results->ownKilledFriendlyFire += numKilled[currentTeam][currentTeam] + numKilled[TEAM_CIVILIAN][currentTeam];
        results->ownSurvived += ownSurvived;
        results->civiliansKilled += civiliansKilled;
        results->civiliansKilledFriendlyFire += numKilled[currentTeam][TEAM_CIVILIAN] + numKilled[TEAM_CIVILIAN][TEAM_CIVILIAN];
        results->civiliansSurvived += civiliansSurvived;
        return;
    }
 
    /* won mission cannot be retried */
    if (won)
        bp->retriable = false;
 
    if (won)
        results->state = WON;
    else if (draw)
        results->state = DRAW;
    else
        results->state = LOST;
    results->aliensKilled = aliensKilled;
    results->aliensStunned = aliensStunned;
    results->aliensSurvived = aliensSurvived;
    results->ownKilled = ownKilled - numKilled[currentTeam][currentTeam] - numKilled[TEAM_CIVILIAN][currentTeam];
    results->ownStunned = ownStunned;
    results->ownKilledFriendlyFire = numKilled[currentTeam][currentTeam] + numKilled[TEAM_CIVILIAN][currentTeam];
    results->ownSurvived = ownSurvived;
    results->civiliansKilled = civiliansKilled;
    results->civiliansKilledFriendlyFire = numKilled[currentTeam][TEAM_CIVILIAN] + numKilled[TEAM_CIVILIAN][TEAM_CIVILIAN];
    results->civiliansSurvived = civiliansSurvived;
 
    MIS_InitResultScreen(results);
    if (ccs.missionResultCallback) {
        ccs.missionResultCallback(results);
    }
 
    cgi->UI_InitStack("geoscape", "campaign_main");
 
    if (won)
        cgi->UI_PushWindow("won");
    else if (draw)
        cgi->UI_PushWindow("draw");
    else
        cgi->UI_PushWindow("lost");
 
    if (bp->retriable)
        cgi->UI_ExecuteConfunc("enable_retry");
 
    cgi->CL_Disconnect();
    cgi->SV_Shutdown("Mission end", false);
}
 
bool GAME_CP_Spawn (linkedList_t** chrList)
{
    aircraft_t* aircraft = GEO_GetMissionAircraft();
    if (!aircraft)
        return false;
 
    /* convert aircraft team to character list */
    LIST_Foreach(aircraft->acTeam, Employee, employee) {
        cgi->LIST_AddPointer(chrList, (void*)&employee->chr);
    }
 
    /* clean temp inventory */
    CP_CleanTempInventory(aircraft->homebase);
 
    return true;
}
 
bool GAME_CP_ItemIsUseable (const objDef_t* od)
{
    const technology_t* tech = RS_GetTechForItem(od);
    return RS_IsResearched_ptr(tech);
}

bool GAME_CP_TeamIsKnown (const teamDef_t* teamDef)
{
    if (!CHRSH_IsTeamDefAlien(teamDef))
        return true;
 
    if (!ccs.teamDefTechs[teamDef->idx])
        cgi->Com_Error(ERR_DROP, "Could not find tech for teamdef '%s'", teamDef->id);
 
    return RS_IsResearched_ptr(ccs.teamDefTechs[teamDef->idx]);
}

character_t* GAME_CP_GetSelectedChr (void)
{
    Employee* employee = E_GetEmployeeFromChrUCN(cgi->Cvar_GetInteger("mn_ucn"));
    if (employee)
        return &employee->chr;
    return nullptr;
}
 
void GAME_CP_Drop (void)
{
    cgi->UI_InitStack("geoscape", "campaign_main");
 
    cgi->SV_Shutdown("Mission end", false);
    cgi->CL_Disconnect();
}
 
void GAME_CP_Frame (float secondsSinceLastFrame)
{
    if (!CP_IsRunning())
        return;
 
    if (!CP_OnGeoscape())
        return;
 
    /* advance time */
    CP_CampaignRun(ccs.curCampaign, secondsSinceLastFrame);
}

void GAME_CP_DrawBaseLayoutTooltip (int baseIdx, int x, int y)
{
    const base_t* base = B_GetFoundedBaseByIDX(baseIdx);
    if (base == nullptr)
        return;
    cgi->UI_DrawTooltip(base->name, x, y, 250);
}
 
void GAME_CP_DrawBaseLayout (int baseIdx, int x1, int y1, int totalMarge, int w, int h, int padding, const vec4_t bgcolor, const vec4_t color)
{
    const base_t* base = B_GetBaseByIDX(baseIdx);
    if (base == nullptr)
        return;
    int y = y1 + padding;
    for (int row = 0; row < BASE_SIZE; row++) {
        int x = x1 + padding;
        for (int col = 0; col < BASE_SIZE; col++) {
            if (B_IsTileBlocked(base, col, row)) {
                cgi->UI_DrawFill(x, y, w, h, bgcolor);
            } else if (B_GetBuildingAt(base, col, row) != nullptr) {
                /* maybe destroyed in the meantime */
                if (base->founded)
                    cgi->UI_DrawFill(x, y, w, h, color);
            }
            x += w + padding;
        }
        y += h + padding;
    }
}
 
const char* GAME_CP_GetTeamDef (void)
{
    const int team = ccs.curCampaign->team;
    return cgi->Com_ValueToStr(&team, V_TEAM, 0);
}
 
void GAME_CP_InitMissionBriefing (const char** title, linkedList_t** victoryConditionsMsgIDs, linkedList_t** missionBriefingMsgIDs)
{
    const battleParam_t* bp = &ccs.battleParameters;
    const mission_t* mission = bp->mission;
    const mapDef_t* md = mission->mapDef;
    if (Q_strvalid(md->victoryCondition)) {
        cgi->LIST_AddString(victoryConditionsMsgIDs, md->victoryCondition);
    }
    if (mission->crashed) {
        cgi->LIST_AddString(missionBriefingMsgIDs, "*msgid:mission_briefing_crashsite");
    }
    if (Q_strvalid(md->missionBriefing)) {
        cgi->LIST_AddString(missionBriefingMsgIDs, md->missionBriefing);
    }
    if (Q_strvalid(md->description)) {
        *title = _(md->description);
    }
}

void GAME_CP_InitializeBattlescape (dbuffer* msg, const linkedList_t* team)
{
    const int teamSize = cgi->LIST_Count(team);
 
    cgi->NET_WriteByte(msg, clc_initactorstates);
    cgi->NET_WriteByte(msg, teamSize);
 
    LIST_Foreach(team, character_t, chr) {
        cgi->NET_WriteShort(msg, chr->ucn);
        cgi->NET_WriteShort(msg, chr->state);
        cgi->NET_WriteShort(msg, chr->RFmode.getHand());
        cgi->NET_WriteShort(msg, chr->RFmode.getFmIdx());
        cgi->NET_WriteShort(msg, chr->RFmode.getWeapon() != nullptr ? chr->RFmode.getWeapon()->idx : NONE);
    }
}
 
equipDef_t* GAME_CP_GetEquipmentDefinition (void)
{
    return &ccs.eMission;
}
 
void GAME_CP_CharacterCvars (const character_t* chr)
{
    /* Display rank if the character has one. */
    if (chr->score.rank >= 0) {
        const rank_t* rank = CL_GetRankByIdx(chr->score.rank);
        cgi->Cvar_Set("mn_chrrank", _("Rank: %s"), _(rank->name));
        cgi->Cvar_Set("mn_chrrank_img", "%s", rank->image);
        cgi->Cvar_Set("mn_chrrankprefix", "%s ", _(rank->shortname));
    } else {
        cgi->Cvar_Set("mn_chrrank_img", "");
        cgi->Cvar_Set("mn_chrrank", "");
        cgi->Cvar_Set("mn_chrrankprefix", "");
    }
 
    cgi->Cvar_Set("mn_chrmis", "%i", chr->score.assignedMissions);
    cgi->Cvar_Set("mn_chrkillalien", "%i", chr->score.kills[KILLED_ENEMIES]);
    cgi->Cvar_Set("mn_chrkillcivilian", "%i", chr->score.kills[KILLED_CIVILIANS]);
    cgi->Cvar_Set("mn_chrkillteam", "%i", chr->score.kills[KILLED_TEAM]);
}
 
const char* GAME_CP_GetItemModel (const char* string)
{
    const aircraft_t* aircraft = AIR_GetAircraftSilent(string);
    if (aircraft) {
        assert(aircraft->tech);
        return aircraft->tech->mdl;
    } else {
        const technology_t* tech = RS_GetTechByProvided(string);
        if (tech)
            return tech->mdl;
        return nullptr;
    }
}
 
static const cmdList_t cgameCallbacks[] = {
    {"cp_results", GAME_CP_Results_f, "Parses and shows the game results"},
    {"cp_getdescription", GAME_CP_CampaignDescription_f, nullptr},
    {"cp_getcampaigns", GAME_CP_GetCampaigns_f, "Fill the campaign list with available campaigns"},
    {"cp_start", GAME_CP_Start_f, "Start the new campaign"},
    {nullptr, nullptr, nullptr}
};
 
void GAME_CP_InitStartup (void)
{
#ifndef HARD_LINKED_CGAME
    INVSH_InitCSI(cgi->csi);
#endif
    cgi->Cmd_TableAddList(cgameCallbacks);
 
    CP_InitStartup();
 
    /* cvars might have been changed by other gametypes */
    cgi->Cvar_ForceSet("sv_maxclients", "1");
    cgi->Cvar_ForceSet("sv_ai", "1");
 
    /* reset campaign data */
    CP_ResetCampaignData();
    CP_ParseCampaignData();
 
    SAV_InitCallbacks();
}
 
void GAME_CP_Shutdown (void)
{
    SAV_ShutdownCallbacks();
    cgi->Cmd_TableRemoveList(cgameCallbacks);
 
    CP_Shutdown();
 
    CP_ResetCampaignData();
 
    cgi->SV_Shutdown("Quitting server.", false);
}