caravan.h File Reference

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

Go to the source code of this file.

Classes
struct	caravan_result
	An advisor for using caravans optimally. More...
struct	caravan_parameter

Enumerations
enum	foreign_trade_limit { FTL_NATIONAL_ONLY , FTL_ALLIED , FTL_PEACEFUL , FTL_NONWAR }

Functions
void	caravan_parameter_init_default (struct caravan_parameter *parameter)
	Create a valid parameter with default values. More...
void	caravan_parameter_init_from_unit (struct caravan_parameter *parameter, const struct unit *caravan)
	Create a valid parameter with default values based on the caravan. More...
void	caravan_result_init_zero (struct caravan_result *result)
	Initialize the result to be worth zero and go from nowhere to nowhere. More...
int	caravan_result_compare (const struct caravan_result *a, const struct caravan_result *b)
	Compare the two results for sorting. More...
void	caravan_find_best_destination (const struct unit *caravan, const struct caravan_parameter *parameter, struct caravan_result *result, bool omniscient)
	Find the best destination city for the caravan. More...

Enumeration Type Documentation

foreign_trade_limit

enum foreign_trade_limit

Enumerator
FTL_NATIONAL_ONLY
FTL_ALLIED
FTL_PEACEFUL
FTL_NONWAR

Definition at line 15 of file caravan.h.

Function Documentation

caravan_find_best_destination()

void caravan_find_best_destination	(	const struct unit *	caravan,
		const struct caravan_parameter *	parameter,
		struct caravan_result *	result,
		bool	omniscient
	)

Find the best destination city for the caravan.

Store it in *destout (if destout is non-null); return the value of the trade route.

Definition at line 568 of file caravan.cpp.

Referenced by dai_manage_caravan().

caravan_parameter_init_default()

void caravan_parameter_init_default

(

struct caravan_parameter *

parameter

)

Create a valid parameter with default values.

Definition at line 29 of file caravan.cpp.

Referenced by caravan_parameter_init_from_unit().

caravan_parameter_init_from_unit()

void caravan_parameter_init_from_unit	(	struct caravan_parameter *	parameter,
		const struct unit *	caravan
	)

Create a valid parameter with default values based on the caravan.

Definition at line 46 of file caravan.cpp.

Referenced by dai_manage_caravan().

caravan_result_compare()

int caravan_result_compare	(	const struct caravan_result *	a,
		const struct caravan_result *	b
	)

Compare the two results for sorting.

Definition at line 92 of file caravan.cpp.

Referenced by caravan_find_best_destination_notransit(), and cfbdw_callback().

caravan_result_init_zero()

void caravan_result_init_zero

(

struct caravan_result *

result

)

Initialize the result to be worth zero and go from nowhere to nowhere.

Definition at line 65 of file caravan.cpp.

Referenced by get_discounted_reward().