Header for employee related stuff. More...

This graph shows which files directly or indirectly include this file:

Data Structures
class	Employee

Macros
#define	E_Foreach(employeeType, var)

Enumerations
enum	employeeType_t { EMPL_SOLDIER , EMPL_SCIENTIST , EMPL_WORKER , EMPL_PILOT , EMPL_ROBOT , MAX_EMPL }
	The types of employees. More...

Functions
Employee *	E_CreateEmployee (employeeType_t type, const struct nation_s nation, const struct ugv_s ugvType=nullptr)
bool	E_DeleteEmployee (Employee *employee)
	Removes the employee completely from the game (buildings + global list).
int	E_CountByType (employeeType_t type)
	Returns number of employees of a type.
int	E_CountHired (const base_t *const base, employeeType_t type)
	Counts hired employees of a given type in a given base.
int	E_CountHiredRobotByType (const base_t const base, const struct ugv_s ugvType)
int	E_CountAllHired (const base_t *const base, const bool peopleOnly=false)
	Counts all hired employees of a given base.
int	E_CountUnhired (employeeType_t type)
	Counts unhired employees of a given type in a given base.
int	E_CountUnhiredRobotsByType (const struct ugv_s *ugvType)
int	E_CountUnassigned (const base_t *const base, employeeType_t type)
	Counts unassigned employees of a given type in a given base.
bool	E_HireEmployee (base_t base, Employee employee)
	Hires the employee in a base.
bool	E_HireEmployeeByType (base_t *base, employeeType_t type)
	Hires the first free employee of that type.
bool	E_HireRobot (base_t base, const struct ugv_s ugvType)
bool	E_UnhireEmployee (Employee *employee)
employeeType_t	E_GetEmployeeType (const char *type)
	Convert string to employeeType_t.
const char *	E_GetEmployeeString (employeeType_t type, int n)
	Convert employeeType_t to translated string.
Employee *	E_GetUnhired (employeeType_t type)
	Iterates through unhired employees.
Employee *	E_GetUnhiredRobot (const struct ugv_s *ugvType)
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.
Employee *	E_GetHiredRobot (const base_t const base, const struct ugv_s ugvType)
Employee *	E_GetUnassignedEmployee (const base_t *const base, employeeType_t type)
	Gets an assigned employee of a given type from the given base.
Employee *	E_GetAssignedEmployee (const base_t *const base, employeeType_t type)
	Gets an unassigned employee of a given type from the given base.
Employee *	E_GetEmployeeFromChrUCN (int uniqueCharacterNumber)
	Searches all employee for the ucn (character id).
Employee *	E_GetEmployeeByTypeFromChrUCN (employeeType_t type, int uniqueCharacterNumber)
	Searches employee from a type for the ucn (character id).
void	E_UnhireAllEmployees (base_t *base, employeeType_t type)
	Reset the hired flag for all employees of a given type in a given base.
void	E_DeleteAllEmployees (base_t *base)
	Removes all employees completely from the game (buildings + global list) from a given base.
void	E_HireForBuilding (base_t base, building_t building, int num)
	Hires some employees of appropriate type for a building.
void	E_InitialEmployees (const struct campaign_s *campaign)
bool	E_MoveIntoNewBase (Employee employee, base_t newBase)
void	E_RemoveInventoryFromStorage (Employee *employee)
	Removes the items of an employee (soldier) from the base storage (s)he is hired at.
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.
void	E_Shutdown (void)
	Closing actions for employee-subsystem.

Detailed Description

Header for employee related stuff.

Definition in file cp_employee.h.

Macro Definition Documentation

◆ E_Foreach

#define E_Foreach	(		employeeType,
			var )

Value:

LIST_Foreach(ccs.employees[employeeType], Employee, var)

Employee

Definition cp_employee.h:40

ccs

ccs_t ccs

Definition cp_campaign.cpp:63

LIST_Foreach

#define LIST_Foreach(list, type, var)

Iterates over a linked list, it's safe to delete the returned entry from the list while looping over ...

Definition list.h:41

Definition at line 122 of file cp_employee.h.

Referenced by AIR_AssignInitial(), BS_FillMarket_f(), CHAR_UpdateStats(), CP_BaseAttackStartMission(), CP_CleanTempInventory(), CP_CleanupTeam(), CP_MissionEnd(), CP_TEAM_FillBDEFEmployeeList_f(), CP_TEAM_FillEmployeeList_f(), CP_TEAM_FillEquipSoldierList_f(), E_CountHired(), E_CountHiredRobotByType(), E_CountUnassigned(), E_CountUnhired(), E_CountUnhiredRobotsByType(), E_DeleteAllEmployees(), E_EmployeeList_f(), E_GetAssignedEmployee(), E_GetEmployeeByTypeFromChrUCN(), E_GetHiredEmployees(), E_GetUnassignedEmployee(), E_GetUnhired(), E_GetUnhiredRobot(), E_SaveXML(), E_UnhireAllEmployees(), HOS_HospitalRun(), HOS_Init_f(), NAT_HandleBudget(), STAT_GetExpenses_f(), TEST_F(), TEST_F(), TR_Add_f(), and TR_FillEmployees().

Enumeration Type Documentation

◆ employeeType_t

enum employeeType_t

The types of employees.

Enumerator
EMPL_SOLDIER
EMPL_SCIENTIST
EMPL_WORKER
EMPL_PILOT
EMPL_ROBOT
MAX_EMPL	For counting over all available enums.

Definition at line 30 of file cp_employee.h.

Function Documentation

◆ E_CountAllHired()

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().

◆ E_CountByType()

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 type.

Referenced by CP_BaseAttackPrepareBattle(), and E_HireForBuilding().

◆ E_CountHired()

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, E_Foreach, and type.

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(), TEST_F(), TEST_F(), TEST_F(), and TR_FillEmployees().

◆ E_CountHiredRobotByType()

int E_CountHiredRobotByType	(	const base_t *const	base,
		const struct ugv_s *	ugvType )

References type.

◆ E_CountUnassigned()

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, E_Foreach, and type.

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

◆ E_CountUnhired()

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, E_Foreach, and type.

Referenced by TEST_F().

◆ E_CountUnhiredRobotsByType()

int E_CountUnhiredRobotsByType ( const struct ugv_s * ugvType )

References type.

◆ E_CreateEmployee()

Employee * E_CreateEmployee	(	employeeType_t	type,
		const struct nation_s *	nation,
		const struct ugv_s *	ugvType = nullptr )

References type.

◆ E_DeleteAllEmployees()

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(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ E_DeleteEmployee()

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, 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().

◆ E_GetAssignedEmployee()

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, and type.

Referenced by RS_RemoveScientist().

◆ E_GetEmployeeByTypeFromChrUCN()

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, and type.

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

◆ 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().

◆ E_GetEmployeeString()

const char * E_GetEmployeeString	(	employeeType_t	type,
		int	n )

extern

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, ngettext, and type.

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

◆ E_GetEmployeeType()

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, Q_streq, and type.

Referenced by CL_ParseRanks(), and CP_TEAM_FillEmployeeList_f().

◆ E_GetHiredEmployees()

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.