Technology research. More...

#include "../../DateTime.h"
#include "../../cl_shared.h"
#include "../../../shared/parse.h"
#include "cp_campaign.h"
#include "cp_capacity.h"
#include "cp_research.h"
#include "cp_popup.h"
#include "cp_time.h"
#include "save/save_research.h"
#include "aliencontainment.h"

Include dependency graph for cp_research.cpp:

Go to the source code of this file.

Macros
#define	TECH_HASH_SIZE 64

Functions
void	RS_ResearchFinish (technology_t *tech)
	Sets a technology status to researched and updates the date.
void	RS_StopResearch (technology_t *tech)
	Stops a research (Removes scientists from it).
void	RS_MarkOneResearchable (technology_t *tech)
	Marks one tech as researchable.
bool	RS_RequirementsMet (const technology_t tech, const base_t base)
	Checks if all requirements of a tech have been met so that it becomes researchable.
const char *	RS_GetDescription (technologyDescriptions_t *desc)
	returns the currently used description for a technology.
void	RS_MarkCollected (technology_t *tech)
	Marks a give technology as collected.
void	RS_MarkResearchable (const base_t *base, bool init)
	Marks all the techs that can be researched. Automatically researches 'free' techs such as ammo for a weapon. Not "researchable"-related. Should be called when a new item is researched (RS_MarkResearched) and after the tree-initialisation (RS_InitTree).
static void	RS_AssignTechLinks (requirements_t *reqs)
	Assign required tech/item/etc... pointers for a single requirements list.
void	RS_RequiredLinksAssign (void)
	Assign Link pointers to all required techs/items/etc...
technology_t *	RS_GetTechForItem (const objDef_t *item)
	Returns technology entry for an item.
technology_t *	RS_GetTechForTeam (const teamDef_t *team)
	Returns technology entry for a team.
void	RS_InitTree (const campaign_t *campaign, bool load)
	Gets all needed names/file-paths/etc... for each technology entry. Should be executed after the parsing of all the ufo files and e.g. the research tree/inventory/etc... are initialised.
void	RS_AssignScientist (technology_t tech, base_t base, Employee *employee)
	Assigns scientist to the selected research-project.
void	RS_RemoveScientist (technology_t tech, Employee employee)
	Remove a scientist from a technology.
void	RS_RemoveFiredScientist (base_t base, Employee employee)
	Remove one scientist from research project if needed.
static void	RS_MarkResearched (technology_t tech, const base_t base)
	Mark technologies as researched. This includes techs that depends on "tech" and have time=0.
bool	RS_MarkStoryLineEventResearched (const char *techID)
void	RS_CheckRequirements (void)
	Checks if running researches still meet their requirements.
int	RS_ResearchRun (void)
	Checks the research status.
void	RS_InitStartup (void)
	This is more or less the initial Bind some of the functions in this file to console-commands that you can call ingame. Called from UI_InitStartup resp. CL_InitLocal.
void	RS_ResetTechs (void)
	This is called everytime RS_ParseTechnologies is called - to prevent cyclic hash tables.
void	RS_ParseTechnologies (const char name, const char *text)
	Parses one "tech" entry in the research.ufo file and writes it into the next free entry in technologies (technology_t).
static bool	RS_IsValidTechIndex (int techIdx)
bool	RS_IsResearched_idx (int techIdx)
	Checks if the technology (tech-index) has been researched.
bool	RS_IsResearched_ptr (const technology_t *tech)
	Checks whether an item is already researched.
technology_t *	RS_GetTechByIDX (int techIdx)
	Returns the technology pointer for a tech index. You can use this instead of "&ccs.technologies[techIdx]" to avoid having to check valid indices.
technology_t *	RS_GetTechByID (const char *id)
	return a pointer to the technology identified by given id string
technology_t *	RS_GetTechByProvided (const char *idProvided)
	returns a pointer to the item tech (as listed in "provides")
technology_t *	RS_GetTechWithMostScientists (const struct base_s *base)
	Searches for the technology that has the most scientists assigned in a given base.
int	RS_GetTechIdxByName (const char *name)
	Returns the index (idx) of a "tech" entry given it's name.
int	RS_CountScientistsInBase (const base_t *base)
	Returns the number of employees searching in labs in given base.
void	RS_RemoveScientistsExceedingCapacity (base_t *base)
	Remove all exceeding scientist.
bool	RS_SaveXML (xmlNode_t *parent)
	Save callback for research and technologies.
bool	RS_LoadXML (xmlNode_t *parent)
	Load callback for research and technologies.
bool	RS_ResearchAllowed (const base_t *base)
	Returns true if the current base is able to handle research.
bool	RS_ScriptSanityCheck (void)
	Checks the parsed tech data for errors.

Variables
static technology_t *	techHash [TECH_HASH_SIZE]
static technology_t *	techHashProvided [TECH_HASH_SIZE]
static linkedList_t *	redirectedTechs
static const value_t	valid_tech_vars []
	The valid definition names in the research.ufo file.
static const value_t	valid_techmail_vars []
	The valid definition names in the research.ufo file for tech mails.

Detailed Description

Technology research.

Handles everything related to the research-tree. Provides information if items/buildings/etc.. can be researched/used/displayed etc... Implements the research-system (research new items/etc...) See base/ufos/research.ufo and base/ufos/ui/research.ufo for the underlying content.

Todo: comment on used global variables.

Definition in file cp_research.cpp.

Macro Definition Documentation

◆ TECH_HASH_SIZE

#define TECH_HASH_SIZE 64

Definition at line 42 of file cp_research.cpp.

Referenced by RS_GetTechByID(), RS_GetTechByProvided(), RS_GetTechIdxByName(), and RS_ParseTechnologies().

Function Documentation

◆ RS_AssignScientist()

void RS_AssignScientist	(	technology_t *	tech,
		base_t *	base,
		Employee *	employee )

Assigns scientist to the selected research-project.

Note: The lab will be automatically selected (the first one that has still free space).

Parameters

[in]	tech	What technology you want to assign the scientist to.
[in]	base	Pointer to base where the research is ongoing.
[in]	employee	Pointer to the scientist to assign. It can be nullptr! That means "any".

Note: if employee is nullptr, te system selects an unassigned scientist on the selected (or tech-) base

See also: RS_AssignScientist_f; RS_RemoveScientist

Definition at line 654 of file cp_research.cpp.

References _, technology_t::base, CAP_AddCurrent(), CAP_GetFreeCapacity(), CAP_LABSPACE, cgi, CP_Popup(), DEBUG_CLIENT, E_GetUnassignedEmployee(), EMPL_SCIENTIST, technology_t::id, technology_t::idx, base_t::name, technology_t::name, RS_RUNNING, technology_t::scientists, Employee::setAssigned(), technology_t::statusResearch, and technology_t::statusResearchable.

Referenced by RS_Change_f(), RS_Max_f(), RS_RemoveFiredScientist(), and TEST_F().

◆ RS_AssignTechLinks()

void RS_AssignTechLinks ( requirements_t * reqs )

static

Assign required tech/item/etc... pointers for a single requirements list.

Note: A function with the same behaviour was formerly also known as RS_InitRequirementList

Definition at line 383 of file cp_research.cpp.

References AIR_GetAircraft(), requirement_t::typelink_t::aircraft, cgi, ERR_DROP, i, requirement_t::id, INVSH_GetItemByID(), requirement_t::link, requirements_t::links, requirements_t::numLinks, requirement_t::typelink_t::od, RS_GetTechByID(), RS_LINK_ALIEN, RS_LINK_ALIEN_DEAD, RS_LINK_ITEM, RS_LINK_TECH, RS_LINK_TECH_NOT, RS_LINK_UFO, requirement_t::typelink_t::td, requirement_t::typelink_t::tech, and requirement_t::type.

Referenced by RS_InitTree(), and RS_RequiredLinksAssign().

◆ RS_CheckRequirements()

void RS_CheckRequirements ( void )

Checks if running researches still meet their requirements.

Definition at line 790 of file cp_research.cpp.

References _, technology_t::base, ccs, Com_sprintf(), cp_messageBuffer, i, MSG_RESEARCH_HALTED, MSO_CheckAddNewMessage(), technology_t::name, NT_RESEARCH_HALTED, RS_GetTechByIDX(), RS_RequirementsMet(), RS_RUNNING, RS_StopResearch(), and technology_t::statusResearch.

Referenced by US_RemoveStoredUFO().

◆ RS_CountScientistsInBase()

int RS_CountScientistsInBase ( const base_t * base )

Returns the number of employees searching in labs in given base.

Parameters

[in] base Pointer to the base

See also: B_ResetAllStatusAndCapacities_f

Note: must not return 0 if hasBuilding[B_LAB] is false: used to update capacity

Definition at line 1688 of file cp_research.cpp.

References technology_t::base, ccs, i, and technology_t::scientists.

Referenced by B_ResetAllStatusAndCapacities(), and RS_RemoveScientistsExceedingCapacity().

◆ RS_GetDescription()

const char * RS_GetDescription ( technologyDescriptions_t * desc )

returns the currently used description for a technology.

Parameters

[in,out] desc A list of possible descriptions (with tech-links that decide which one is the correct one)

< Stored used description

Definition at line 271 of file cp_research.cpp.

References i, technologyDescriptions_t::numDescriptions, RS_GetTechByID(), RS_IsResearched_ptr(), technologyDescriptions_t::tech, technologyDescriptions_t::text, and technologyDescriptions_t::usedDescription.

Referenced by RS_MarkOneResearchable(), RS_ResearchFinish(), and UP_Article().

◆ RS_GetTechByID()

technology_t * RS_GetTechByID ( const char * id )

return a pointer to the technology identified by given id string

Parameters

[in] id Unique identifier of the tech as defined in the research.ufo file (e.g. "tech xxxx").

Returns: technology_t pointer or nullptr if an error occured.

Definition at line 1603 of file cp_research.cpp.

References cgi, Com_HashKey(), hash, technology_t::hashNext, technology_t::id, Q_strcasecmp, Q_strnull(), TECH_HASH_SIZE, and techHash.

Referenced by AIM_AutoEquipAircraft(), AIR_ParseAircraft(), B_BuildingScriptSanityCheck(), BDEF_BaseDefenceMenuUpdate_f(), CP_AddTechAsResearchable_f(), CP_CheckTriggerEvent(), CP_GetEventsByID(), CP_ParseCampaignData(), CP_XVIInit(), AlienContainment::isLifeSupported(), MS_LoadXML(), RS_AssignTechLinks(), RS_Change_f(), RS_GetDescription(), RS_GetDetails_f(), RS_LoadXML(), RS_MarkStoryLineEventResearched(), RS_Max_f(), RS_RequiredLinksAssign(), RS_Stop_f(), TEST_F(), TEST_F(), and UP_FindEntry_f().

◆ RS_GetTechByIDX()

technology_t * RS_GetTechByIDX ( int techIdx )

Returns the technology pointer for a tech index. You can use this instead of "&ccs.technologies[techIdx]" to avoid having to check valid indices.

Parameters

[in] techIdx Index in the global ccs.technologies[] array.

Returns: technology_t pointer or nullptr if an error occurred.

Definition at line 1590 of file cp_research.cpp.

References ccs, and RS_IsValidTechIndex().

Referenced by AIM_AircraftEquipMenuClick_f(), CP_ParseResearchableCampaignStates(), CP_ParseResearchedCampaignItems(), RS_CheckRequirements(), RS_FillTechnologyList_f(), RS_GetTechWithMostScientists(), RS_MarkResearchable(), RS_RequiredLinksAssign(), RS_ResearchRun(), RS_SaveXML(), and RS_ShowActiveResearch_f().

◆ RS_GetTechByProvided()

technology_t * RS_GetTechByProvided ( const char * idProvided )

returns a pointer to the item tech (as listed in "provides")

Parameters

[in] idProvided Unique identifier of the object the tech is providing

Returns: The tech for the given object id or nullptr if not found

Definition at line 1622 of file cp_research.cpp.

References cgi, Com_HashKey(), DEBUG_CLIENT, hash, technology_t::hashProvidedNext, technology_t::provides, Q_strcasecmp, TECH_HASH_SIZE, and techHashProvided.

Referenced by AII_LoadOneSlotXML(), AIRFIGHT_LoadXML(), B_ParseBuildings(), BS_FillMarket_f(), BS_MarketInfoClick_f(), GAME_CP_GetItemModel(), INS_LinkTechnologies(), RS_InitTree(), UFO_GetTechnologyFromType(), and UP_UGVDescription().

◆ RS_GetTechForItem()

technology_t * RS_GetTechForItem ( const objDef_t * item )

Returns technology entry for an item.

Parameters

[in] item Pointer to the item (object) definition

Definition at line 456 of file cp_research.cpp.

References ccs, cgi, ERR_DROP, objDef_t::id, objDef_t::idx, and lengthof.

Referenced by AII_AutoAddAmmo(), AII_CarriedItems(), AII_GetCraftitemTechsByType(), AIM_AircraftEquipMenuUpdate(), AIM_DrawAircraftSlots(), B_AddToStorage(), B_SellOrAddItems(), BDEF_AddSlotToSlotList(), BS_FillMarket_f(), BS_InitMarket(), BS_SetAutosell_f(), CP_AddItemAsCollected_f(), CP_CampaignRunMarket(), GAME_CP_ItemIsUseable(), PR_FinishDisassembly(), PR_GetTech(), PR_ItemIsProduceable(), PR_ItemProductionInfo(), PR_ProductionListClick_f(), PR_ProductionListRightClick_f(), PR_RequirementsInfo(), PR_UpdateProductionList(), TEST_F(), UP_AircraftItemDescription(), UP_DrawAssociatedAmmo(), and UP_ResearchedLinkClick_f().

◆ RS_GetTechForTeam()

technology_t * RS_GetTechForTeam ( const teamDef_t * team )

Returns technology entry for a team.

Parameters

[in] team Pointer to the team definition

Definition at line 471 of file cp_research.cpp.

References ccs, cgi, ERR_DROP, teamDef_t::id, teamDef_t::idx, and lengthof.

Referenced by AC_Init_f(), AC_KillOne_f(), and AlienContainment::add().

◆ RS_GetTechIdxByName()

int RS_GetTechIdxByName ( const char * name )

Returns the index (idx) of a "tech" entry given it's name.

Parameters

[in] name the name of the tech

Definition at line 1670 of file cp_research.cpp.

References cgi, Com_HashKey(), hash, technology_t::hashNext, technology_t::id, technology_t::idx, name, Q_strcasecmp, TECH_HASH_SIZE, TECH_INVALID, and techHash.

◆ RS_GetTechWithMostScientists()

technology_t * RS_GetTechWithMostScientists ( const struct base_s * base )

Searches for the technology that has the most scientists assigned in a given base.

Parameters

[in] base In what base the tech should be researched.

Definition at line 1645 of file cp_research.cpp.

References technology_t::base, ccs, i, RS_GetTechByIDX(), RS_RUNNING, technology_t::scientists, and technology_t::statusResearch.

Referenced by RS_RemoveFiredScientist(), and RS_RemoveScientistsExceedingCapacity().

◆ RS_InitStartup()

void RS_InitStartup ( void )

This is more or less the initial Bind some of the functions in this file to console-commands that you can call ingame. Called from UI_InitStartup resp. CL_InitLocal.

Definition at line 1069 of file cp_research.cpp.

References cgi.

Referenced by CP_InitStartup().

◆ RS_InitTree()

void RS_InitTree	(	const campaign_t *	campaign,
		bool	load )

Gets all needed names/file-paths/etc... for each technology entry. Should be executed after the parsing of all the ufo files and e.g. the research tree/inventory/etc... are initialised.

Parameters

[in]	campaign	The campaign data structure
[in]	load	true if we are loading a game, false otherwise

Todo: Add a function to reset ALL research-stati to RS_NONE; -> to be called after start of a new game.

See also: CP_CampaignInit

Todo: Implement me

Definition at line 491 of file cp_research.cpp.

References AIR_Foreach, markResearched_t::campaign, ccs, cgi, cp_campaignPool, csi, DEBUG_CLIENT, ERR_DROP, ERR_FATAL, i, aircraft_t::id, building_t::id, objDef_t::id, technology_t::id, objDef_t::idx, building_t::image, objDef_t::image, technology_t::image, INVSH_GetItemByIDX(), technology_t::mail, markResearched_t::markOnly, technology_t::markResearched, technology_t::mdl, aircraft_t::model, objDef_t::model, aircraft_t::name, building_t::name, objDef_t::name, technology_t::name, markResearched_t::numDefinitions, technology_t::provides, Q_streq, technology_t::requireAND, technology_t::requireOR, campaign_t::researched, RS_ALIEN, RS_ARMOUR, RS_AssignTechLinks(), RS_BUILDING, RS_CRAFT, RS_CRAFTITEM, RS_GetTechByProvided(), RS_LOGIC, RS_NEWS, RS_ResearchFinish(), RS_TECH, RS_UGV, RS_WEAPON, techMail_t::subject, aircraft_t::tech, TECHMAIL_MAX, techMail_t::to, and technology_t::type.

Referenced by CP_CampaignInit(), CreateBase(), TEST_F(), TEST_F(), and TEST_F().

◆ RS_IsResearched_idx()

bool RS_IsResearched_idx ( int techIdx )

Checks if the technology (tech-index) has been researched.

Parameters

[in] techIdx index of the technology.

Returns: true if the technology has been researched, otherwise (or on error) false;

See also: RS_IsResearched_ptr

Definition at line 1561 of file cp_research.cpp.

References ccs, RS_FINISH, and RS_IsValidTechIndex().

◆ RS_IsResearched_ptr()

bool RS_IsResearched_ptr ( const technology_t * tech )

Checks whether an item is already researched.

See also: RS_IsResearched_idx Call this function if you already hold a tech pointer

Definition at line 1577 of file cp_research.cpp.

References RS_FINISH, and technology_t::statusResearch.

Referenced by AC_Init_f(), AIM_CheckTechnologyIntoSlot(), AIM_CrafttypeFilter(), AIM_SelectableCraftItem(), B_ListBuildings_f(), B_SellOrAddItems(), BDEF_BaseDefenceMenuUpdate_f(), BS_FillMarket_f(), BS_InitMarket(), BS_SetAutosell_f(), CP_CampaignRunMarket(), CP_CheckTriggerEvent(), CP_IsXVIVisible(), GAME_CP_ItemIsUseable(), GAME_CP_TeamIsKnown(), GEO_DrawMarkers(), INS_FillTypes_f(), INS_SelectType_f(), AlienContainment::isLifeSupported(), PR_ProductionListClick_f(), PR_ProductionListRightClick_f(), PR_RequirementsMet(), PR_UpdateProductionList(), RS_GetDescription(), RS_MarkStoryLineEventResearched(), RS_RequirementsMet(), TR_DestinationCapacityList_f(), UFO_GetName(), UP_AircraftDescription(), UP_AircraftItemDescription(), UP_Article(), UP_GetUnreadMails(), UP_TechGetsDisplayed(), and UP_UGVDescription().

◆ RS_IsValidTechIndex()

bool RS_IsValidTechIndex ( int techIdx )

inlinestatic

Definition at line 1543 of file cp_research.cpp.

References ccs, MAX_TECHNOLOGIES, and TECH_INVALID.

Referenced by RS_GetTechByIDX(), and RS_IsResearched_idx().

◆ RS_LoadXML()

bool RS_LoadXML ( xmlNode_t * parent )

Load callback for research and technologies.

Parameters

[in] parent XML Node structure, where we get the information from

See also: RS_SaveXML

Todo: this should be handled by the mail system

Definition at line 1764 of file cp_research.cpp.

References B_GetBaseByIDX(), technology_t::base, cgi, technology_t::mail, technology_t::mailSent, technology_t::preResearchedDate, techMail_t::read, technology_t::researchedDate, RS_GetTechByID(), RS_RUNNING, SAVE_RESEARCH_BASE, SAVE_RESEARCH_DATE, SAVE_RESEARCH_ID, SAVE_RESEARCH_MAIL, SAVE_RESEARCH_MAIL_ID, SAVE_RESEARCH_MAILSENT, SAVE_RESEARCH_PREDATE, SAVE_RESEARCH_RESEARCH, SAVE_RESEARCH_SCIENTISTS, SAVE_RESEARCH_STATUSCOLLECTED, SAVE_RESEARCH_STATUSRESEARCH, SAVE_RESEARCH_STATUSRESEARCHABLE, SAVE_RESEARCH_TECH, SAVE_RESEARCH_TIME, SAVE_RESEARCHSTATUS_NAMESPACE, saveResearchConstants, technology_t::scientists, technology_t::statusCollected, technology_t::statusResearch, technology_t::statusResearchable, TECHMAIL_MAX, technology_t::time, type, and xmlNode_t.

Referenced by SAV_Init().

◆ RS_MarkCollected()

void RS_MarkCollected ( technology_t * tech )

Marks a give technology as collected.

See also: CP_AddItemAsCollected_f; MS_AddNewMessage; RS_MarkOneResearchable

Parameters

[in] tech The technology pointer to mark collected

Definition at line 305 of file cp_research.cpp.

References _, ccs, Com_sprintf(), cp_messageBuffer, DateTime::getDateAsDays(), technology_t::mailSent, MAILSENT_FINISHED, MAILSENT_PROPOSAL, MSG_RESEARCH_PROPOSAL, MSO_CheckAddNewMessage(), technology_t::name, NT_RESEARCH_PROPOSED, technology_t::preResearchedDate, RS_FINISH, technology_t::statusCollected, technology_t::statusResearch, and technology_t::time.

Referenced by AlienContainment::add(), AII_CarriedItems(), B_SellOrAddItems(), CP_AddItemAsCollected_f(), PR_FinishDisassembly(), UR_ProcessActive(), and US_StoreUFO().

◆ RS_MarkOneResearchable()

void RS_MarkOneResearchable ( technology_t * tech )

Marks one tech as researchable.

Parameters

tech	The technology to be marked.

See also: RS_MarkCollected; RS_MarkResearchable

At this point we define what research proposal description is used when displayed. (i.e. "usedDescription" is set here). That's because this is the first the player will see anything from the tech and any later changes may make the content (proposal) of the tech inconsistent for the player.

See also: RS_ResearchFinish

Definition at line 107 of file cp_research.cpp.

References _, ccs, cgi, Com_sprintf(), cp_messageBuffer, DEBUG_CLIENT, DateTime::getDateAsDays(), technology_t::id, technology_t::mailSent, MAILSENT_FINISHED, MAILSENT_PROPOSAL, MSG_RESEARCH_PROPOSAL, MSO_CheckAddNewMessage(), technology_t::name, NT_RESEARCH_PROPOSED, technology_t::preDescription, technology_t::preResearchedDate, RS_GetDescription(), technology_t::statusResearchable, and technology_t::time.

Referenced by CP_AddTechAsResearchable_f(), CP_ParseResearchableCampaignStates(), RS_MarkResearchable(), and TEST_F().

◆ RS_MarkResearchable()

void RS_MarkResearchable	(	const base_t *	base,
		bool	init )

Marks all the techs that can be researched. Automatically researches 'free' techs such as ammo for a weapon. Not "researchable"-related. Should be called when a new item is researched (RS_MarkResearched) and after the tree-initialisation (RS_InitTree).

See also: RS_MarkResearched

Definition at line 335 of file cp_research.cpp.

References technology_t::base, ccs, cgi, DEBUG_CLIENT, i, technology_t::id, technology_t::mailSent, MAILSENT_FINISHED, MAILSENT_PROPOSAL, RS_FINISH, RS_GetTechByIDX(), RS_MarkOneResearchable(), RS_RequirementsMet(), RS_ResearchFinish(), technology_t::statusResearch, technology_t::statusResearchable, and technology_t::time.

Referenced by B_SellOrAddItems(), CP_CampaignInit(), RS_FillTechnologyList_f(), RS_MarkResearched(), TEST_F(), and TEST_F().

◆ RS_MarkResearched()

void RS_MarkResearched	(	technology_t *	tech,
		const base_t *	base )

static

Mark technologies as researched. This includes techs that depends on "tech" and have time=0.

Parameters

[in]	tech	Pointer to a technology_t struct.
[in]	base	Pointer to base where we did research.

Todo: Base shouldn't be needed here - check RS_MarkResearchable() for that.

See also: RS_ResearchRun

Definition at line 762 of file cp_research.cpp.

References cgi, DEBUG_CLIENT, technology_t::id, RS_MarkResearchable(), and RS_ResearchFinish().

Referenced by RS_MarkStoryLineEventResearched(), and RS_ResearchRun().

◆ RS_MarkStoryLineEventResearched()

bool RS_MarkStoryLineEventResearched ( const char * techID )

Pick a random base to research a story line event tech

Parameters

techID The event technology script id to research

Note: If there is no base available the tech is not marked as researched, too

Definition at line 774 of file cp_research.cpp.

References B_GetNext(), RS_GetTechByID(), RS_IsResearched_ptr(), and RS_MarkResearched().

Referenced by CP_CheckCampaignEvents().

◆ RS_ParseTechnologies()

void RS_ParseTechnologies	(	const char *	name,
		const char **	text )

Parses one "tech" entry in the research.ufo file and writes it into the next free entry in technologies (technology_t).

Parameters

[in]	name	Unique id of a technology_t. This is parsed from "tech xxx" -> id=xxx
[in]	text	the whole following text that is part of the "tech" item definition in research.ufo.

See also: CL_ParseScriptFirst; GAME_SetMode

Note: write into cp_campaignPool - free on every game restart and reparse

Todo: use cgi->Com_RegisterConstInt();

Definition at line 1134 of file cp_research.cpp.

References _, requirement_t::amount, ccs, cgi, Com_HashKey(), Com_Parse(), cp_campaignPool, linkedList_t::data, DEBUG_CLIENT, technology_t::description, ERR_DROP, hash, technology_t::hashNext, technology_t::hashProvidedNext, i, requirement_t::id, technology_t::id, technology_t::idx, requirements_t::links, technology_t::mail, MAX_DESCRIPTIONS, MAX_TECHLINKS, MAX_TECHNOLOGIES, techMail_t::model, name, linkedList_t::next, technologyDescriptions_t::numDescriptions, requirements_t::numLinks, technology_t::numTechMails, OBJZERO, technology_t::overallTime, technology_t::preDescription, technology_t::provides, Q_streq, redirectedTechs, technology_t::requireAND, technology_t::requireForProduction, technology_t::requireOR, RS_ALIEN, RS_ARMOUR, RS_BUILDING, RS_CRAFT, RS_CRAFTITEM, RS_LINK_ALIEN, RS_LINK_ALIEN_DEAD, RS_LINK_ALIEN_GLOBAL, RS_LINK_ANTIMATTER, RS_LINK_ITEM, RS_LINK_TECH, RS_LINK_TECH_NOT, RS_LINK_UFO, RS_LOGIC, RS_NEWS, RS_NONE, RS_TECH, RS_UGV, RS_WEAPON, technology_t::statusResearch, technology_t::statusResearchable, Sys_Error(), technologyDescriptions_t::tech, TECH_HASH_SIZE, techHash, techHashProvided, TECHMAIL_MAX, TECHMAIL_PRE, TECHMAIL_RESEARCHED, technologyDescriptions_t::text, technology_t::time, requirement_t::type, technology_t::type, technology_t::upChapter, technology_t::upNext, technology_t::upPrev, technologyDescriptions_t::usedDescription, valid_tech_vars, and valid_techmail_vars.

Referenced by CP_ParseScriptFirst().

◆ RS_RemoveFiredScientist()

void RS_RemoveFiredScientist	(	base_t *	base,
		Employee *	employee )

Remove one scientist from research project if needed.

Parameters

[in]	base	Pointer to base where a scientist should be removed.
[in]	employee	Pointer to the employee that is fired.

Note: used when a scientist is fired.; This function is called before the employee is actually fired.

Definition at line 731 of file cp_research.cpp.

References cgi, Employee::chr, E_GetUnassignedEmployee(), EMPL_SCIENTIST, base_t::idx, RS_AssignScientist(), RS_GetTechWithMostScientists(), RS_RemoveScientist(), Employee::setAssigned(), and character_t::ucn.

Referenced by Employee::unassign().

◆ RS_RemoveScientist()

void RS_RemoveScientist	(	technology_t *	tech,
		Employee *	employee )

Remove a scientist from a technology.

Parameters

[in]	tech	The technology you want to remove the scientist from.
[in]	employee	Employee you want to remove (nullptr if you don't care which one should be removed).

See also: RS_RemoveScientist_f; RS_AssignScientist

Definition at line 695 of file cp_research.cpp.

References technology_t::base, CAP_AddCurrent(), CAP_LABSPACE, cgi, E_GetAssignedEmployee(), EMPL_SCIENTIST, RS_PAUSED, technology_t::scientists, Employee::setAssigned(), and technology_t::statusResearch.

Referenced by RS_Change_f(), RS_RemoveFiredScientist(), RS_RemoveScientistsExceedingCapacity(), and RS_StopResearch().

◆ RS_RemoveScientistsExceedingCapacity()

void RS_RemoveScientistsExceedingCapacity ( base_t * base )

Remove all exceeding scientist.

Parameters

[in,out] base Pointer to base where a scientist should be removed.

Definition at line 1707 of file cp_research.cpp.

References CAP_GetFreeCapacity(), CAP_LABSPACE, CAP_SetCurrent(), RS_CountScientistsInBase(), RS_GetTechWithMostScientists(), and RS_RemoveScientist().

Referenced by CAP_CheckOverflow().

◆ RS_RequiredLinksAssign()

void RS_RequiredLinksAssign ( void )

Assign Link pointers to all required techs/items/etc...

Note: This replaces the RS_InitRequirementList function (since the switch to the _OR and _AND list)

< Use this so we do not change the original redirectedTechs pointer.

Definition at line 420 of file cp_research.cpp.

References ccs, cgi, linkedList_t::data, i, linkedList_t::next, requirements_t::numLinks, technology_t::redirect, redirectedTechs, technology_t::requireAND, technology_t::requireForProduction, technology_t::requireOR, RS_AssignTechLinks(), RS_GetTechByID(), and RS_GetTechByIDX().

Referenced by CP_ParseCampaignData().

◆ RS_RequirementsMet()

bool RS_RequirementsMet	(	const technology_t *	tech,
		const base_t *	base )

Checks if all requirements of a tech have been met so that it becomes researchable.

Note: If there are NO requirements defined at all it will always return true.

Parameters

[in]	tech	The technology we want to research
[in]	base	In what base to check the "collected" items etc..

Returns: true if all requirements are satisfied otherwise false.

Todo: Add support for the "delay" value.

Definition at line 151 of file cp_research.cpp.

References requirement_t::typelink_t::aircraft, AL_CountAll(), base_t::alienContainment, requirement_t::amount, B_AntimatterInBase(), B_ItemInBase(), cgi, DEBUG_CLIENT, AlienCargo::getAlive(), AlienCargo::getDead(), i, requirement_t::id, technology_t::id, requirement_t::link, requirements_t::links, requirements_t::numLinks, requirement_t::typelink_t::od, Q_streq, technology_t::requireAND, technology_t::requireOR, RS_IsResearched_ptr(), RS_LINK_ALIEN, RS_LINK_ALIEN_DEAD, RS_LINK_ALIEN_GLOBAL, RS_LINK_ANTIMATTER, RS_LINK_ITEM, RS_LINK_TECH, RS_LINK_TECH_NOT, RS_LINK_UFO, technology_t::statusResearchable, requirement_t::typelink_t::td, requirement_t::typelink_t::tech, requirement_t::type, and US_UFOsInStorage().

Referenced by RS_CheckRequirements(), RS_FillTechnologyList_f(), RS_MarkResearchable(), and RS_ResearchRun().

◆ RS_ResearchAllowed()

bool RS_ResearchAllowed ( const base_t * base )

Returns true if the current base is able to handle research.

See also: B_BaseInit_f probably menu function, but not for research gui

Definition at line 1840 of file cp_research.cpp.

References B_GetBuildingStatus(), B_IsUnderAttack, B_LAB, E_CountHired(), and EMPL_SCIENTIST.

Referenced by B_BaseInit_f(), B_BuildingOpenAfterClick_f(), RS_ResearchRun(), RS_ShowActiveResearch_f(), and TR_TransferStart().

◆ RS_ResearchFinish()

void RS_ResearchFinish ( technology_t * tech )

Sets a technology status to researched and updates the date.

Parameters

[in] tech The technology that was researched.

At this point we define what research-report description is used when displayed. (i.e. "usedDescription" is set here). That's because this is the first the player will see the research result and any later changes may make the content inconsistent for the player.

See also: RS_MarkOneResearchable

Definition at line 52 of file cp_research.cpp.

References _, technology_t::announce, ccs, cgi, Com_sprintf(), cp_messageBuffer, technology_t::description, technology_t::finishedResearchEvent, technology_t::id, technology_t::mailSent, MAILSENT_FINISHED, MSG_RESEARCH_FINISHED, MSO_CheckAddNewMessage(), technology_t::name, NT_RESEARCH_COMPLETED, technology_t::preDescription, technology_t::preResearchedDate, technology_t::researchedDate, RS_FINISH, RS_GetDescription(), RS_LOGIC, RS_StopResearch(), technology_t::statusResearch, technology_t::statusResearchable, technology_t::type, UP_OpenWith(), and technologyDescriptions_t::usedDescription.

Referenced by RS_InitTree(), RS_MarkResearchable(), and RS_MarkResearched().

◆ RS_ResearchRun()

int RS_ResearchRun ( void )

Checks the research status.

Todo: Needs to check on the exact time that elapsed since the last check of the status.

See also: RS_MarkResearched

Returns: The amout of new researched technologies

Definition at line 814 of file cp_research.cpp.

References _, technology_t::base, ccs, Com_sprintf(), cp_messageBuffer, i, MSG_RESEARCH_HALTED, MSO_CheckAddNewMessage(), technology_t::name, NT_RESEARCH_HALTED, RS_GetTechByIDX(), RS_MarkResearched(), RS_RequirementsMet(), RS_ResearchAllowed(), RS_RUNNING, RS_StopResearch(), technology_t::scientists, technology_t::statusResearch, and technology_t::time.

Referenced by CP_CampaignRun(), and TEST_F().

◆ RS_ResetTechs()

void RS_ResetTechs ( void )

This is called everytime RS_ParseTechnologies is called - to prevent cyclic hash tables.

Definition at line 1083 of file cp_research.cpp.

References cgi, OBJZERO, redirectedTechs, techHash, and techHashProvided.

Referenced by CP_ResetCampaignData().

◆ RS_SaveXML()

bool RS_SaveXML ( xmlNode_t * parent )

Save callback for research and technologies.

Parameters

[out] parent XML Node structure, where we write the information to

See also: RS_LoadXML

Todo: this should be handled by the mail system

Definition at line 1725 of file cp_research.cpp.

References technology_t::base, ccs, cgi, DateTime::getDateAsDays(), DateTime::getTimeAsSeconds(), i, technology_t::id, technology_t::mail, technology_t::mailSent, technology_t::preResearchedDate, techMail_t::read, technology_t::researchedDate, RS_GetTechByIDX(), SAVE_RESEARCH_BASE, SAVE_RESEARCH_DATE, SAVE_RESEARCH_ID, SAVE_RESEARCH_MAIL, SAVE_RESEARCH_MAIL_ID, SAVE_RESEARCH_MAILSENT, SAVE_RESEARCH_PREDATE, SAVE_RESEARCH_RESEARCH, SAVE_RESEARCH_SCIENTISTS, SAVE_RESEARCH_STATUSCOLLECTED, SAVE_RESEARCH_STATUSRESEARCH, SAVE_RESEARCH_STATUSRESEARCHABLE, SAVE_RESEARCH_TECH, SAVE_RESEARCH_TIME, SAVE_RESEARCHSTATUS_NAMESPACE, saveResearchConstants, technology_t::scientists, technology_t::statusCollected, technology_t::statusResearch, technology_t::statusResearchable, TECHMAIL_MAX, technology_t::time, and xmlNode_t.

Referenced by SAV_Init().

◆ RS_ScriptSanityCheck()

bool RS_ScriptSanityCheck ( void )

Checks the parsed tech data for errors.

Returns: false if there are errors - true otherwise

Todo: error++; Crafts still give errors - are there any definitions missing?

Definition at line 1850 of file cp_research.cpp.

References ccs, cgi, technology_t::description, i, technology_t::id, technology_t::name, technology_t::produceTime, technology_t::provides, RS_ALIEN, RS_BUILDING, RS_LOGIC, RS_NEWS, RS_TECH, technologyDescriptions_t::text, and technology_t::type.

◆ RS_StopResearch()

void RS_StopResearch ( technology_t * tech )

Stops a research (Removes scientists from it).

Parameters

[in] tech The technology that is being researched.

Definition at line 94 of file cp_research.cpp.

References RS_RemoveScientist(), and technology_t::scientists.

Referenced by B_AddToStorage(), RS_CheckRequirements(), RS_ResearchFinish(), RS_ResearchRun(), and RS_Stop_f().

Variable Documentation

◆ redirectedTechs

linkedList_t* redirectedTechs

static

Definition at line 46 of file cp_research.cpp.

Referenced by RS_ParseTechnologies(), RS_RequiredLinksAssign(), and RS_ResetTechs().

◆ techHash

technology_t* techHash[TECH_HASH_SIZE]

static

Definition at line 43 of file cp_research.cpp.

Referenced by RS_GetTechByID(), RS_GetTechIdxByName(), RS_ParseTechnologies(), and RS_ResetTechs().

◆ techHashProvided

technology_t* techHashProvided[TECH_HASH_SIZE]

static

Definition at line 44 of file cp_research.cpp.

Referenced by RS_GetTechByProvided(), RS_ParseTechnologies(), and RS_ResetTechs().

◆ valid_tech_vars

const value_t valid_tech_vars[]

static

Initial value:

                                     = {
    {"name", V_TRANSLATION_STRING, offsetof(technology_t, name), 0},
    {"provides", V_HUNK_STRING, offsetof(technology_t, provides), 0},
    {"event", V_HUNK_STRING, offsetof(technology_t, finishedResearchEvent), 0},
    {"delay", V_INT, offsetof(technology_t, delay), MEMBER_SIZEOF(technology_t, delay)},
    {"producetime", V_INT, offsetof(technology_t, produceTime), MEMBER_SIZEOF(technology_t, produceTime)},
    {"time", V_FLOAT, offsetof(technology_t, time), MEMBER_SIZEOF(technology_t, time)},
    {"announce", V_BOOL, offsetof(technology_t, announce), MEMBER_SIZEOF(technology_t, announce)},
    {"image", V_HUNK_STRING, offsetof(technology_t, image), 0},
    {"model", V_HUNK_STRING, offsetof(technology_t, mdl), 0},
 
    {nullptr, V_NULL, 0, 0}
}

The valid definition names in the research.ufo file.

Note: Handled in parser below. description, preDescription, requireAND, requireOR, up_chapter

Definition at line 1098 of file cp_research.cpp.

Referenced by RS_ParseTechnologies().

◆ valid_techmail_vars

const value_t valid_techmail_vars[]

static

Initial value:

                                         = {
    {"from", V_TRANSLATION_STRING, offsetof(techMail_t, from), 0},
    {"to", V_TRANSLATION_STRING, offsetof(techMail_t, to), 0},
    {"subject", V_TRANSLATION_STRING, offsetof(techMail_t, subject), 0},
    {"date", V_TRANSLATION_STRING, offsetof(techMail_t, date), 0},
    {"icon", V_HUNK_STRING, offsetof(techMail_t, icon), 0},
    {"model", V_HUNK_STRING, offsetof(techMail_t, model), 0},
 
    {nullptr, V_NULL, 0, 0}
}

The valid definition names in the research.ufo file for tech mails.

Definition at line 1115 of file cp_research.cpp.

Referenced by RS_ParseTechnologies().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ TECH_HASH_SIZE

Function Documentation

◆ RS_AssignScientist()

◆ RS_AssignTechLinks()

◆ RS_CheckRequirements()

◆ RS_CountScientistsInBase()

◆ RS_GetDescription()

◆ RS_GetTechByID()

◆ RS_GetTechByIDX()

◆ RS_GetTechByProvided()

◆ RS_GetTechForItem()

◆ RS_GetTechForTeam()

◆ RS_GetTechIdxByName()

◆ RS_GetTechWithMostScientists()

◆ RS_InitStartup()

◆ RS_InitTree()

◆ RS_IsResearched_idx()

◆ RS_IsResearched_ptr()

◆ RS_IsValidTechIndex()

◆ RS_LoadXML()

◆ RS_MarkCollected()

◆ RS_MarkOneResearchable()

◆ RS_MarkResearchable()

◆ RS_MarkResearched()

◆ RS_MarkStoryLineEventResearched()

◆ RS_ParseTechnologies()

◆ RS_RemoveFiredScientist()

◆ RS_RemoveScientist()

◆ RS_RemoveScientistsExceedingCapacity()

◆ RS_RequiredLinksAssign()

◆ RS_RequirementsMet()

◆ RS_ResearchAllowed()

◆ RS_ResearchFinish()

◆ RS_ResearchRun()

◆ RS_ResetTechs()

◆ RS_SaveXML()

◆ RS_ScriptSanityCheck()

◆ RS_StopResearch()

Variable Documentation

◆ redirectedTechs

◆ techHash

◆ techHashProvided

◆ valid_tech_vars

◆ valid_techmail_vars