diff options
| author | alberth <alberth@openttd.org> | 2010-01-30 09:32:48 +0000 |
|---|---|---|
| committer | alberth <alberth@openttd.org> | 2010-01-30 09:32:48 +0000 |
| commit | ab4072ba8d40ff3d8fceef175552f7fb1e12aafd (patch) | |
| tree | ca19817ac4191b479e6dcbfe1326c6eb71abe822 | |
| parent | b7fc8b4979bff8c73590edd89656a28291478b5e (diff) | |
| download | openttd-ab4072ba8d40ff3d8fceef175552f7fb1e12aafd.tar.xz | |
(svn r18957) -Doc: Documenting the scroll_x, scroll_y, and subscroll variables of SmallMapWindow.
| -rw-r--r-- | src/smallmap_gui.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/smallmap_gui.cpp b/src/smallmap_gui.cpp index dfe466cc7..7d8aacebd 100644 --- a/src/smallmap_gui.cpp +++ b/src/smallmap_gui.cpp @@ -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 |