summaryrefslogtreecommitdiff
path: root/src/newgrf_industrytiles.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2010-08-01 17:45:53 +0000
committeralberth <alberth@openttd.org>2010-08-01 17:45:53 +0000
commitdc6ed2c2c02a651a50b2d2b232302d0c7eab48ec (patch)
tree29a7c1aa361bf156c083f5d295bf973da8867db9 /src/newgrf_industrytiles.h
parent2d25def2ff7617a4f800d16eacce704395d962cf (diff)
downloadopenttd-dc6ed2c2c02a651a50b2d2b232302d0c7eab48ec.tar.xz
(svn r20279) -Doc: Doxygen additions/improvements.
Diffstat (limited to 'src/newgrf_industrytiles.h')
-rw-r--r--src/newgrf_industrytiles.h11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/newgrf_industrytiles.h b/src/newgrf_industrytiles.h
index 86a625359..ba2d9ac9b 100644
--- a/src/newgrf_industrytiles.h
+++ b/src/newgrf_industrytiles.h
@@ -17,6 +17,7 @@
#include "newgrf_callbacks.h"
#include "core/random_func.hpp"
+/** Animation triggers of the industries. */
enum IndustryAnimationTrigger {
IAT_CONSTRUCTION_STATE_CHANGE,
IAT_TILELOOP,
@@ -34,13 +35,11 @@ bool StartStopIndustryTileAnimation(TileIndex tile, IndustryAnimationTrigger iat
bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat);
+/** Available industry tile triggers. */
enum IndustryTileTrigger {
- /* The tile of the industry has been triggered during the tileloop. */
- INDTILE_TRIGGER_TILE_LOOP = 0x01,
- /* The industry has been triggered via its tick. */
- INDUSTRY_TRIGGER_INDUSTRY_TICK = 0x02,
- /* Cargo has been delivered. */
- INDUSTRY_TRIGGER_RECEIVED_CARGO = 0x04,
+ INDTILE_TRIGGER_TILE_LOOP = 0x01, ///< The tile of the industry has been triggered during the tileloop.
+ INDUSTRY_TRIGGER_INDUSTRY_TICK = 0x02, ///< The industry has been triggered via its tick.
+ INDUSTRY_TRIGGER_RECEIVED_CARGO = 0x04, ///< Cargo has been delivered.
};
void TriggerIndustryTile(TileIndex t, IndustryTileTrigger trigger);
void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger);