(svn r20279) -Doc: Doxygen additions/improvements.

This commit is contained in:
alberth
2010-08-01 17:45:53 +00:00
parent 2d25def2ff
commit dc6ed2c2c0
10 changed files with 161 additions and 51 deletions

View File

@@ -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);