libcommon: Cleanup

doomsday/plugins/common/include/g_defs.h

@@ -31,20 +31,19 @@
 ded_t &Defs();
 
 /**
- * Translates a warp map number to unique map identifier. Always returns a valid
- * map identifier.
+ * Translates a map warp number for the @em current episode to a unique map identifier.
  *
- * @note This should only be used where necessary for compatibility reasons as
- * the "warp translation" mechanic is redundant in the context of Doomsday's
- * altogether better handling of map resources and their references. Instead,
- * use the map URI mechanism.
+ * @note This should only be used where necessary for compatibility reasons as the
+ * "warp translation" mechanic is redundant in the context of Doomsday's altogether
+ * better handling of map resources and their references. Instead, use the map URI
+ * mechanism.
  *
- * @param map  The warp map number to translate.
+ * @param warpNumber  Warp number to translate.
  *
- * @return The unique identifier of the map given a warp map number. If the map
- * is not found a URI to the first available map is returned (i.e., Maps:MAP01)
+ * @return The unique identifier of the map. If no game session is in progress or the
+ * warp number is not found, the URI "Maps:" is returned.
  */
-de::Uri P_TranslateMap(uint map);
+de::Uri TranslateMapWarpNumber(uint warpNumber);
 
 extern "C" {
 #endif

doomsday/plugins/common/src/d_net.cpp

@@ -117,7 +117,7 @@ int D_NetServerStarted(int before)
 #if __JHEXEN__
     // Map numbers need to be translated.
     /// @todo fixme: What about cfg.netEpisode?
-    de::Uri netMapUri = P_TranslateMap(::cfg.netMap);
+    de::Uri netMapUri = TranslateMapWarpNumber(::cfg.netMap);
 #elif __JDOOM64__
     de::Uri netMapUri = G_ComposeMapUri(0/*::cfg.netEpisode*/, ::cfg.netMap);
 #else

doomsday/plugins/common/src/d_netsv.cpp

@@ -348,8 +348,7 @@ static de::Uri NetSv_ScanCycle(int index, maprule_t *rules = 0)
 
 #if __JHEXEN__
                     // In Hexen map numbers must be translated (urgh...).
-                    /// @todo fixme: What about the episode?
-                    de::Uri mapUri = P_TranslateMap(map);
+                    de::Uri mapUri = TranslateMapWarpNumber(map);
 #else
                     de::Uri mapUri = G_ComposeMapUri(episode, map);
 #endif

doomsday/plugins/common/src/g_defs.cpp

@@ -58,12 +58,12 @@ void GetDefState(char const *def, int *val)
     if(*val < 0) *val = 0;
 }
 
-de::Uri P_TranslateMap(uint map)
+de::Uri TranslateMapWarpNumber(uint warpNumber)
 {
     if(Record const *rec = COMMON_GAMESESSION->episodeDef())
     {
         defn::Episode episodeDef(*rec);
-        if(Record const *mgNodeRec = episodeDef.tryFindMapGraphNodeByWarpNumber(map))
+        if(Record const *mgNodeRec = episodeDef.tryFindMapGraphNodeByWarpNumber(warpNumber))
         {
             return de::Uri(mgNodeRec->gets("id"), RC_NULL);
         }

doomsday/plugins/common/src/g_game.cpp

@@ -3098,8 +3098,7 @@ D_CMD(WarpMap)
 
 #if __JHEXEN__
         // Hexen map numbers require translation.
-        /// @todo fixme: What about the episode?
-        newMapUri = P_TranslateMap(map);
+        newMapUri = TranslateMapWarpNumber(map);
 #else
         // Internally epsiode and map numbers are zero-based.
         if(epsd != 0) epsd -= 1;

doomsday/plugins/hexen/src/h2_main.cpp

@@ -415,13 +415,13 @@ void X_PostInit()
         }
         else
         {
-            startMapUri = P_TranslateMap(mapNumber);
+            startMapUri = TranslateMapWarpNumber(mapNumber);
         }
     }
 
     if(startMapUri.path().isEmpty())
     {
-        startMapUri = P_TranslateMap(1);
+        startMapUri = TranslateMapWarpNumber(1);
     }
 
     // Are we autostarting?