UFO: Alien Invasion
Doxygen documentation generating
cp_nation.h
Go to the documentation of this file.
1 
8 /*
9 Copyright (C) 2002-2023 UFO: Alien Invasion.
10 
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 as published by the Free Software Foundation; either version 2
14 of the License, or (at your option) any later version.
15 
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 
20 See the GNU General Public License for more details.
21 
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 */
26 
27 #pragma once
28 
29  #include "../../DateTime.h"
30 
35 typedef struct nationInfo_s {
36  bool inuse;
38  /* Relationship */
39  float happiness;
41 } nationInfo_t;
42 
46 typedef struct nation_s {
47  const char* id;
48  const char* name;
49  int idx;
59  /* Funding */
60  int maxFunding;
63  int maxWorkers;
64  int maxPilots;
65 } nation_t;
66 
70 typedef struct city_s {
71  const char* id;
72  const char* name;
74 } city_t;
75 
80 #define NAT_Foreach(var) LIST_Foreach(ccs.nations, nation_t, var)
81 
82 nation_t* NAT_GetNationByID(const char* nationID);
83 nation_t* NAT_GetRandom(void);
84 
85 void NAT_UpdateHappinessForAllNations(const float minhappiness);
86 void NAT_SetHappiness(const float minhappiness, nation_t* nation, const float happiness);
87 int NAT_GetFunding(const nation_t* const nation, int month);
88 const nationInfo_t* NAT_GetCurrentMonthInfo(const nation_t* const nation);
89 const char* NAT_GetHappinessString(const float happiness);
90 const char* NAT_GetCurrentHappinessString(const nation_t* nation);
91 void CP_HandleNationData(float minHappiness, struct mission_s* mis, const nation_t* nation, const struct missionResults_s* results, bool won);
92 
93 void CL_ParseNations(const char* name, const char** text);
94 
95 city_t* CITY_GetById(const char* cityId);
97 void CITY_Parse(const char* name, const char** text);
98 
99 bool NAT_ScriptSanityCheck(void);
100 
101 void NAT_HandleBudget(const struct campaign_s* campaign);
102 void NAT_BackupMonthlyData(void);
103 
104 void NAT_InitStartup(void);
105 void NAT_Shutdown(void);
int maxPilots
Definition: cp_nation.h:64
city_t * CITY_GetByPos(vec2_t pos)
Finds a city by it's geoscape coordinates.
Definition: cp_nation.cpp:425
void NAT_UpdateHappinessForAllNations(const float minhappiness)
Lower happiness of nations depending on alien activity.
Definition: cp_nation.cpp:84
static const short MONTHS_PER_YEAR
Definition: DateTime.h:39
void CITY_Parse(const char *name, const char **text)
Parse the city data from script file.
Definition: cp_nation.cpp:446
float happiness
Definition: cp_nation.h:39
city_t * CITY_GetById(const char *cityId)
Finds a city by it's scripted identifier.
Definition: cp_nation.cpp:412
int xviInfection
Definition: cp_nation.h:40
const char * id
Definition: cp_nation.h:47
int NAT_GetFunding(const nation_t *const nation, int month)
Get the funding of a nation at a certain month.
Definition: cp_nation.cpp:121
const nationInfo_t * NAT_GetCurrentMonthInfo(const nation_t *const nation)
Get the current month nation stats.
Definition: cp_nation.cpp:133
bool inuse
Definition: cp_nation.h:36
void CL_ParseNations(const char *name, const char **text)
Parse the nation data from script file.
Definition: cp_nation.cpp:383
void NAT_Shutdown(void)
Closing actions for nation-subsystem.
Definition: cp_nation.cpp:860
Nation definition.
Definition: cp_nation.h:46
void NAT_BackupMonthlyData(void)
Backs up each nation's relationship values.
Definition: cp_nation.cpp:826
City definition.
Definition: cp_nation.h:70
nation_t * NAT_GetNationByID(const char *nationID)
Return a nation-pointer by the nations id.
Definition: cp_nation.cpp:64
const char * NAT_GetCurrentHappinessString(const nation_t *nation)
Translates the current nation happiness float value to a string.
Definition: cp_nation.cpp:177
int maxWorkers
Definition: cp_nation.h:63
Detailed information about the nation relationship (currently per month, but could be used elsewhere)...
Definition: cp_nation.h:35
nation_t * NAT_GetRandom(void)
Return a pointer to a random nation.
Definition: cp_nation.cpp:46
void NAT_HandleBudget(const struct campaign_s *campaign)
vec2_t pos
Definition: cp_nation.h:73
void NAT_SetHappiness(const float minhappiness, nation_t *nation, const float happiness)
Updates the nation happiness.
Definition: cp_nation.cpp:189
bool NAT_ScriptSanityCheck(void)
Checks the parsed nations and cities for errors.
Definition: cp_nation.cpp:470
QGL_EXTERN GLuint GLsizei GLsizei GLint GLenum GLchar * name
Definition: r_gl.h:110
const char * NAT_GetHappinessString(const float happiness)
Translates the nation happiness float value to a string.
Definition: cp_nation.cpp:144
void CP_HandleNationData(float minHappiness, struct mission_s *mis, const nation_t *nation, const struct missionResults_s *results, bool won)
int maxFunding
Definition: cp_nation.h:60
vec_t vec2_t[2]
Definition: ufotypes.h:38
void NAT_InitStartup(void)
Init actions for nation-subsystem.
Definition: cp_nation.cpp:852
const char * name
Definition: cp_nation.h:72
vec4_t color
Definition: cp_nation.h:51
int idx
Definition: cp_nation.h:49
const char * name
Definition: cp_nation.h:48
int maxScientists
Definition: cp_nation.h:62
int maxSoldiers
Definition: cp_nation.h:61
vec2_t pos
Definition: cp_nation.h:52
vec_t vec4_t[4]
Definition: ufotypes.h:40
const char * id
Definition: cp_nation.h:71