mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-21 19:10:55 +00:00
APuddle210
40befee080
### Summary Investigated and resolved slow execution time of this script since the addition of the thumbnail generation functionality. Determined that thumbnail generation was not the source of the increased execution time, likely due instead to change from bun back to npm. Some other minor improvements made. ### Execution Time Optimizations Investigated which components of the process were taking the most time and determined the longest running component to be the `removeSmallLakes()` function. Research determined that the `.forEach` looping method to be significantly slower than the `for (const var of vars)` method and replaced all instances of the former with the latter. Further review identified possibility to reduce the number of calls to the getArea() function by combining the `removeSmallLakes()` with the `processOcean()` function, which was already determining the size of all bodies of water. After revision to the `forEach` loops and inclusion of `removeSmallLakes()` within `processOcean()`, the next slowest executing component was the `processDistToLand()` function. Aside from being slow this function was also difficult to understand. Revised function perform Manhattan distance calculations against the `shorelineWaters[]` array and identify the minimum value rather than walking out from the shoreline using the `neighbors()`. This change yielded between ~35% - ~45% faster execution times for this function (~275 seconds -> ~150 seconds; ~225 seconds -> ~165 seconds). The change to `processDistToLand()` was tested by running the new version of the function alongside the old version of the function and having any differences in the calculated distance to land printed to the console. Initially the test identified errors arising from a reference to an x coordinate value that should have been a y coordinate value. Once resolved no further differences were found. ### Other Minor Changes Changes to `processOcean()` now also explicitly prevent the largest body of water from being removed, regardless of what value is passed in for `removeSmall`, and additionally nest the calls to `processShore()` and `processDistToLand()` within this function rather than within `generateMap()` for better comprehensibility. `processOcean()` renamed to `processWater`. Also inserted additional console.log lines to better communicate state of the scripts during runtime, removed unnecessary export statement from `createMiniMap()` function which requires parameters not readily available from outside contexts (and which was not called externally anyways). Revised multiple instances where `terrain` was used to refer to a single item of a Terrain[][] array to instead use `tile` for comprehensibility, and consistency with the terminology used elsewhere in the application. Added an explicit variable declaration of `removeSmall` to the generateTerrainMaps.ts file and included it in the call to `generateMap()` to make toggling this option easier in the future. Moved the `min_lake_size` constant out of the relevant function and to the top of the TerrainMapGenerator.ts file for better visibility and consistency with where `min_island_size` is being declared.