cp_missions.h

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.

*/

#pragma once

#include "../../DateTime.h"
#include "cp_campaign.h"

extern const int MAX_POS_LOOP;

typedef enum missionStage_s {
    STAGE_NOT_ACTIVE,               
    STAGE_COME_FROM_ORBIT,          
    STAGE_RECON_AIR,                
    STAGE_MISSION_GOTO,             
    STAGE_RECON_GROUND,             
    STAGE_TERROR_MISSION,           
    STAGE_BUILD_BASE,               
    STAGE_BASE_ATTACK,              
    STAGE_SUBVERT_GOV,              
    STAGE_SUPPLY,                   
    STAGE_SPREAD_XVI,               
    STAGE_INTERCEPT,                
    STAGE_BASE_DISCOVERED,          
    STAGE_HARVEST,                  
    STAGE_RETURN_TO_ORBIT,          
    STAGE_OVER                      
} missionStage_t;

typedef enum {
    WON, DRAW, LOST
} missionState_t;

typedef struct missionResults_s {
    const struct mission_s* mission;
    missionState_t state;
    bool recovery;      
    bool crashsite;     
    ufoType_t ufotype;      
    float ufoCondition;     
    int itemTypes;          
    int itemAmount;         
    int aliensKilled;
    int aliensStunned;
    int aliensSurvived;
    int ownKilled;
    int ownStunned;
    int ownKilledFriendlyFire;
    int ownSurvived;
    int civiliansKilled;
    int civiliansKilledFriendlyFire;
    int civiliansSurvived;
} missionResults_t;

typedef struct mission_s {
    int idx;                
    char id[MAX_VAR];           
    mapDef_t* mapDef;           
    bool active;                
    union missionData_t {
        base_t* base;
        aircraft_t* aircraft;
        installation_t* installation;
        alienBase_t* alienBase;
        city_t* city;
    } data;                 
    interestCategory_t category;        
    missionStage_t stage;           
    int initialOverallInterest;     
    int initialIndividualInterest;      
    class DateTime startDate;           
    class DateTime finalDate;           
    vec2_t pos;             
    aircraft_t* ufo;            
    bool onGeoscape;            
    bool crashed;               
    char onwin[256];            
    char onlose[256];           
    bool posAssigned;           
    missionResults_t missionResults;
} mission_t;

#define MIS_Foreach(var) LIST_Foreach(ccs.missions, mission_t, var)

const char* MIS_GetName(const mission_t* mission);

void BATTLE_SetVars(const battleParam_t* battleParameters);
void CP_CreateBattleParameters(mission_t* mission, battleParam_t* param, const aircraft_t* aircraft);
void BATTLE_Start(mission_t* mission, const battleParam_t* battleParameters);
mission_t* CP_GetMissionByIDSilent(const char* missionId);
mission_t* CP_GetMissionByID(const char* missionId);
int MIS_GetIdx(const mission_t* mis);
mission_t* MIS_GetByIdx(int id);
mission_t* CP_CreateNewMission(interestCategory_t category, bool beginNow);
void CP_UFOProceedMission(const struct campaign_s* campaign, struct aircraft_s* ufocraft);
void CP_MissionRemove(mission_t* mission);
bool CP_MissionBegin(mission_t* mission);
bool CP_CheckNewMissionDetectedOnGeoscape(void);
bool CP_CheckMissionLimitedInTime(const mission_t* mission);
void CP_MissionDisableTimeLimit(mission_t* mission);
void CP_MissionNotifyBaseDestroyed(const base_t* base);
void CP_MissionNotifyInstallationDestroyed(const installation_t* installation);
const char* MIS_GetModel(const mission_t* mission);
void CP_MissionRemoveFromGeoscape(mission_t* mission);
void CP_MissionAddToGeoscape(mission_t* mission, bool force);
void CP_UFORemoveFromGeoscape(mission_t* mission, bool destroyed);
void CP_SpawnCrashSiteMission(aircraft_t* ufo);
void CP_SpawnRescueMission(aircraft_t* aircraft, aircraft_t* ufo);
ufoType_t CP_MissionChooseUFO(const mission_t* mission);
void CP_MissionStageEnd(const campaign_t* campaign, mission_t* mission);
void CP_InitializeSpawningDelay(void);
void CP_SpawnNewMissions(void);
void CP_MissionIsOver(mission_t* mission);
void CP_MissionIsOverByUFO(aircraft_t* ufocraft);
void CP_MissionEnd(const campaign_t* campaign, mission_t* mission, const battleParam_t* battleParameters, bool won);
void CP_MissionEndActions(mission_t* mission, aircraft_t* aircraft, bool won);
bool CP_ChooseMap(mission_t* mission, const vec2_t pos);
bool CP_CheckNextStageDestination(const struct campaign_s* campaign, struct aircraft_s* ufo);
int CP_CountMissionOnGeoscape(void);
void CP_UpdateMissionVisibleOnGeoscape(void);

void MIS_InitStartup(void);
void MIS_Shutdown(void);