(svn r18957) -Doc: Documenting the scroll_x, scroll_y, and subscroll variables of SmallMapWindow.

This commit is contained in:
alberth 2010-01-30 09:32:48 +00:00
parent b7fc8b4979
commit ab4072ba8d
1 changed files with 3 additions and 3 deletions

View File

@ -449,9 +449,9 @@ class SmallMapWindow : public Window {
uint min_number_of_fixed_rows; ///< Minimal number of rows in the legends for the fixed layouts only (all except #SMT_INDUSTRY).
uint column_width; ///< Width of a column in the #SM_WIDGET_LEGEND widget.
int32 scroll_x;
int32 scroll_y;
int32 subscroll;
int32 scroll_x; ///< Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
int32 scroll_y; ///< Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
int32 subscroll; ///< Number of pixels (0..3) between the right end of the base tile and the pixel at the top-left corner of the smallmap display.
static const uint8 FORCE_REFRESH_PERIOD = 0x1F; ///< map is redrawn after that many ticks
uint8 refresh; ///< refresh counter, zeroed every FORCE_REFRESH_PERIOD ticks