cp_campaign.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2010 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.

*/

#ifndef CLIENT_CL_CAMPAIGN_H
#define CLIENT_CL_CAMPAIGN_H

extern memPool_t *cp_campaignPool;

struct aircraft_s;
struct installation_s;
struct employee_s;
struct ugv_s;
struct uiNode_s; 
#define MAX_CAMPAIGNS   16

#define MAX_ASSEMBLIES  16

#define BYTES_NONE  0xFF

#include "cp_rank.h"
#include "cp_save.h"
#include "cp_parse.h"
#include "cp_event.h"
#include "cp_ufopedia.h"
#include "cp_research.h"
#include "cp_radar.h"
#include "cp_aircraft.h"
#include "cp_base.h"
#include "cp_employee.h"
#include "cp_transfer.h"
#include "cp_nation.h"
#include "cp_installation.h"
#include "cp_produce.h"
#include "cp_uforecovery.h"
#include "cp_airfight.h"
#include "cp_messageoptions.h"
#include "cp_alienbase.h"
#include "cp_market.h"
#include "cp_statistics.h"

/* check for water */
/* blue value is 64 */
#define MapIsWater(color)        (color[0] ==   0 && color[1] ==   0 && color[2] ==  64)

/* terrain types */
#define MapIsArctic(color)       (color[0] == 128 && color[1] == 255 && color[2] == 255)
#define MapIsDesert(color)       (color[0] == 255 && color[1] == 128 && color[2] ==   0)
#define MapIsMountain(color)     (color[0] == 255 && color[1] ==   0 && color[2] ==   0)
#define MapIsTropical(color)     (color[0] == 128 && color[1] == 128 && color[2] == 255)
#define MapIsGrass(color)        (color[0] == 128 && color[1] == 255 && color[2] ==   0)
#define MapIsWasted(color)       (color[0] == 128 && color[1] ==   0 && color[2] == 128)
#define MapIsCold(color)         (color[0] ==   0 && color[1] ==   0 && color[2] == 255)

/* culture types */
#define MapIsWestern(color)      (color[0] == 128 && color[1] == 255 && color[2] == 255)
#define MapIsEastern(color)      (color[0] == 255 && color[1] == 128 && color[2] ==   0)
#define MapIsOriental(color)     (color[0] == 255 && color[1] ==   0 && color[2] ==   0)
#define MapIsAfrican(color)      (color[0] == 128 && color[1] == 128 && color[2] == 255)

/* population types */
#define MapIsUrban(color)        (color[0] == 128 && color[1] == 255 && color[2] == 255)
#define MapIsSuburban(color)     (color[0] == 255 && color[1] == 128 && color[2] ==   0)
#define MapIsVillage(color)      (color[0] == 255 && color[1] ==   0 && color[2] ==   0)
#define MapIsRural(color)        (color[0] == 128 && color[1] == 128 && color[2] == 255)
#define MapIsNopopulation(color) (color[0] == 128 && color[1] == 255 && color[2] ==   0)

/* RASTER enables a better performance for CP_GetRandomPosOnGeoscapeWithParameters set it to 1-6
 * the higher the value the better the performance, but the smaller the coverage */
#define RASTER 2

/* nation happiness constants */
#define HAPPINESS_SUBVERSION_LOSS           -0.15
#define HAPPINESS_ALIEN_MISSION_LOSS        -0.02
#define HAPPINESS_UFO_SALE_GAIN             0.02
#define HAPPINESS_UFO_SALE_LOSS             0.005
#define HAPPINESS_MAX_MISSION_IMPACT        0.07

/* Maximum alien groups per alien team category */
#define MAX_ALIEN_GROUP_PER_CATEGORY    4
/* Maximum alien team category defined in scripts */
#define ALIENCATEGORY_MAX   8
#define BID_FACTOR 0.9
#define MAX_PROJECTILESONGEOSCAPE 32

#define HOURS_PER_ONE_INTEREST              22

#define INITIAL_OVERALL_INTEREST            20
#define FINAL_OVERALL_INTEREST              1000

#define DELAY_BETWEEN_MISSION_SPAWNING      4

#define MINIMUM_MISSIONS_PER_CYCLE          5
#define MAXIMUM_MISSIONS_PER_CYCLE          40

#define NON_OCCURRENCE_PROBABILITY          0.65

typedef enum mapType_s {
    MAPTYPE_TERRAIN,
    MAPTYPE_CULTURE,
    MAPTYPE_POPULATION,
    MAPTYPE_NATIONS,

    MAPTYPE_MAX
} mapType_t;

typedef enum missionDetectionStatus_s {
    MISDET_CANT_BE_DETECTED,        
    MISDET_ALWAYS_DETECTED,         
    MISDET_MAY_BE_DETECTED          
} missionDetectionStatus_t;

typedef enum interestCategory_s {
    INTERESTCATEGORY_NONE,          
    INTERESTCATEGORY_RECON,         
    INTERESTCATEGORY_TERROR_ATTACK, 
    INTERESTCATEGORY_BASE_ATTACK,   
    INTERESTCATEGORY_BUILDING,      
    INTERESTCATEGORY_SUPPLY,        
    INTERESTCATEGORY_XVI,           
    INTERESTCATEGORY_INTERCEPT,     
    INTERESTCATEGORY_HARVEST,       
    INTERESTCATEGORY_ALIENBASE,     
    INTERESTCATEGORY_RESCUE,

    INTERESTCATEGORY_MAX
} interestCategory_t;

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 struct alienTeamGroup_s {
    int idx;            
    int categoryIdx;    
    int minInterest;    
    int maxInterest;    
    teamDef_t *alienTeams[MAX_TEAMS_PER_MISSION];   
    int numAlienTeams;      
} alienTeamGroup_t;

typedef struct alienTeamCategory_s {
    char id[MAX_VAR];           
    interestCategory_t missionCategories[INTERESTCATEGORY_MAX];     
    int numMissionCategories;                   
    linkedList_t *equipment;        
    alienTeamGroup_t alienTeamGroups[MAX_ALIEN_GROUP_PER_CATEGORY];     
    int numAlienTeamGroups;     
} alienTeamCategory_t;

typedef struct mission_s {
    int idx;                        
    char id[MAX_VAR];               
    mapDef_t* mapDef;               
    qboolean active;                
    void* data;                     
    char location[MAX_VAR];         
    interestCategory_t category;    
    missionStage_t stage;           
    int initialOverallInterest;     
    int initialIndividualInterest;  
    date_t startDate;               
    date_t finalDate;               
    vec2_t pos;                     
    aircraft_t *ufo;                
    qboolean onGeoscape;            
    qboolean crashed;               
    char onwin[MAX_VAR];            
    char onlose[MAX_VAR];           
    qboolean posAssigned;           
} mission_t;

typedef struct battleParam_s {
    mission_t *mission;
    alienTeamGroup_t *alienTeamGroup;   
    char *param;                    
    char alienEquipment[MAX_VAR];                   
    char civTeam[MAX_VAR];                          
    qboolean day;                                   
    const char *zoneType;                           
    int aliens, civilians;          
    struct nation_s *nation;        
} battleParam_t;

typedef struct missionResults_s {
    int itemTypes;      
    int itemAmount;     
    qboolean recovery;  
    ufoType_t ufotype;  
    qboolean crashsite; 
    float ufoCondition; 
    int aliensKilled;
    int aliensStunned;
    int aliensSurvived;
    int ownKilled;
    int ownStunned;
    int ownKilledFriendlyFire;
    int ownSurvived;
    int civiliansKilled;
    int civiliansKilledFriendlyFire;
    int civiliansSurvived;
} missionResults_t;

typedef struct campaign_s {
    int idx;                    
    char id[MAX_VAR];           
    char name[MAX_VAR];         
    int team;                   
    char researched[MAX_VAR];   
    char equipment[MAX_VAR];    
    char market[MAX_VAR];       
    char asymptoticMarket[MAX_VAR];     
    const equipDef_t *marketDef;        
    const equipDef_t *asymptoticMarketDef;  
    char text[MAX_VAR];         
    char map[MAX_VAR];          
    int soldiers;               
    int scientists;             
    int workers;                
    int ugvs;                   
    int credits;                
    int num;
    signed int difficulty;      
    float minhappiness;         
    int negativeCreditsUntilLost;   
    int maxAllowedXVIRateUntilLost; 
    qboolean visible;           
    date_t date;                
    int basecost;               
    char firstBaseTemplate[MAX_VAR];    
    qboolean finished;
    const campaignEvents_t *events;
} campaign_t;

typedef struct salary_s {
    int base[MAX_EMPL];
    int rankBonus[MAX_EMPL];
    int admin[MAX_EMPL];
    int aircraftFactor;
    int aircraftDivisor;
    int baseUpkeep;
    int adminInitial;
    float debtInterest;
} salary_t;

#define SALARY_AIRCRAFT_FACTOR ccs.salaries[ccs.curCampaign->idx].aircraftFactor
#define SALARY_AIRCRAFT_DIVISOR ccs.salaries[ccs.curCampaign->idx].aircraftDivisor
#define SALARY_BASE_UPKEEP ccs.salaries[ccs.curCampaign->idx].baseUpkeep
#define SALARY_ADMIN_INITIAL ccs.salaries[ccs.curCampaign->idx].adminInitial
#define SALARY_DEBT_INTEREST ccs.salaries[ccs.curCampaign->idx].debtInterest

int CP_GetSalaryBaseEmployee(employeeType_t type);
int CP_GetSalaryAdminEmployee(employeeType_t type);
int CP_GetSalaryRankBonusEmployee(employeeType_t type);
int CP_GetSalaryAdministrative(void);
int CP_GetSalaryUpKeepBase(const base_t *base);

typedef enum mapAction_s {
    MA_NONE,
    MA_NEWBASE,             
    MA_NEWINSTALLATION,     
    MA_INTERCEPT,           
    MA_BASEATTACK,          
    MA_UFORADAR             
} mapAction_t;

typedef struct ccs_s {
    equipDef_t eMission;
    market_t eMarket;                       
    linkedList_t *missions;                 
    battleParam_t battleParameters;         
    int lastInterestIncreaseDelay;              
    int overallInterest;                        
    int interest[INTERESTCATEGORY_MAX];         
    int lastMissionSpawnedDelay;                
    vec2_t mapPos;      
    vec2_t mapSize;     
    int credits;            
    int civiliansKilled;    
    int aliensKilled;       
    date_t date;            
    qboolean XVIShowMap;            
    qboolean breathingMailSent;     
    float timer;

    vec3_t angles;          
    vec2_t center;          
    float zoom;             
    aircraft_t *interceptAircraft;      
    mission_t *selectedMission;         
    aircraft_t *selectedAircraft;       
    aircraft_t *selectedUFO;            
    /* == misc == */
    /* MA_NEWBASE, MA_INTERCEPT, MA_BASEATTACK, ... */
    mapAction_t mapAction;

    /* BA_NEWBUILDING ... */
    baseAction_t baseAction;

    /* how fast the game is running */
    int gameTimeScale;
    int gameLapse;

    aircraft_t *missionAircraft;    
    /* already paid in this month? */
    qboolean paid;

    /* == employees == */
    /* A list of all phalanx employees (soldiers, scientists, workers, etc...) */
    employee_t employees[MAX_EMPL][MAX_EMPLOYEES];
    /* Total number of employees. */
    int numEmployees[MAX_EMPL];

    /* == technologies == */
    /* A list of all research-topics resp. the research-tree. */
    technology_t technologies[MAX_TECHNOLOGIES];
    /* Total number of technologies. */
    int numTechnologies;

    /* == bases == */
    /* A list of _all_ bases ... even unbuilt ones. */
    base_t bases[MAX_BASES];
    /* Total number of built bases (how many are enabled). */
    int numBases;

    /* a list of all templates for building bases */
    baseTemplate_t baseTemplates[MAX_BASETEMPLATES];
    int numBaseTemplates;

    /* used for unique aircraft ids */
    int numAircraft;

    /* == Alien bases == */
    linkedList_t *alienBases;

    /* == Nations == */
    nation_t nations[MAX_NATIONS];
    int numNations;

    /* == Cities == */
    linkedList_t *cities;
    int numCities;

    /* Projectiles on geoscape (during fights) */
    aircraftProjectile_t projectiles[MAX_PROJECTILESONGEOSCAPE];
    int numProjectiles;

    /* == Transfers == */
    transfer_t transfers[MAX_TRANSFERS];
    int numTransfers;

    /* UFO components. */
    int numComponents;
    components_t components[MAX_ASSEMBLIES];

    /* == stored UFOs == */
    linkedList_t *storedUFOs;

    /* Alien Team Definitions. */
    teamDef_t *alienTeams[MAX_TEAMDEFS];
    int numAliensTD;

    /* Alien Team Package used during battle */
    alienTeamCategory_t alienCategories[ALIENCATEGORY_MAX]; 
    int numAlienCategories;     
    /* == ufopedia == */
    /* A list of all UFOpaedia chapters. */
    pediaChapter_t upChapters[MAX_PEDIACHAPTERS];
    /* Total number of UFOpaedia chapters */
    int numChapters;
    int numUnreadMails; 
    eventMail_t eventMails[MAX_EVENTMAILS]; 
    int numEventMails;  
    campaignEvents_t campaignEvents[MAX_CAMPAIGNS]; 
    int numCampaignEventDefinitions;    
    /* == buildings in bases == */
    /* A list of all possible unique buildings. */
    building_t buildingTemplates[MAX_BUILDINGS];
    int numBuildingTemplates;
    /*  A list of the building-list per base. (new buildings in a base get copied from buildingTypes) */
    building_t buildings[MAX_BASES][MAX_BUILDINGS];
    /* Total number of buildings per base. */
    int numBuildings[MAX_BASES];

    /* == installations == */
    /* A template for each possible installation with configurable values */
    installationTemplate_t installationTemplates[MAX_INSTALLATION_TEMPLATES];
    int numInstallationTemplates;

    /* A list of _all_ installations ... even unbuilt ones. */
    installation_t installations[MAX_INSTALLATIONS];
    /* Total number of built installations (how many are enabled). */
    int numInstallations;

    /* == production == */
    /* we will allow only one active production at the same time for each base */
    production_queue_t productions[MAX_BASES];

    /* == Aircraft == */
    /* UFOs on geoscape */
    aircraft_t ufos[MAX_UFOONGEOSCAPE];
    int numUFOs;    
    /* message categories */
    msgCategory_t messageCategories[MAX_MESSAGECATEGORIES];
    int numMsgCategories;

    /* entries for message categories */
    msgCategoryEntry_t msgCategoryEntries[NT_NUM_NOTIFYTYPE + MAX_MESSAGECATEGORIES];
    int numMsgCategoryEntries;

    /* == Ranks == */
    /* Global list of all ranks defined in medals.ufo. */
    rank_t ranks[MAX_RANKS];
    /* The number of entries in the list above. */
    int numRanks;

    /* cache for techdef technologies */
    technology_t *teamDefTechs[MAX_TEAMDEFS];

    /* cache for item technologies */
    technology_t *objDefTechs[MAX_OBJDEFS];

    campaign_t *curCampaign;            
    stats_t campaignStats;
    missionResults_t missionResults;

    campaign_t campaigns[MAX_CAMPAIGNS];
    int numCampaigns;
    salary_t salaries[MAX_CAMPAIGNS];

    aircraft_t aircraftTemplates[MAX_AIRCRAFT];     
    int numAircraftTemplates;       
} ccs_t;

typedef struct dateLong_s {
    short year; 
    byte month; 
    byte day;   
    byte hour;  
    byte min;   
    byte sec;   
} dateLong_t;

typedef struct {
    int x, y;
} screenPoint_t;

extern ccs_t ccs;
extern const int DETECTION_INTERVAL;
extern cvar_t *cp_campaign;
extern cvar_t *cp_missiontest;
extern cvar_t *cp_start_employees;

void CP_ParseCharacterData(struct dbuffer *msg);
qboolean CP_CheckNextStageDestination(aircraft_t *ufo);

void CP_InitStartup(void);
void CL_ResetSinglePlayerData(void);
void CL_DateConvert(const date_t * date, byte *day, byte *month, short *year);
void CL_DateConvertLong(const date_t * date, dateLong_t * dateLong);
int CL_DateCreateDay(const short years, const byte months, const byte days);
int CL_DateCreateSeconds(byte hours, byte minutes, byte seconds);
void CL_CampaignRun(void);
void CP_EndCampaign(qboolean won);
void CL_UpdateCredits(int credits);
aircraft_t* AIR_NewAircraft(base_t * base, const char *name);
const char* CL_SecondConvert(int second);
void CL_ReadSinglePlayerData(void);

void CP_GetRandomPosOnGeoscape(vec2_t pos, qboolean noWater);
qboolean CP_GetRandomPosOnGeoscapeWithParameters(vec2_t pos, const linkedList_t *terrainTypes, const linkedList_t *cultureTypes, const linkedList_t *populationTypes, const linkedList_t *nations);

campaign_t* CL_GetCampaign(const char *name);
void CL_GameAutoGo(mission_t *mission);

void CP_InitMissionResults(qboolean won);
void CP_CampaignInit(campaign_t *campaign, qboolean load);
void CP_CampaignExit(void);
qboolean CP_OnGeoscape(void);

/* Mission related functions */
int CP_CountMission(void);
int CP_CountMissionActive(void);
int CP_CountMissionOnGeoscape(void);
void CP_UpdateMissionVisibleOnGeoscape(void);
int CP_TerrorMissionAvailableUFOs(const mission_t const *mission, ufoType_t *ufoTypes);
qboolean AIR_SendAircraftToMission(aircraft_t *aircraft, mission_t *mission);
void AIR_AircraftsNotifyMissionRemoved(const mission_t *mission);

void CP_UFOProceedMission(aircraft_t *ufocraft);
qboolean CP_IsRunning(void);

mission_t *CP_CreateNewMission(interestCategory_t category, qboolean beginNow);
qboolean CP_ChooseMap(mission_t *mission, const vec2_t pos);
void CP_StartSelectedMission(void);
void CL_HandleNationData(qboolean won, mission_t * mis);
void CP_CheckLostCondition(void);
void CL_UpdateCharacterStats(const base_t *base, const aircraft_t *aircraft);

#endif /* CLIENT_CL_CAMPAIGN_H */