diff options
author | rubidium <rubidium@openttd.org> | 2011-01-18 22:31:06 +0000 |
---|---|---|
committer | rubidium <rubidium@openttd.org> | 2011-01-18 22:31:06 +0000 |
commit | 7efd7e19ed046a4a0c03077f27930291ba5b9725 (patch) | |
tree | 9e08703cd992ede72e5165044b69750b1385510f /src/heightmap.h | |
parent | 6c9078fd30097b38537a60fbecb9828da69c3517 (diff) | |
download | openttd-7efd7e19ed046a4a0c03077f27930291ba5b9725.tar.xz |
(svn r21845) -Codechange: move documentation towards the code to make it more likely to be updates [d-m].
Diffstat (limited to 'src/heightmap.h')
-rw-r--r-- | src/heightmap.h | 26 |
1 files changed, 1 insertions, 25 deletions
diff --git a/src/heightmap.h b/src/heightmap.h index 16ef279c7..08ae200ec 100644 --- a/src/heightmap.h +++ b/src/heightmap.h @@ -12,7 +12,7 @@ #ifndef HEIGHTMAP_H #define HEIGHTMAP_H -/* +/** * Order of these enums has to be the same as in lang/english.txt * Otherwise you will get inconsistent behaviour. */ @@ -21,33 +21,9 @@ enum HeightmapRotation { HM_CLOCKWISE, ///< Rotate the map clockwise 45 degrees }; -/** - * Get the dimensions of a heightmap. - * @param filename to query - * @param x dimension x - * @param y dimension y - * @return Returns false if loading of the image failed. - */ bool GetHeightmapDimensions(char *filename, uint *x, uint *y); - -/** - * Load a heightmap from file and change the map in his current dimensions - * to a landscape representing the heightmap. - * It converts pixels to height. The brighter, the higher. - * @param filename of the heighmap file to be imported - */ void LoadHeightmap(char *filename); - -/** - * Make an empty world where all tiles are of height 'tile_height'. - * @param tile_height of the desired new empty world - */ void FlatEmptyWorld(byte tile_height); - -/** - * This function takes care of the fact that land in OpenTTD can never differ - * more than 1 in height - */ void FixSlopes(); #endif /* HEIGHTMAP_H */ |