Single player employee stuff. More...

#include "../../cl_shared.h"
#include "../cl_game.h"
#include "../cl_game_team.h"
#include "cp_campaign.h"
#include "cp_employee_callbacks.h"
#include "cp_rank.h"
#include "cp_popup.h"
#include "save/save_employee.h"

Functions
int	E_CountByType (employeeType_t type)
	Returns number of employees of a type. More...

Employee *	E_GetUnhired (employeeType_t type)
	Iterates through unhired employees. More...

void	E_HireForBuilding (base_t base, building_t building, int num)
	Hires some employees of appropriate type for a building. More...

bool	E_MoveIntoNewBase (Employee employee, base_t newBase)

const char *	E_GetEmployeeString (employeeType_t type, int n)
	Convert employeeType_t to translated string. More...

employeeType_t	E_GetEmployeeType (const char *type)
	Convert string to employeeType_t. More...

Employee *	E_GetUnhiredRobot (const ugv_t *ugvType)
	Return a "not hired" ugv-employee pointer of a given ugv-type. More...

int	E_GetHiredEmployees (const base_t const base, employeeType_t type, linkedList_t *hiredEmployees)
	Return a list of hired employees in the given base of a given type. More...

Employee *	E_GetHiredRobot (const base_t const base, const ugv_t ugvType)
	Return a "hired" ugv-employee pointer of a given ugv-type in a given base. More...

Employee *	E_GetAssignedEmployee (const base_t *const base, const employeeType_t type)
	Gets an unassigned employee of a given type from the given base. More...

Employee *	E_GetUnassignedEmployee (const base_t *const base, const employeeType_t type)
	Gets an assigned employee of a given type from the given base. More...

bool	E_HireEmployee (base_t base, Employee employee)
	Hires the employee in a base. More...

bool	E_HireEmployeeByType (base_t *base, employeeType_t type)
	Hires the first free employee of that type. More...

bool	E_HireRobot (base_t base, const ugv_t ugvType)
	Hires the first free employee of that type. More...

void	E_UnhireAllEmployees (base_t *base, employeeType_t type)
	Reset the hired flag for all employees of a given type in a given base. More...

Employee *	E_CreateEmployee (employeeType_t type, const nation_t nation, const ugv_t ugvType)
	Creates an entry of a new employee in the global list and assignes it to no building/base. More...

bool	E_DeleteEmployee (Employee *employee)
	Removes the employee completely from the game (buildings + global list). More...

void	E_DeleteAllEmployees (base_t *base)
	Removes all employees completely from the game (buildings + global list) from a given base. More...

int	E_CountHired (const base_t *const base, employeeType_t type)
	Counts hired employees of a given type in a given base. More...

int	E_CountHiredRobotByType (const base_t const base, const ugv_t ugvType)
	Counts 'hired' (i.e. bought or produced UGVs and other robots of a given ugv-type in a given base. More...

int	E_CountAllHired (const base_t *const base, const bool peopleOnly)
	Counts all hired employees of a given base. More...

int	E_CountUnhired (employeeType_t type)
	Counts unhired employees of a given type in a given base. More...

int	E_CountUnhiredRobotsByType (const ugv_t *ugvType)
	Counts all available Robots/UGVs that are for sale. More...

int	E_CountUnassigned (const base_t *const base, employeeType_t type)
	Counts unassigned employees of a given type in a given base. More...

void	E_InitialEmployees (const campaign_t *campaign)
	Create initial hireable employees. More...

Employee *	E_GetEmployeeByTypeFromChrUCN (employeeType_t type, int uniqueCharacterNumber)
	Searches employee from a type for the ucn (character id) More...

Employee *	E_GetEmployeeFromChrUCN (int uniqueCharacterNumber)
	Searches all employee for the ucn (character id) More...

bool	E_SaveXML (xmlNode_t *p)
	Save callback for savegames in XML Format. More...

bool	E_LoadXML (xmlNode_t *p)
	Load callback for savegames in XML Format. More...

bool	E_HireAllowed (const base_t *base)
	Returns true if the current base is able to handle employees. More...

void	E_RemoveInventoryFromStorage (Employee *employee)
	Removes the items of an employee (soldier) from the base storage (s)he is hired at. More...

void	E_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. More...

void	E_Shutdown (void)
	Closing actions for employee-subsystem. More...

Variables
static const cmdList_t	debugEmployeeCmds []

Detailed Description

Single player employee stuff.

Note: Employee related functions prefix: E_

Definition in file cp_employee.cpp.

Function Documentation

int E_CountAllHired	(	const base_t *const	base,
		const bool	peopleOnly
	)

Counts all hired employees of a given base.

Parameters

[in]	base	The base where we count
[in]	peopleOnly	Count people only (skip robots)

Returns: count of hired employees of a given type in a given base

Definition at line 688 of file cp_employee.cpp.

References count, E_CountHired(), EMPL_ROBOT, i, MAX_EMPL, and type.

Referenced by B_ResetAllStatusAndCapacities(), and E_UpdateGUICount_f().

int E_CountByType ( employeeType_t type )

Returns number of employees of a type.

Parameters

[in] type Employeetype to check

Definition at line 39 of file cp_employee.cpp.

References ccs, cgi, and ccs_s::employees.

Referenced by CP_BaseAttackPrepareBattle(), and E_HireForBuilding().

int E_CountHired	(	const base_t *const	base,
		employeeType_t	type
	)

Counts hired employees of a given type in a given base.

Parameters

[in]	base	The base where we count (`nullptr` to count all).
[in]	type	The type of employee to search.

Returns: count of hired employees of a given type in a given base

Definition at line 649 of file cp_employee.cpp.

References count, and E_Foreach.

Referenced by CAP_UpdateStorageCap(), E_CountAllHired(), E_GetCounts_f(), E_UpdateGUICount_f(), PR_ProductionAllowed(), PR_ProductionInfo(), PR_ProductionList_f(), PR_UpdateProductionCap(), PR_WorkersAvailable(), RS_Change_f(), RS_FillTechnologyList_f(), RS_Max_f(), RS_ResearchAllowed(), RS_Stop_f(), TEST_F(), and TR_FillEmployees().

int E_CountHiredRobotByType	(	const base_t *const	base,
		const ugv_t *	ugvType
	)

Counts 'hired' (i.e. bought or produced UGVs and other robots of a given ugv-type in a given base.

Parameters

[in]	base	The base where we count (`nullptr` to count all).
[in]	ugvType	What type of robot/ugv we are looking for.

Returns: Count of Robots/UGVs.

Definition at line 668 of file cp_employee.cpp.

References count, E_Foreach, and EMPL_ROBOT.

int E_CountUnassigned	(	const base_t *const	base,
		employeeType_t	type
	)

Counts unassigned employees of a given type in a given base.

Parameters

[in]	type	The type of employee to search.
[in]	base	The base where we count

Definition at line 741 of file cp_employee.cpp.

References count, and E_Foreach.

Referenced by RS_Change_f(), RS_FillTechnologyList_f(), RS_Max_f(), and RS_Stop_f().

int E_CountUnhired ( employeeType_t type )

Counts unhired employees of a given type in a given base.

Parameters

[in] type The type of employee to search.

Returns: count of hired employees of a given type in a given base

Definition at line 709 of file cp_employee.cpp.

References count, and E_Foreach.

Referenced by TEST_F().

int E_CountUnhiredRobotsByType ( const ugv_t * ugvType )

Counts all available Robots/UGVs that are for sale.

Parameters

[in] ugvType What type of robot/ugv we are looking for.

Returns: count of available robots/ugvs.

Definition at line 725 of file cp_employee.cpp.

References count, E_Foreach, and EMPL_ROBOT.

Referenced by BS_Buy_f(), BS_BuyUGV(), and BS_FillMarket_f().

Employee* E_CreateEmployee	(	employeeType_t	type,
		const nation_t *	nation,
		const ugv_t *	ugvType
	)

Creates an entry of a new employee in the global list and assignes it to no building/base.

Parameters

[in]	type	What type of employee to create.
[in]	nation	What nation the employee (mainly used for soldiers in singleplayer) comes from.
[in]	ugvType	What type of ugv this employee is.

Returns: Pointer to the newly created employee in the global list. nullptr if something goes wrong.

See also: E_DeleteEmployee

Definition at line 540 of file cp_employee.cpp.

References ugv_s::actors, ccs, cgi, Employee::chr, CL_GetRankIdx(), Com_sprintf(), DEBUG_CLIENT, EMPL_PILOT, EMPL_ROBOT, EMPL_SCIENTIST, EMPL_SOLDIER, EMPL_WORKER, ccs_s::employees, ERR_DROP, GAME_CP_GetTeamDef(), LIST_Add(), MAX_EMPL, MAX_VAR, Q_strncpyz(), chrScoreGlobal_s::rank, and character_s::score.

Referenced by E_InitialEmployees(), NAT_HandleBudget(), and TEST_F().

void E_DeleteAllEmployees ( base_t * base )

Removes all employees completely from the game (buildings + global list) from a given base.

Note: Used if the base e.g is destroyed by the aliens.

Parameters

[in] base Which base the employee should be fired from.

Definition at line 630 of file cp_employee.cpp.

References E_DeleteEmployee(), E_Foreach, EMPL_SOLDIER, i, MAX_EMPL, and type.

Referenced by B_Destroy(), and TEST_F().

bool E_DeleteEmployee ( Employee * employee )

Removes the employee completely from the game (buildings + global list).

Parameters

[in] employee The pointer to the employee you want to remove.

Returns: True if the employee was removed successfully, otherwise false.

See also: E_CreateEmployee

Note: This function has the side effect, that the global employee number for the given employee type is reduced by one, also the ccs.employees pointers are moved to fill the gap of the removed employee. Thus pointers like acTeam in the aircraft can point to wrong employees now. This has to be taken into account

Definition at line 602 of file cp_employee.cpp.

References Employee::baseHired, ccs, cgi, ccs_s::employees, Employee::getType(), Employee::transfer, type, and Employee::unhire().

Referenced by AIR_DestroyAircraft(), CP_MissionEnd(), CP_SpawnRescueMission(), E_DeleteAllEmployees(), E_EmployeeDelete_f(), TEST_F(), and TR_EmptyTransferCargo().

Employee* E_GetAssignedEmployee	(	const base_t *const	base,
		const employeeType_t	type
	)

Gets an unassigned employee of a given type from the given base.

Parameters

[in]	base	Which base the employee should be hired in.
[in]	type	The type of employee to search.

Returns: Employee

See also: E_EmployeeIsUnassigned

Note: assigned is not hired - they are already hired in a base, in a quarter and working in another building.

Definition at line 334 of file cp_employee.cpp.

References E_Foreach.

Referenced by RS_RemoveScientist().

Employee* E_GetEmployeeByTypeFromChrUCN	(	employeeType_t	type,
		int	uniqueCharacterNumber
	)

Searches employee from a type for the ucn (character id)

Parameters

[in]	type	employee type
[in]	uniqueCharacterNumber	unique character number (UCN)

Definition at line 832 of file cp_employee.cpp.

References E_Foreach.

Referenced by AIR_GetPilot(), BS_Buy_f(), BS_ShowInfo_f(), and E_GetEmployeeFromChrUCN().

Employee* E_GetEmployeeFromChrUCN ( int uniqueCharacterNumber )

Searches all employee for the ucn (character id)

Parameters

[in] uniqueCharacterNumber unique character number (UCN)

Definition at line 846 of file cp_employee.cpp.

References E_GetEmployeeByTypeFromChrUCN(), EMPL_SOLDIER, i, and MAX_EMPL.

Referenced by AIR_LoadAircraftXML(), CHAR_UpdateData(), CP_TEAM_AssignSoldierByUCN_f(), CP_TEAM_ChangeSkin_f(), CP_TEAM_DeEquipActor_f(), CP_TEAM_SelectActorByUCN_f(), E_ChangeName_f(), GAME_CP_GetSelectedChr(), TR_Add_f(), and TR_LoadXML().

const char* E_GetEmployeeString	(	employeeType_t	type,
		int	n
	)

Convert employeeType_t to translated string.

Parameters

type	employeeType_t value
n	number of persons of that kind (for plural detection)

Returns: translated employee string

Definition at line 189 of file cp_employee.cpp.

References cgi, EMPL_PILOT, EMPL_ROBOT, EMPL_SCIENTIST, EMPL_SOLDIER, EMPL_WORKER, ERR_DROP, and ngettext.

Referenced by E_GetCounts_f(), HOS_GetRank(), NAT_HandleBudget(), TR_CargoList(), TR_FillEmployees(), and TR_List_f().

employeeType_t E_GetEmployeeType ( const char * type )

Convert string to employeeType_t.

Parameters

type	Pointer to employee type string

Returns: employeeType_t

Todo:: use cgi->Com_ConstInt*

Definition at line 213 of file cp_employee.cpp.

References EMPL_PILOT, EMPL_ROBOT, EMPL_SCIENTIST, EMPL_SOLDIER, EMPL_WORKER, MAX_EMPL, and Q_streq.

Referenced by CL_ParseRanks(), and CP_TEAM_FillEmployeeList_f().

int E_GetHiredEmployees	(	const base_t *const	base,
		employeeType_t	type,
		linkedList_t **	hiredEmployees
	)

Return a list of hired employees in the given base of a given type.

Parameters

[in]	base	Which base the employee should be searched in. If nullptr is given employees in all bases will be listed.
[in]	type	Which employee type to search for.
[out]	hiredEmployees	Linked list of hired employees in the base.

Returns: Number of hired employees in the base that are currently not on a transfer. Or -1 in case of an error.

Definition at line 273 of file cp_employee.cpp.

References cgi, E_Foreach, and MAX_EMPL.

Referenced by E_GetHiredRobot().

Employee* E_GetHiredRobot	(	const base_t *const	base,
		const ugv_t *	ugvType
	)

Return a "hired" ugv-employee pointer of a given ugv-type in a given base.

Parameters

[in]	base	Which base the ugv should be searched in.c
[in]	ugvType	What type of robot we want.

Returns: Employee pointer on success or nullptr on error.

See also: E_GetUnhiredRobot

Definition at line 301 of file cp_employee.cpp.

References cgi, DEBUG_CLIENT, E_GetHiredEmployees(), EMPL_ROBOT, and LIST_Foreach.

Employee* E_GetUnassignedEmployee	(	const base_t *const	base,
		const employeeType_t	type
	)

Gets an assigned employee of a given type from the given base.

Parameters

[in]	base	Which base the employee should be hired in.
[in]	type	The type of employee to search.

Returns: Employee

See also: E_EmployeeIsUnassigned

Note: unassigned is not unhired - they are already hired in a base but are at quarters

Definition at line 353 of file cp_employee.cpp.

References E_Foreach.

Referenced by RS_AssignScientist(), RS_Max_f(), and RS_RemoveFiredScientist().

Employee* E_GetUnhired ( employeeType_t type )

Iterates through unhired employees.

Parameters

[in] type Employee type to look for

See also: employeeType_t

Definition at line 49 of file cp_employee.cpp.

References E_Foreach.

Referenced by E_HireEmployeeByType().

Employee* E_GetUnhiredRobot ( const ugv_t * ugvType )

Return a "not hired" ugv-employee pointer of a given ugv-type.

Parameters

[in] ugvType What type of robot we want.

Returns: Employee pointer on success or nullptr on error.

See also: E_GetHiredRobot

Definition at line 253 of file cp_employee.cpp.

References E_Foreach, and EMPL_ROBOT.

Referenced by E_HireRobot().

bool E_HireAllowed ( const base_t * base )

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

See also: B_BaseInit_f

Definition at line 985 of file cp_employee.cpp.

References B_GetBuildingStatus(), B_IsUnderAttack, and B_QUARTERS.

Referenced by B_BaseInit_f(), and B_BuildingOpenAfterClick_f().

bool E_HireEmployee	(	base_t *	base,
		Employee *	employee
	)

Hires the employee in a base.

Parameters

[in]	base	Which base the employee should be hired in
[in]	employee	Which employee to hire

See also: E_HireEmployeeByType

Todo:: handle EMPL_ROBOT capacities here?

Todo:: shouldn't we link CID_EQUIP here already to the base inventory equip container?

Definition at line 373 of file cp_employee.cpp.

References _, AIR_AutoAddPilotToAircraft(), Employee::baseHired, CAP_AddCurrent(), CAP_EMPLOYEES, CAP_GetFreeCapacity(), CAP_ITEMS, CP_Popup(), EMPL_PILOT, EMPL_ROBOT, EMPL_SCIENTIST, EMPL_SOLDIER, EMPL_WORKER, Employee::getType(), MAX_EMPL, PR_UpdateProductionCap(), and UGV_SIZE.

Referenced by E_EmployeeHire_f(), E_HireEmployeeByType(), E_HireRobot(), and TEST_F().

bool E_HireEmployeeByType	(	base_t *	base,
		employeeType_t	type
	)

Hires the first free employee of that type.

Parameters

[in]	base	Which base the employee should be hired in
[in]	type	Which employee type do we search

See also: E_HireEmployee

Definition at line 414 of file cp_employee.cpp.

References E_GetUnhired(), and E_HireEmployee().

Referenced by B_SetUpFirstBase(), and E_HireForBuilding().

void E_HireForBuilding	(	base_t *	base,
		building_t *	building,
		int	num
	)

Hires some employees of appropriate type for a building.

Parameters

[in]	base	Which base the employee should be hired in.
[in]	building	in which building
[in]	num	how many employees, if -1, hire building->maxEmployees

See also: B_SetUpBase

Definition at line 107 of file cp_employee.cpp.

References B_HANGAR, B_LAB, B_MISC, B_WORKSHOP, building_s::buildingType, cgi, DEBUG_CLIENT, E_CountByType(), E_HireEmployeeByType(), EMPL_SCIENTIST, EMPL_SOLDIER, EMPL_WORKER, and building_s::maxEmployees.

Referenced by B_AddBuildingToBasePos().

bool E_HireRobot	(	base_t *	base,
		const ugv_t *	ugvType
	)

Hires the first free employee of that type.

Parameters

[in]	base	Which base the ugv/robot should be hired in.
[in]	ugvType	What type of ugv/robot should be hired.

Returns: true if everything went ok (the ugv was added), otherwise false.

Definition at line 426 of file cp_employee.cpp.

References E_GetUnhiredRobot(), and E_HireEmployee().

Referenced by BS_BuyUGV().

void E_InitialEmployees ( const campaign_t * campaign )

Create initial hireable employees.

Todo:: don't use hardcoded UGV ids

Definition at line 759 of file cp_employee.cpp.

References cgi, cgame_import_s::Com_GetUGVByID(), E_CreateEmployee(), EMPL_PILOT, EMPL_ROBOT, EMPL_SCIENTIST, EMPL_SOLDIER, EMPL_WORKER, frand(), i, NAT_GetRandom(), campaign_s::pilots, campaign_s::scientists, campaign_s::soldiers, campaign_s::ugvs, and campaign_s::workers.

Referenced by CP_CampaignInit(), and CreateBase().

void E_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.

Definition at line 1027 of file cp_employee.cpp.

References cgi, and E_InitCallbacks().

Referenced by CP_InitStartup().

bool E_LoadXML ( xmlNode_t * p )

Load callback for savegames in XML Format.

Parameters

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

Note: e->transfer is restored in cl_transfer.c:TR_Load

Definition at line 909 of file cp_employee.cpp.

References B_AtLeastOneExists, B_GetBaseByIDX(), Employee::baseHired, ccs, cgi, Employee::chr, cgame_import_s::Com_GetUGVByIDSilent(), ccs_s::employees, LIST_Add(), MAX_EMPL, NAT_GetNationByID(), OBJZERO, SAVE_EMPLOYEE_ASSIGNED, SAVE_EMPLOYEE_BASEHIRED, SAVE_EMPLOYEE_CHR, SAVE_EMPLOYEE_EMPLOYEE, SAVE_EMPLOYEE_EMPLOYEES, SAVE_EMPLOYEE_NATION, SAVE_EMPLOYEE_TYPE, SAVE_EMPLOYEE_UGV, SAVE_EMPLOYEETYPE_NAMESPACE, saveEmployeeConstants, Employee::setAssigned(), type, cgame_import_s::XML_GetNextNode(), cgame_import_s::XML_GetNode(), cgame_import_s::XML_GetString(), and xmlNode_t.

Referenced by SAV_Init().

bool E_MoveIntoNewBase	(	Employee *	employee,
		base_t *	newBase
	)

Will change the base where the employee is located in and will also update the capacity in the affected bases.

Note: Doesn't make any capacity checks and the employee must be hired already.

Parameters

employee	The employee to change the base for
newBase	The base where the employee should be located at

Returns: false if employee was a nullptr pointer

Definition at line 151 of file cp_employee.cpp.

References Employee::baseHired, CAP_AddCurrent(), CAP_EMPLOYEES, CAP_ITEMS, EMPL_PILOT, EMPL_ROBOT, EMPL_SCIENTIST, EMPL_SOLDIER, EMPL_WORKER, Employee::getType(), MAX_EMPL, PR_UpdateProductionCap(), and UGV_SIZE.

Referenced by AIR_MoveAircraftIntoNewHomebase(), and TR_TransferStart().

void E_RemoveInventoryFromStorage ( Employee * employee )

Removes the items of an employee (soldier) from the base storage (s)he is hired at.

Parameters

[in] employee Pointer to the soldier whose items should be removed

Definition at line 996 of file cp_employee.cpp.

References Item::ammoDef(), B_AddToStorage(), Employee::baseHired, Employee::chr, Item::def(), Inventory::getNextCont(), Container::getNextItem(), and character_s::inv.

Referenced by AIR_DestroyAircraft(), and AM_UpdateSurivorsAfterBattle().

bool E_SaveXML ( xmlNode_t * p )

Save callback for savegames in XML Format.

Parameters

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

See also: E_LoadXML; SAV_GameSaveXML; G_SendCharacterData; CP_ParseCharacterData; GAME_SendCurrentTeamSpawningInfo

Note: e->transfer is not saved here because it'll be restored via TR_Load.

Definition at line 870 of file cp_employee.cpp.

References cgi, cgame_import_s::Com_GetConstVariable(), E_Foreach, i, MAX_EMPL, SAVE_EMPLOYEE_ASSIGNED, SAVE_EMPLOYEE_BASEHIRED, SAVE_EMPLOYEE_CHR, SAVE_EMPLOYEE_EMPLOYEE, SAVE_EMPLOYEE_EMPLOYEES, SAVE_EMPLOYEE_NATION, SAVE_EMPLOYEE_TYPE, SAVE_EMPLOYEE_UGV, SAVE_EMPLOYEETYPE_NAMESPACE, saveEmployeeConstants, cgame_import_s::XML_AddNode(), and xmlNode_t.

Referenced by SAV_Init().

void E_Shutdown ( void )

Closing actions for employee-subsystem.

Definition at line 1036 of file cp_employee.cpp.

References ccs, cgi, E_ShutdownCallbacks(), EMPL_SOLDIER, ccs_s::employees, and MAX_EMPL.

Referenced by CP_Shutdown().

void E_UnhireAllEmployees	(	base_t *	base,
		employeeType_t	type
	)

Reset the hired flag for all employees of a given type in a given base.

Parameters

[in]	base	Which base the employee should be fired from.
[in]	type	Which employee type do we search.

Definition at line 518 of file cp_employee.cpp.

References E_Foreach, and MAX_EMPL.

Variable Documentation

const cmdList_t debugEmployeeCmds[]

static

Initial value:

= {
    {nullptr, nullptr, nullptr}
}

Definition at line 1016 of file cp_employee.cpp.

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation