src/ai/api/ai_cargolist.hpp
author truebrain
Thu, 17 Jul 2008 23:45:52 +0000
branchnoai
changeset 11164 67338721eb26
parent 11078 81b3bb4b6c53
permissions -rw-r--r--
(svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
9829
80fbe02a4184 (svn r12491) [NoAI] -Documentation: made parts of the comments more uniform (@file header and class header)
truebrain
parents: 9816
diff changeset
     1
/* $Id$ */
80fbe02a4184 (svn r12491) [NoAI] -Documentation: made parts of the comments more uniform (@file header and class header)
truebrain
parents: 9816
diff changeset
     2
11078
81b3bb4b6c53 (svn r13635) [NoAI] -Fix: minor typo (Yexo)
truebrain
parents: 9829
diff changeset
     3
/** @file ai_cargolist.hpp List all the cargos. */
9785
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
     4
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
     5
#ifndef AI_CARGOLIST_HPP
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
     6
#define AI_CARGOLIST_HPP
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
     7
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
     8
#include "ai_abstractlist.hpp"
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
     9
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    10
/**
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    11
 * Creates a list of cargos that can be produced in the current game.
9829
80fbe02a4184 (svn r12491) [NoAI] -Documentation: made parts of the comments more uniform (@file header and class header)
truebrain
parents: 9816
diff changeset
    12
 * @ingroup AIList
9785
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    13
 */
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    14
class AICargoList : public AIAbstractList {
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    15
public:
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    16
	static const char *GetClassName() { return "AICargoList"; }
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    17
	AICargoList();
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    18
};
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    19
11164
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    20
/**
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    21
 * Creates a list of cargos that the given industry accepts.
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    22
 * @ingroup AIList
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    23
 */
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    24
class AICargoList_IndustryAccepting : public AIAbstractList {
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    25
public:
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    26
	static const char *GetClassName() { return "AICargoList_IndustryAccepting"; }
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    27
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    28
	/**
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    29
	 * @param industry_id The industry to get the list of cargos it accepts from.
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    30
	 */
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    31
	AICargoList_IndustryAccepting(IndustryID industry_id);
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    32
};
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    33
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    34
/**
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    35
 * Creates a list of cargos that the given industry can produce.
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    36
 * @ingroup AIList
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    37
 */
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    38
class AICargoList_IndustryProducing : public AIAbstractList {
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    39
public:
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    40
	static const char *GetClassName() { return "AICargoList_IndustryProducing"; }
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    41
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    42
	/**
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    43
	 * @param industry_id The industry to get the list of cargos it produces from.
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    44
	 */
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    45
	AICargoList_IndustryProducing(IndustryID industry_id);
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    46
};
67338721eb26 (svn r13722) [NoAI] -Add: AICargoList_IndustryNNN (Yexo)
truebrain
parents: 11078
diff changeset
    47
9785
edbd185e05ed (svn r12280) [NoAI] -Add: added AICargoList (Morloth)
truebrain
parents:
diff changeset
    48
#endif /* AI_CARGOLIST_HPP */