summaryrefslogtreecommitdiff
path: root/src/newgrf_industries.cpp
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2010-11-20 14:15:02 +0000
committeralberth <alberth@openttd.org>2010-11-20 14:15:02 +0000
commit3b0ee6557113104416f465fb780d9900fb7a842a (patch)
tree4c6600efd2700df08b38c84cd594dd11043ee501 /src/newgrf_industries.cpp
parent5d72befbcd0486900062a4163c3eb52d5d27f7d5 (diff)
downloadopenttd-3b0ee6557113104416f465fb780d9900fb7a842a.tar.xz
(svn r21270) -Doc: Doxyment updates and additions. Removal of doxyment in code.
Diffstat (limited to 'src/newgrf_industries.cpp')
-rw-r--r--src/newgrf_industries.cpp6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/newgrf_industries.cpp b/src/newgrf_industries.cpp
index ef96572cc..de051ad24 100644
--- a/src/newgrf_industries.cpp
+++ b/src/newgrf_industries.cpp
@@ -506,6 +506,12 @@ CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, uin
NOT_REACHED();
}
+/**
+ * Check with callback #CBM_IND_AVAILABLE whether the industry can be built.
+ * @param type Industry type to check.
+ * @param creation_type Reason to construct a new industry.
+ * @return If the industry has no callback or allows building, \c true is returned. Otherwise, \c false is returned.
+ */
bool CheckIfCallBackAllowsAvailability(IndustryType type, IndustryAvailabilityCallType creation_type)
{
const IndustrySpec *indspec = GetIndustrySpec(type);