cp_transfer.h File Reference

Header file for Transfer stuff. More...

#include "../../DateTime.h"

Include dependency graph for cp_transfer.h:

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

Go to the source code of this file.

Data Structures
struct	transfer_t
	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.
#define	TR_Foreach(var)
#define	TR_ForeachEmployee(var, transfer, employeeType)
#define	TR_ForeachAircraft(var, transfer)

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

Detailed Description

Header file for Transfer stuff.

Definition in file cp_transfer.h.

Macro Definition Documentation

DEFAULT_TRANSFER_TIME

#define DEFAULT_TRANSFER_TIME   2.0f

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

Definition at line 30 of file cp_transfer.h.

Referenced by TR_TransferStart().

TR_Foreach

#define TR_Foreach

(

var

)

Value:

LIST_Foreach(ccs.transfers, transfer_t, var)

Definition at line 48 of file cp_transfer.h.

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

TR_ForeachAircraft

#define TR_ForeachAircraft	(		var,
			transfer )

Value:

LIST_Foreach(transfer->aircraft, aircraft_t, var)

Definition at line 50 of file cp_transfer.h.

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

TR_ForeachEmployee

#define TR_ForeachEmployee	(		var,
			transfer,
			employeeType )

Value:

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

Definition at line 49 of file cp_transfer.h.

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

Function Documentation

TR_InitStartup()

void TR_InitStartup

(

void

)

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

See also

UI_InitStartup

Definition at line 569 of file cp_transfer.cpp.

References cgi, and TR_InitCallbacks().

Referenced by CP_InitStartup().

TR_NotifyAircraftRemoved()

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 285 of file cp_transfer.cpp.

References cgi, and TR_Foreach.

Referenced by AIR_DeleteAircraft().

TR_Shutdown()

void TR_Shutdown

(

void

)

Closing actions for transfer-subsystem.

Definition at line 580 of file cp_transfer.cpp.

References ccs, cgi, EMPL_SOLDIER, i, MAX_EMPL, TR_Foreach, and TR_ShutdownCallbacks().

Referenced by CP_Shutdown().

TR_TransferRun()

void TR_TransferRun

(

void

)

Checks whether given transfer should be processed.

See also

CP_CampaignRun

Definition at line 300 of file cp_transfer.cpp.

References ccs, TR_Foreach, and TR_TransferEnd().

Referenced by CP_CampaignRun(), and TEST_F().

TR_TransferStart()

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 159 of file cp_transfer.cpp.

References AlienContainment::add(), AIR_AircraftGetFromIDX(), AIR_GetFirstFromBase(), AIR_GetHangarCapacityType(), AIR_IsEmployeeInAircraft(), AIR_RemoveEmployee(), AIR_TRANSFER, transfer_t::aircraft, base_t::aircraftCurrent, transfer_t::alienCargo, base_t::alienContainment, transfer_t::antimatter, B_AddAntimatter(), B_AddToStorage(), B_ItemIsStoredInBaseStorage(), CAP_AddCurrent(), ccs, cgi, count, DEFAULT_TRANSFER_TIME, transfer_t::destBase, E_MoveIntoNewBase(), transfer_t::employees, transfer_t::event, GetDistanceOnGlobe(), transfer_t::hasEmployees, i, aircraft_t::idx, transfer_t::itemCargo, AlienCargo::list(), ItemCargo::list(), LIST_Add(), LIST_Foreach, MAX_EMPL, OBJZERO, base_t::pos, PR_ProductionAllowed(), RS_ResearchAllowed(), DateTime::SECONDS_PER_DAY, and transfer_t::srcBase.

Referenced by TEST_F(), and TR_TransferStart_f().