summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbelugas <belugas@openttd.org>2007-04-13 17:15:06 +0000
committerbelugas <belugas@openttd.org>2007-04-13 17:15:06 +0000
commit5775fb475f27a7c32f6f697a047ca9f6c7be45c0 (patch)
treed46d4f70d2b046eb8ee297b96045d99c52b9f98b
parente7cd92f06fe61056a399cddc07bfed381132d07f (diff)
downloadopenttd-5775fb475f27a7c32f6f697a047ca9f6c7be45c0.tar.xz
(svn r9619) -Documentation: Comments on drawing arrays of houses and industries
-rw-r--r--src/table/industry_land.h15
-rw-r--r--src/table/town_land.h10
2 files changed, 21 insertions, 4 deletions
diff --git a/src/table/industry_land.h b/src/table/industry_land.h
index 9ef40c2e4..91d2e02cf 100644
--- a/src/table/industry_land.h
+++ b/src/table/industry_land.h
@@ -15,8 +15,23 @@ struct DrawIndustrySpec4Struct {
byte image_3;
};
+
+/**
+ * Macro to ease the declaration of the array
+ * @param s1 sprite ID of ground sprite
+ * @param p1 palette ID of ground sprite
+ * @param s2 sprite ID of building sprite
+ * @param p2 palette ID of building sprite
+ * @param sx coordinate x of the sprite
+ * @param sy coordinate y of the sprite
+ * @param w width of the sprite
+ * @param h height of the sprite
+ * @param dz virtual height of the sprite
+ * @param p this allows to specify a special drawing procedure.
+ * @see DrawBuildingsTileStruct */
#define M(s1, p1, s2, p2, sx, sy, w, h, dz, p) { { s1, p1 }, { s2, p2 }, sx, sy, w - 1, h - 1, dz, p }
+/** Structure for industry tiles drawing */
static const DrawBuildingsTileStruct _industry_draw_tile_data[NUM_INDUSTRY_GFXES * 4] = {
M( 0xf54, PAL_NONE, 0x7db, PAL_NONE, 7, 0, 9, 9, 10, 0),
M( 0xf54, PAL_NONE, 0x7dc, PAL_NONE, 7, 0, 9, 9, 30, 0),
diff --git a/src/table/town_land.h b/src/table/town_land.h
index d025cca09..528275a45 100644
--- a/src/table/town_land.h
+++ b/src/table/town_land.h
@@ -5,17 +5,19 @@
/** Writes the data into the Town Tile Drawing Struct
* @param s1 The first sprite of the building, mostly the ground sprite
+ * @param p1 The first sprite's palette of the building, mostly the ground sprite
* @param s2 The second sprite of the building.
+ * @param p2 The second sprite's palette of the building.
* @param sx The x-position of the sprite within the tile
- * @param xy the y-position of the sprite within the tile
+ * @param sy the y-position of the sprite within the tile
* @param w the width of the sprite
* @param h the height of the sprite
* @param dz the virtual height of the sprite
- * @param p set to 1 if a lift is present
- * @see DrawTownTileStruct
- */
+ * @param p set to 1 if a lift is present ()
+ * @see DrawBuildingsTileStruct */
#define M(s1, p1, s2, p2, sx, sy, w, h, dz, p) { { s1, p1 }, { s2, p2 }, sx, sy, w - 1, h - 1, dz, p}
+/** structure of houses graphics*/
static const DrawBuildingsTileStruct _town_draw_tile_data[] = {
M( 0xf54, PAL_NONE, 0x58d, PAL_NONE, 0, 0, 14, 14, 8, 0),
M( 0xf54, PAL_NONE, 0x58e, PAL_NONE, 0, 0, 14, 14, 60, 0),