The zoom levels now depend on the amount of area shown, regardless of window resolution.

- The best solution I could find to the problem of the game maker specifying how far the camera should see, but the player being able to see farther with weird resolutions, is to forget how "far" and focus on the total area of visible world pixels.
- Closes #7.

Author: Espyo

game_data/base/misc/config.txt

@@ -60,6 +60,6 @@ rules {
     throw_max_dist = 200
     whistle_growth_speed = 180
     whistle_max_dist = 200
-    zoom_max_level = 3.0
-    zoom_min_level = 0.66
+    zoom_closest_reach = 295
+    zoom_farthest_reach = 1340
 }

manual/content/changelog.html

@@ -44,6 +44,7 @@ <h2 id="0.26.0">0.26.0</h2>
       <li><span class="cl-c">Changed</span> the appearance of water to be more dynamic (using shaders). (Thanks Helodity)</li>
       <li><span class="cl-c">Changed</span> how options are organized in the options file, so you may have to set them again.</li>
       <li><span class="cl-c">Changed</span> some properties and behaviors of some enemies to make them easier to fight.</li>
+      <li><span class="cl-c">Changed</span> how window resolutions are handled. The same general amount of area pixels are shown regardless of resolution. i.e. at higher resolutions the player will see things sharper instead of seeing farther than normal.</li>
     </ul>
 
     <p><b>Content-making changes</b></p>
@@ -143,6 +144,7 @@ <h2 id="0.26.0">0.26.0</h2>
         <li><span class="cl-c">Changed</span> the names of the control-binds related <a href="gui.html">GUI items</a> in the options menu.</li>
         <li><span class="cl-c">Changed</span> the amount of hazards that a <a href="area.html">sector</a> or a <a href="animation.html">hitbox</a> can have to 1. Their properties were thus renamed from <code>hazards</code> to <code>hazard</code>.</li>
         <li><span class="cl-c">Changed</span> the name of the "screen" limit properties of the <a href="gui.html">title screen GUI's</a> logo block to read "window" instead.</li>
+        <li><span class="cl-c">Changed</span> the zoom-level properties of the <a href="game_config.html">game configuration</a> and <a href="options.html">options</a> to instead be about the "reach", and renamed to <code>zoom_*_reach</code> accordingly.</li>
       </li>
     </ul>
 

manual/content/game_config.html

@@ -313,16 +313,16 @@ <h2 id="rules">Rules</h2>
         <td>200</td>
       </tr>
       <tr>
-        <td>zoom_max_level</td>
-        <td>Maximum level of zoom (i.e. how close the camera can get).</td>
+        <td>zoom_closest_reach</td>
+        <td>At the closest zoom level, the camera shows an area depending on this value, in world pixels. You can think of this as "on average, the player has a horizontal view span or vertical view span of this amount". The area is calculated as this value squared.<br>Because different window resolutions can show more on one direction than another, and because the corners of the window show much farther than the sides, it's no use trying to control exactly how <i>far</i> the player sees, and so <i>Pikifen</i> instead focuses on the <i>total area</i> of visible world pixels at any moment. As an example, for an area of 87'025 pixels (295 squared), on a square window resolution like 1024x1024, the player will see 295 pixels far horizontally and 295 vertically. On a 16:9 resolution like 1024x768, the player will see around 340 horizontally and 256 vertically (around 87'040 pixels).</td>
         <td>Number</td>
-        <td>3</td>
+        <td>295</td>
       </tr>
       <tr>
-        <td>zoom_min_level</td>
-        <td>Minimum level of zoom (i.e. how far away the camera can get).</td>
+        <td>zoom_farthest_level</td>
+        <td>Same as <code>zoom_closest_reach</code>, but for the farthest zoom level.</td>
         <td>Number</td>
-        <td>0.66</td>
+        <td>1340</td>
       </tr>
     </table>
 

manual/content/history.html

@@ -18,7 +18,7 @@
 
     <h2 id="creation">Creation</h2>
 
-    <p>The idea for the engine started on mid 2013, with the intent of both allowing <i>Pikmin</i> fans to make their own games reality as well as to create a fun and challenging <i>Pikmin</i>-related project. The idea was made public on Pikmin Fanon, where <a href="https://www.pikminfanon.com/wiki/Topic:Pikmin_Engine_by_Espyo">a topic</a> was created to gather feedback, before starting the project. On the 15th of August, 2013, development of the engine officially began. Ever since, different versions have been released, each one more complete than the last.</p>
+    <p>The idea for the engine started on mid-2013, with the intent of both allowing <i>Pikmin</i> fans to make their own games reality as well as to create a fun and challenging <i>Pikmin</i>-related project. The idea was made public on Pikmin Fanon, where <a href="https://www.pikminfanon.com/wiki/Topic:Pikmin_Engine_by_Espyo">a topic</a> was created to gather feedback, before starting the project. On the 15th of August, 2013, development of the engine officially began. Ever since, different versions have been released, each one more complete than the last.</p>
 
     <p>On February 2nd, 2018, the project got rebranded, and the mission statement changed a bit. Instead of it being called "Pikmin fangame engine", it got renamed to "<i>Pikifen</i>", and the idea was no longer to make fan games a reality, since that proved to be too ambitious at best, and outright impossible at worst. Instead, the goal became to create a fun engine in which people could create and play their own content, and the idea to make full games in it being secondary.</p>
 

manual/content/options.html

@@ -61,12 +61,6 @@ <h2 id="advanced">Advanced</h2>
         <td>Number</td>
         <td>1000</td>
       </tr>
-      <tr>
-        <td><code>middle_zoom_level</code></td>
-        <td>When pressing the camera button, the zoom level swaps between near, far, and this amount.</td>
-        <td>Number</td>
-        <td>1.50</td>
-      </tr>
       <tr>
         <td><code>mipmaps</code></td>
         <td><code>true</code> to enable <a href="http://en.wikipedia.org/wiki/Mipmap">mipmaps</a>, <code>false</code> to disable them. Enabling them is recommended, and increases VRAM usage for slightly less GPU usage. Turn it off if you need RAM. Might affect performance.</td>
@@ -109,6 +103,12 @@ <h2 id="advanced">Advanced</h2>
         <td>Boolean</td>
         <td>false</td>
       </tr>
+      <tr>
+        <td><code>zoom_medium_reach</code></td>
+        <td>Same as the <code>zoom_closest_reach</code> <a href="game_config.html#rules">game configuration property</a>, but for the medium zoom level.</td>
+        <td>Number</td>
+        <td>630</td>
+      </tr>
     </table>
 
     <h2 id="animation-editor">Animation editor</h2>

source/documents/misc_info.txt

@@ -116,8 +116,7 @@ Bag of notes (useful stuff)
     Ideas for representing height
         Distant sectors (above, below, or both?) could have fog drawn on top of them
     What about upscaling the game?
-        Forget it. It's an insane headache. Between changing all of the file formats, variables, constants, etc. to the new numbers, you'd have to update the SVG and PNG files, and there are other tiny code problems that aren't immediately apparent. Players can just increase the resolution and zoom_mid_level.
-        What if a higher resolution zooms in the game further (except for the HUD and menus and such), and zoom_mid_level can be used to see more or less by default? This makes sense, since if the game's min zoom is 0.5, that's because the creator doesn't want you to see too far.
+        Forget it. It's an insane headache. Between changing all of the file formats, variables, constants, etc. to the new numbers, you'd have to update the SVG and PNG files, and there are other tiny code problems that aren't immediately apparent. Players can just increase the resolution and zoom_medium_reach.
     Pathing
         The only possible way to calculate the stops is by doing it first, before paths. If the engine could decide any stop at will, then were would the threshold be? What would stop it from deciding the last stop is like on the opposite side of the map from the target spot?
         Mobs that care about paths can only be in one of two stats: moving, or stuck

source/source/content/area/mission.cpp

@@ -83,7 +83,7 @@ bool MissionFailKillEnemies::getEndZoomData(
 ) const {
     if(gameplay->lastEnemyKilledPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastEnemyKilledPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -228,7 +228,7 @@ bool MissionFailLoseLeaders::getEndZoomData(
 ) const {
     if(gameplay->lastHurtLeaderPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastHurtLeaderPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -371,7 +371,7 @@ bool MissionFailLosePikmin::getEndZoomData(
 ) const {
     if(gameplay->lastPikminDeathPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastPikminDeathPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -639,7 +639,7 @@ bool MissionFailTakeDamage::getEndZoomData(
 ) const {
     if(gameplay->lastHurtLeaderPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastHurtLeaderPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -933,7 +933,7 @@ bool MissionFailTooFewPikmin::getEndZoomData(
 ) const {
     if(gameplay->lastPikminDeathPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastPikminDeathPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -1076,7 +1076,7 @@ bool MissionFailTooManyPikmin::getEndZoomData(
 ) const {
     if(gameplay->lastPikminBornPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastPikminBornPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -1231,7 +1231,7 @@ bool MissionGoalBattleEnemies::getEndZoomData(
 ) const {
     if(gameplay->lastEnemyKilledPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastEnemyKilledPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -1383,7 +1383,7 @@ bool MissionGoalCollectTreasures::getEndZoomData(
 ) const {
     if(gameplay->lastShipThatGotTreasurePos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastShipThatGotTreasurePos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;
@@ -1850,7 +1850,7 @@ bool MissionGoalGrowPikmin::getEndZoomData(
 ) const {
     if(gameplay->lastPikminBornPos.x != LARGE_FLOAT) {
         *out_cam_pos = gameplay->lastPikminBornPos;
-        *out_cam_zoom = game.config.rules.zoomMaxLevel;
+        *out_cam_zoom = gameplay->zoomLevels[0];
         return true;
     }
     return false;

source/source/core/game_config.cpp

@@ -147,11 +147,11 @@ const float WHISTLE_GROWTH_SPEED = 180.0f;
 //Default value for the maximum whistle distance.
 const float WHISTLE_MAX_DIST = CURSOR_MAX_DIST;
 
-//Default value for the maximum zoom level.
-const float ZOOM_MAX_LEVEL = 3.0f;
+//Default value for the zoom closest reach.
+const float ZOOM_CLOSEST_REACH = 295.0f;
 
-//Default value for the minimum zoom level.
-const float ZOOM_MIN_LEVEL = 0.66f;
+//Default value for the zoom farthest reach.
+const float ZOOM_FARTHEST_REACH = 1340.0f;
 
 }
 
@@ -263,7 +263,7 @@ void GameConfig::load(DataNode* file) {
         rrs.set("throw_max_dist", rules.throwMaxDist);
         rrs.set("whistle_growth_speed", rules.whistleGrowthSpeed);
         rrs.set("whistle_max_dist", rules.whistleMaxDist);
-        rrs.set("zoom_max_level", rules.zoomMaxLevel);
-        rrs.set("zoom_min_level", rules.zoomMinLevel);
+        rrs.set("zoom_closest_reach", rules.zoomClosestReach);
+        rrs.set("zoom_farthest_reach", rules.zoomFarthestReach);
     }
 }

source/source/core/game_config.h

@@ -81,8 +81,8 @@ extern const size_t MAX_PIKMIN_IN_FIELD;
 extern const float THROW_MAX_DIST;
 extern const float WHISTLE_GROWTH_SPEED;
 extern const float WHISTLE_MAX_DIST;
-extern const float ZOOM_MAX_LEVEL;
-extern const float ZOOM_MIN_LEVEL;
+extern const float ZOOM_CLOSEST_REACH;
+extern const float ZOOM_FARTHEST_REACH;
 }
 
 }
@@ -270,11 +270,13 @@ struct GameConfig {
         //Maximum distance from the leader that the whistle can start from.
         float whistleMaxDist = RULES_D::WHISTLE_MAX_DIST;
 
-        //The closest zoom level the player can get.
-        float zoomMaxLevel = RULES_D::ZOOM_MAX_LEVEL;
+        //The camera reach for the closest zoom level. In reality,
+        //the camera keeps on-view an area of these many pixels squared.
+        float zoomClosestReach = RULES_D::ZOOM_CLOSEST_REACH;
 
-        //The farthest zoom level the player can get.
-        float zoomMinLevel = RULES_D::ZOOM_MIN_LEVEL;
+        //The camera reach for the farthest zoom level. In reality,
+        //the camera keeps on-view an area of these many pixels squared.
+        float zoomFarthestReach = RULES_D::ZOOM_FARTHEST_REACH;
 
     } rules;
 

source/source/core/init.cpp

@@ -937,11 +937,11 @@ void initMisc() {
     game.states.gameplay->particles =
         ParticleManager(game.options.advanced.maxParticles);
 
-    game.options.advanced.zoomMidLevel =
+    game.options.advanced.zoomMediumReach =
         std::clamp(
-            game.options.advanced.zoomMidLevel,
-            game.config.rules.zoomMinLevel,
-            game.config.rules.zoomMaxLevel
+            game.options.advanced.zoomMediumReach,
+            game.config.rules.zoomClosestReach,
+            game.config.rules.zoomFarthestReach
         );
 
     game.liquidLimitEffectBuffer = al_create_bitmap(game.winW, game.winH);

source/source/core/options.cpp

@@ -53,8 +53,8 @@ const unsigned int TARGET_FPS = 60;
 //Default value for whether to use the window position hack.
 const bool WINDOW_POS_HACK = false;
 
-//Default value for the middle zoom level.
-const float ZOOM_MID_LEVEL = 1.4f;
+//Default value for the zoom medium reach.
+const float ZOOM_MEDIUM_REACH = 630.0f;
 
 }
 
@@ -241,7 +241,6 @@ void Options::loadFromDataNode(DataNode* file) {
         ars.set("joystick_max_deadzone", advanced.joystickMaxDeadzone);
         ars.set("joystick_min_deadzone", advanced.joystickMinDeadzone);
         ars.set("max_particles", advanced.maxParticles);
-        ars.set("middle_zoom_level", advanced.zoomMidLevel);
         ars.set("mipmaps", advanced.mipmapsEnabled);
         for(unsigned char p = 0; p < MAX_PLAYERS; p++) {
             ars.set(
@@ -251,6 +250,7 @@ void Options::loadFromDataNode(DataNode* file) {
         }
         ars.set("smooth_scaling", advanced.smoothScaling);
         ars.set("window_position_hack", advanced.windowPosHack);
+        ars.set("zoom_medium_reach", advanced.zoomMediumReach);
 
         advanced.targetFps = std::max(LOWEST_FRAMERATE, advanced.targetFps);
 
@@ -509,7 +509,6 @@ void Options::saveToDataNode(DataNode* file) const {
         agw.write("joystick_max_deadzone", advanced.joystickMaxDeadzone);
         agw.write("joystick_min_deadzone", advanced.joystickMinDeadzone);
         agw.write("max_particles", advanced.maxParticles);
-        agw.write("middle_zoom_level", advanced.zoomMidLevel);
         agw.write("mipmaps", advanced.mipmapsEnabled);
         for(unsigned char p = 0; p < MAX_PLAYERS; p++) {
             agw.write(
@@ -519,6 +518,7 @@ void Options::saveToDataNode(DataNode* file) const {
         }
         agw.write("smooth_scaling", advanced.smoothScaling);
         agw.write("window_position_hack", advanced.windowPosHack);
+        agw.write("zoom_medium_reach", advanced.zoomMediumReach);
     }
 
     //Animation editor.

source/source/core/options.h

@@ -74,7 +74,7 @@ extern const bool MOUSE_MOVES_CURSOR[MAX_PLAYERS];
 extern const bool SMOOTH_SCALING;
 extern const unsigned int TARGET_FPS;
 extern const bool WINDOW_POS_HACK;
-extern const float ZOOM_MID_LEVEL;
+extern const float ZOOM_MEDIUM_REACH;
 }
 
 namespace AUDIO_D {
@@ -195,7 +195,7 @@ struct Options {
         bool windowPosHack = ADVANCED_D::WINDOW_POS_HACK;
 
         //Set the camera's middle zoom level to this amount.
-        float zoomMidLevel = ADVANCED_D::ZOOM_MID_LEVEL;
+        float zoomMediumReach = ADVANCED_D::ZOOM_MEDIUM_REACH;
 
     } advanced;
 

source/source/game_state/gameplay/gameplay.cpp

@@ -262,6 +262,24 @@ void GameplayState::enter() {
     game.view.center.y = game.winH / 2.0f;
     game.view.updateTransformations();
 
+    float zoomReaches[3] = {
+        game.config.rules.zoomClosestReach,
+        game.options.advanced.zoomMediumReach,
+        game.config.rules.zoomFarthestReach
+    };
+    float viewportReach = sqrt(game.view.size.x * game.view.size.y);
+    for(int z = 0; z < 3; z++) {
+        zoomLevels[z] = viewportReach / zoomReaches[z];
+    }
+    
+    if(curLeaderPtr) {
+        game.view.cam.setPos(curLeaderPtr->pos);
+    } else {
+        game.view.cam.setPos(Point());
+    }
+    game.view.cam.setZoom(zoomLevels[1]);
+    game.view.updateTransformations();
+    
     lastEnemyKilledPos = Point(LARGE_FLOAT);
     lastHurtLeaderPos = Point(LARGE_FLOAT);
     lastPikminBornPos = Point(LARGE_FLOAT);
@@ -921,13 +939,6 @@ void GameplayState::load() {
         changeToNextLeader(true, false, false);
     }
 
-    if(curLeaderPtr) {
-        game.view.cam.setPos(curLeaderPtr->pos);
-    } else {
-        game.view.cam.setPos(Point());
-    }
-    game.view.cam.setZoom(game.options.advanced.zoomMidLevel);
-    
     //Memorize mobs required by the mission.
     if(game.curAreaData->type == AREA_TYPE_MISSION) {
         unordered_set<size_t> mission_required_mob_gen_idxs;

source/source/game_state/gameplay/gameplay.h

@@ -380,6 +380,9 @@ class GameplayState : public GameState {
     //Number of Pikmin lost so far, per type.
     map<PikminType*, long> pikminDeathsPerType;
 
+    //Closest, middle, and farthest zoom levels. Cache for convenience.
+    float zoomLevels[3] = { 0.0f, 0.0f, 0.0f };
+    
 
     //--- Function declarations ---