summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2009-09-13 07:48:47 +0000
committerrubidium <rubidium@openttd.org>2009-09-13 07:48:47 +0000
commit50e424ba241044851fb647c00b5de55848c8db76 (patch)
tree2b1f34a463584a72d648f2f91afabaa5b943a2db
parentafc7f576f77d053f991587dfc2b199b10b19575f (diff)
downloadopenttd-50e424ba241044851fb647c00b5de55848c8db76.tar.xz
(svn r17518) -Document: some of the callback 'masks'
-rw-r--r--src/newgrf_callbacks.h23
1 files changed, 11 insertions, 12 deletions
diff --git a/src/newgrf_callbacks.h b/src/newgrf_callbacks.h
index 822a6a9de..5c693761d 100644
--- a/src/newgrf_callbacks.h
+++ b/src/newgrf_callbacks.h
@@ -249,18 +249,17 @@ enum StationCallbackMask {
* Callback masks for houses.
*/
enum HouseCallbackMask {
- CBM_HOUSE_ALLOW_CONSTRUCTION = 0,
- CBM_HOUSE_ANIMATION_NEXT_FRAME = 1,
- CBM_HOUSE_ANIMATION_START_STOP = 2,
- CBM_HOUSE_CONSTRUCTION_STATE_CHANGE = 3,
- CBM_HOUSE_COLOUR = 4,
- CBM_HOUSE_CARGO_ACCEPTANCE = 5,
- CBM_HOUSE_ANIMATION_SPEED = 6,
- CBM_HOUSE_DESTRUCTION = 7,
- CBM_HOUSE_ACCEPT_CARGO = 8,
- CBM_HOUSE_PRODUCE_CARGO = 9,
- CBM_HOUSE_DENY_DESTRUCTION = 10,
-
+ CBM_HOUSE_ALLOW_CONSTRUCTION = 0, ///< decide whether the house can be built on a given tile
+ CBM_HOUSE_ANIMATION_NEXT_FRAME = 1, ///< decides next animation frame
+ CBM_HOUSE_ANIMATION_START_STOP = 2, ///< periodically start/stop the animation
+ CBM_HOUSE_CONSTRUCTION_STATE_CHANGE = 3, ///< change animation when construction state changes
+ CBM_HOUSE_COLOUR = 4, ///< decide the color of the building
+ CBM_HOUSE_CARGO_ACCEPTANCE = 5, ///< decides amount of cargo acceptance
+ CBM_HOUSE_ANIMATION_SPEED = 6, ///< decides animation speed
+ CBM_HOUSE_DESTRUCTION = 7, ///< trigger destruction of building
+ CBM_HOUSE_ACCEPT_CARGO = 8, ///< decides accepted types
+ CBM_HOUSE_PRODUCE_CARGO = 9, ///< custom cargo production
+ CBM_HOUSE_DENY_DESTRUCTION = 10, ///< conditional protection
};
/**