cp_research.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_RESEARCH
#define CLIENT_CL_RESEARCH

#define MAX_RESEARCHDISPLAY 22  
#define MAX_RESEARCHLIST 32
#define MAX_TECHNOLOGIES 256    
#define MAX_TECHLINKS 16    
#define MAX_DESCRIPTIONS 8  
#define TECH_INVALID -1 
#define ANTIMATTER_TECH_ID "antimatter"

typedef enum researchStatus_s {
    RS_NONE,
    RS_RUNNING,
    RS_PAUSED,
    RS_FINISH
} researchStatus_t;

typedef enum researchType_s {
    RS_TECH,
    RS_WEAPON,
    RS_ARMOUR,
    RS_CRAFT,
    RS_CRAFTITEM,
    RS_BUILDING,
    RS_ALIEN,
    RS_UGV,
    RS_NEWS,
    RS_LOGIC
} researchType_t;

typedef enum requirementType_s {
    RS_LINK_TECH,
    RS_LINK_TECH_NOT,
    RS_LINK_ITEM,
    RS_LINK_ALIEN,
    RS_LINK_ALIEN_DEAD,
    RS_LINK_ALIEN_GLOBAL,
    RS_LINK_UFO,
    RS_LINK_ANTIMATTER,
    MAX_RS_LINKTYPES
} requirementType_t;

typedef struct requirement_s {
    requirementType_t type; 
    char *id;   
    void *link; 
    int amount; 
    int collected;  
} requirement_t;

typedef struct requirements_s {
    int numLinks;           
    requirement_t links[MAX_TECHLINKS];
} requirements_t;

typedef struct markResearched_s {
    qboolean markOnly[MAX_CAMPAIGNS];
    char *campaign[MAX_CAMPAIGNS];
    int numDefinitions;
} markResearched_t;

typedef enum {
    TECHMAIL_PRE,       
    TECHMAIL_RESEARCHED,    
    TECHMAIL_MAX
} techMailType_t;

typedef struct techMail_s {
    char *from;         
    char *to;           
    char *subject;      
    char *date;         
    char *icon;         
    char *model;        
    qboolean read;      
} techMail_t;

typedef enum {
    MAILSENT_NONE,      
    MAILSENT_PROPOSAL,  
    MAILSENT_FINISHED,  
    MAILSENT_MAX
} mailSentType_t;

typedef struct descriptions_s {
    int numDescriptions;    
    int usedDescription;    
    char *text[MAX_DESCRIPTIONS];   
    char *tech[MAX_DESCRIPTIONS];   
} descriptions_t;

typedef struct technology_s {
    char *id;       
    int idx;            
    char *name;     
    descriptions_t description; 
    descriptions_t preDescription;  
    researchType_t type;        
    struct technology_s *redirect;  
    requirements_t requireAND;  
    requirements_t requireOR;   
    qboolean statusCollected;   
    char *provides;     
    float overallTime, time;    
    int delay;          
    researchStatus_t statusResearch;    
    char *finishedResearchEvent;        
    struct base_s   *base;  
    int scientists;         
    char *image;            
    char *mdl;              
    int statusResearchable;     
    int produceTime;            
    mailSentType_t mailSent;        
    requirements_t requireForProduction;    
    date_t preResearchedDate;   
    date_t researchedDate;      
    markResearched_t markResearched;    
    /* Pedia info */
    struct pediaChapter_s *upChapter;                   
    struct technology_s *upPrev;    
    struct technology_s *upNext;    
    techMail_t mail[TECHMAIL_MAX];  
    int numTechMails;               
    struct technology_s *hashNext;
    struct technology_s *hashProvidedNext;
} technology_t;

void RS_InitStartup(void);
void RS_ResetTechs(void);
void RS_ResearchRun(void);
void RS_ParseTechnologies(const char *name, const char **text);
qboolean RS_IsResearched_idx(int techIdx);
qboolean RS_IsResearched_ptr(const technology_t *tech);
int RS_Collected_(const technology_t * tech);

technology_t* RS_GetTechForItem(const objDef_t *item);
void RS_AddObjectTechs(void);
void RS_RequiredLinksAssign(void);
void RS_InitTree(qboolean load);
const char *RS_GetDescription(descriptions_t *desc);
void RS_MarkCollected(technology_t *tech) __attribute__((nonnull));
void RS_MarkResearchable(qboolean init, const struct base_s *base);
qboolean RS_MarkStoryLineEventResearched(const char *techID);
void RS_ResearchFinish(technology_t* tech);
void RS_StopResearch(technology_t* tech);
void RS_MarkOneResearchable(technology_t *tech);

void RS_AssignScientist(technology_t* tech, struct base_s *base, struct employee_s *employee);
void RS_RemoveScientist(technology_t* tech, struct employee_s *employee);
void RS_RemoveFiredScientist(struct base_s *base, struct employee_s *employee);
void RS_RemoveScientistsExceedingCapacity(struct base_s *base);

technology_t *RS_GetTechByID(const char *id);
technology_t *RS_GetTechByProvided(const char *idProvided);
technology_t* RS_GetTechByIDX(int tech_idx);
technology_t *RS_GetTechWithMostScientists(const struct base_s *base);
int RS_GetTechIdxByName(const char *name);
int RS_CountScientistsInBase(const struct base_s *base);
qboolean RS_ScriptSanityCheck(void);

/* UFOpaedia function - but needs technology_t */
void UP_AircraftDescription(const technology_t* t);
void UP_UGVDescription(const struct ugv_s *ugvType);

qboolean RS_RequirementsMet(const requirements_t *requiredAND, const requirements_t *requiredOR, const struct base_s *base);

#endif /* CLIENT_CL_RESEARCH_H */