cp_transfer.h File Reference

Header file for Transfer stuff. More...

Go to the source code of this file.

Data Structures
struct	transfer_s
	Transfer information (they are being stored in ccs.transfers). More...

Macros
#define	DEFAULT_TRANSFER_TIME   2.0f
	Default transfer time for cases with no source/dest base. More...
#define	TR_Foreach(var)   LIST_Foreach(ccs.transfers, transfer_t, var)
#define	TR_ForeachEmployee(var, transfer, employeeType)   LIST_Foreach(transfer->employees[employeeType], Employee, var)
#define	TR_ForeachAircraft(var, transfer)   LIST_Foreach(transfer->aircraft, aircraft_t, var)

Typedefs
typedef struct transfer_s	transfer_t
	Transfer information (they are being stored in ccs.transfers). More...

Functions
void	TR_TransferRun (void)
	Checks whether given transfer should be processed. More...
void	TR_NotifyAircraftRemoved (const aircraft_t *aircraft)
	Notify that an aircraft has been removed. More...
transfer_t *	TR_TransferStart (base_t *srcBase, transfer_t &transData)
	Starts a transfer. More...
void	TR_InitStartup (void)
	Defines commands and cvars for the Transfer menu(s). More...
void	TR_Shutdown (void)
	Closing actions for transfer-subsystem. More...

Detailed Description

Header file for Transfer stuff.

Definition in file cp_transfer.h.

Macro Definition Documentation

#define DEFAULT_TRANSFER_TIME   2.0f

Default transfer time for cases with no source/dest base.

Definition at line 28 of file cp_transfer.h.

Referenced by TR_TransferStart().

#define TR_Foreach

(

var

)

LIST_Foreach(ccs.transfers, transfer_t, var)

Definition at line 46 of file cp_transfer.h.

Referenced by TR_DestinationCapacityList_f(), TR_List_f(), TR_NotifyAircraftRemoved(), TR_SaveXML(), TR_Shutdown(), and TR_TransferRun().

#define TR_ForeachAircraft	(		var,
			transfer
	)		LIST_Foreach(transfer->aircraft, aircraft_t, var)

Definition at line 48 of file cp_transfer.h.

Referenced by TR_EmptyTransferCargo(), TR_List_f(), and TR_SaveXML().

#define TR_ForeachEmployee	(		var,
			transfer,
			employeeType
	)		LIST_Foreach(transfer->employees[employeeType], Employee, var)

Definition at line 47 of file cp_transfer.h.

Referenced by TR_EmptyTransferCargo(), TR_List_f(), and TR_SaveXML().

Typedef Documentation

typedef struct transfer_s transfer_t

Transfer information (they are being stored in ccs.transfers).

Function Documentation

void TR_InitStartup

(

void

)

Defines commands and cvars for the Transfer menu(s).

See also

UI_InitStartup

Definition at line 567 of file cp_transfer.cpp.

References cgi, and TR_InitCallbacks().

Referenced by CP_InitStartup().

void TR_NotifyAircraftRemoved

(

const aircraft_t *

aircraft

)

Notify that an aircraft has been removed.

Parameters

[in]

aircraft

Aircraft that was removed from the game

See also

AIR_DeleteAircraft

Definition at line 291 of file cp_transfer.cpp.

References cgi, and TR_Foreach.

Referenced by AIR_DeleteAircraft().

void TR_Shutdown

(

void

)

Closing actions for transfer-subsystem.

Definition at line 578 of file cp_transfer.cpp.

References ccs, cgi, EMPL_SOLDIER, MAX_EMPL, TR_Foreach, TR_ShutdownCallbacks(), and ccs_s::transfers.

Referenced by CP_Shutdown().

void TR_TransferRun

(

void

)

Checks whether given transfer should be processed.

See also

CP_CampaignRun

Definition at line 306 of file cp_transfer.cpp.

References Date_IsDue(), TR_Foreach, and TR_TransferEnd().

Referenced by CP_CampaignRun(), and TEST_F().

transfer_t* TR_TransferStart	(	base_t *	srcBase,
		transfer_t &	transData
	)

Starts a transfer.

Parameters

[in]	srcBase	start transfer from this base
[in]	transData	Container holds transfer details

Definition at line 158 of file cp_transfer.cpp.

References AlienContainment::add(), AIR_AircraftGetFromIDX(), AIR_GetFirstFromBase(), AIR_GetHangarCapacityType(), AIR_IsEmployeeInAircraft(), AIR_RemoveEmployee(), AIR_TRANSFER, transfer_s::aircraft, base_s::aircraftCurrent, transfer_s::alienCargo, base_s::alienContainment, transfer_s::antimatter, B_AddAntimatter(), B_AddToStorage(), B_ItemIsStoredInBaseStorage(), CAP_AddCurrent(), ccs, cgi, count, ccs_s::date, date_s::day, DEFAULT_TRANSFER_TIME, transfer_s::destBase, E_MoveIntoNewBase(), transfer_s::employees, transfer_s::event, GetDistanceOnGlobe(), transfer_s::hasEmployees, i, aircraft_s::idx, transfer_s::itemCargo, ItemCargo::list(), AlienCargo::list(), LIST_Add(), LIST_Foreach, cgame_import_s::LIST_GetPointer(), MAX_EMPL, OBJZERO, base_s::pos, PR_ProductionAllowed(), RS_ResearchAllowed(), date_s::sec, SECONDS_PER_DAY, transfer_s::srcBase, and ccs_s::transfers.

Referenced by TEST_F(), and TR_TransferStart_f().