Refactor|libhexen: Prefer the term 'hub' wrt map progression in MAPINFO

The term 'cluster' is less descriptive and map authors generally use
'hub' in any case.

doomsday/plugins/common/include/p_saveg.h

@@ -198,22 +198,22 @@ void SV_TranslateLegacyMobjFlags(mobj_t *mo, int ver);
 
 #if __JHEXEN__
 void SV_HxInitBaseSlot(void);
-void SV_HxSaveClusterMap(void);
-void SV_HxLoadClusterMap(void);
+void SV_HxSaveHubMap(void);
+void SV_HxLoadHubMap(void);
 
 typedef struct {
     player_t player;
     uint numInventoryItems[NUM_INVENTORYITEM_TYPES];
     inventoryitemtype_t readyItem;
 } playerbackup_t;
 
-void SV_HxBackupPlayersInCluster(playerbackup_t playerBackup[MAXPLAYERS]);
+void SV_HxBackupPlayersInHub(playerbackup_t playerBackup[MAXPLAYERS]);
 
 /**
  * @param playerBackup  Player state backup.
  * @param entryPoint  Logical identifier for the entry point used to enter the map.
  */
-void SV_HxRestorePlayersInCluster(playerbackup_t playerBackup[MAXPLAYERS], uint entryPoint);
+void SV_HxRestorePlayersInHub(playerbackup_t playerBackup[MAXPLAYERS], uint entryPoint);
 #endif
 
 void SV_InitThingArchiveForLoad(uint size);

doomsday/plugins/common/src/fi_lib.c

@@ -101,15 +101,15 @@ static void initStateConditions(fi_state_t *s)
 #endif
 
 #if __JHEXEN__
-    // Leaving the current cluster?
+    // Leaving the current hub?
     {
         Uri *nextMapUri = G_ComposeMapUri(gameEpisode, nextMap);
 
         mapinfo_t *curMapInfo = P_MapInfo(0/*current map*/);
         mapinfo_t *nextMapInfo = P_MapInfo(nextMapUri);
         if(curMapInfo && nextMapInfo)
         {
-            s->conditions.leave_hub = (curMapInfo->cluster != nextMapInfo->cluster);
+            s->conditions.leave_hub = (curMapInfo->hub != nextMapInfo->hub);
         }
 
         Uri_Delete(nextMapUri);

doomsday/plugins/common/src/g_game.c

@@ -1300,7 +1300,7 @@ int G_DoLoadMap(loadmap_params_t *p)
     if(p->revisit)
     {
         // We've been here before; deserialize this map's save state.
-        SV_HxLoadClusterMap();
+        SV_HxLoadHubMap();
     }
 #endif
 
@@ -1760,13 +1760,13 @@ void G_PlayerLeaveMap(int player)
     int flightPower;
 #endif
     player_t *p = &players[player];
-    dd_bool newCluster = true;
+    dd_bool newHub = true;
 
 #if __JHEXEN__
     {
         Uri *nextMapUri = G_ComposeMapUri(gameEpisode, nextMap);
 
-        newCluster = (P_MapInfo(0/*current map*/)->cluster != P_MapInfo(nextMapUri)->cluster);
+        newHub = (P_MapInfo(0/*current map*/)->hub != P_MapInfo(nextMapUri)->hub);
 
         Uri_Delete(nextMapUri);
     }
@@ -1798,7 +1798,7 @@ void G_PlayerLeaveMap(int player)
 #endif
 
 #if __JHEXEN__
-    if(newCluster)
+    if(newHub)
     {
         uint count = P_InventoryCount(player, IIT_FLY);
 
@@ -1812,7 +1812,7 @@ void G_PlayerLeaveMap(int player)
     memset(p->powers, 0, sizeof(p->powers));
 
 #if __JHEXEN__
-    if(!newCluster && !gameRules.deathmatch)
+    if(!newHub && !gameRules.deathmatch)
         p->powers[PT_FLIGHT] = flightPower; // Restore flight.
 #endif
 
@@ -1821,7 +1821,7 @@ void G_PlayerLeaveMap(int player)
     p->update |= PSF_KEYS;
     memset(p->keys, 0, sizeof(p->keys));
 #else
-    if(!gameRules.deathmatch && newCluster)
+    if(!gameRules.deathmatch && newHub)
         p->keys = 0;
 #endif
 
@@ -2599,18 +2599,18 @@ void G_DoLeaveMap(void)
     revisit = SV_HxHaveMapStateForSlot(BASE_SLOT, nextMap);
     if(gameRules.deathmatch) revisit = false;
 
-    // Same cluster?
+    // Same hub?
     {
         Uri *nextMapUri = G_ComposeMapUri(gameEpisode, nextMap);
-        if(P_MapInfo(0/*current map*/)->cluster == P_MapInfo(nextMapUri)->cluster)
+        if(P_MapInfo(0/*current map*/)->hub == P_MapInfo(nextMapUri)->hub)
         {
             if(!gameRules.deathmatch)
             {
                 // Save current map.
-                SV_HxSaveClusterMap();
+                SV_HxSaveHubMap();
             }
         }
-        else // Entering new cluster.
+        else // Entering new hub.
         {
             if(!gameRules.deathmatch)
             {
@@ -2623,7 +2623,7 @@ void G_DoLeaveMap(void)
 
     // Take a copy of the player objects (they will be cleared in the process
     // of calling P_SetupMap() and we need to restore them after).
-    SV_HxBackupPlayersInCluster(playerBackup);
+    SV_HxBackupPlayersInHub(playerBackup);
 
     // Disable class randomization (all players must spawn as their existing class).
     oldRandomClassesRule = gameRules.randomClasses;
@@ -2698,7 +2698,7 @@ void G_DoLeaveMap(void)
         P_RemoveAllPlayerMobjs();
     }
 
-    SV_HxRestorePlayersInCluster(playerBackup, nextMapEntrance);
+    SV_HxRestorePlayersInHub(playerBackup, nextMapEntrance);
 
     // Restore the random class rule.
     gameRules.randomClasses = oldRandomClassesRule;
@@ -3510,7 +3510,7 @@ int G_DebriefingEnabled(Uri const *mapUri, ddfinale_t *fin)
        !(nextMap == DDMAXINT && nextMapEntrance == DDMAXINT))
     {
         Uri *nextMapUri = G_ComposeMapUri(gameEpisode, nextMap);
-        if(P_MapInfo(mapUri)->cluster != P_MapInfo(nextMapUri)->cluster)
+        if(P_MapInfo(mapUri)->hub != P_MapInfo(nextMapUri)->hub)
         {
             Uri_Delete(nextMapUri);
             return false;

doomsday/plugins/common/src/mapstatereader.cpp

@@ -456,7 +456,7 @@ DENG2_PIMPL(MapStateReader)
     {
 #if __JHEXEN__
         checkSegment(ASEG_SCRIPTS);
-        Game_ACScriptInterpreter().readMapScriptData(reader, mapVersion);
+        Game_ACScriptInterpreter().readMapScriptData(thisPublic);
 #endif
     }
 

doomsday/plugins/common/src/mapstatewriter.cpp

@@ -171,7 +171,7 @@ DENG2_PIMPL(MapStateWriter)
     {
 #if __JHEXEN__
         beginSegment(ASEG_SCRIPTS);
-        Game_ACScriptInterpreter().writeMapScriptData(writer);
+        Game_ACScriptInterpreter().writeMapScriptData(thisPublic);
 #endif
     }
 

doomsday/plugins/common/src/p_saveg.cpp

@@ -1,4 +1,4 @@
-/** @file p_saveg.cpp Common game-save state management. 
+/** @file p_saveg.cpp  Common game-save state management.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2005-2013 Daniel Swanson <danij@dengine.net>
@@ -3237,7 +3237,7 @@ dd_bool SV_SaveGame(int slot, char const *name)
 }
 
 #if __JHEXEN__
-void SV_HxSaveClusterMap()
+void SV_HxSaveHubMap()
 {
     playerHeaderOK = false; // Uninitialized.
 
@@ -3256,7 +3256,7 @@ void SV_HxSaveClusterMap()
     Writer_Delete(writer);
 }
 
-void SV_HxLoadClusterMap()
+void SV_HxLoadHubMap()
 {
     /// @todo fixme: do not assume this pointer is still valid!
     DENG_ASSERT(curInfo != 0);
@@ -3276,7 +3276,7 @@ void SV_HxLoadClusterMap()
     Reader_Delete(reader);
 }
 
-void SV_HxBackupPlayersInCluster(playerbackup_t playerBackup[MAXPLAYERS])
+void SV_HxBackupPlayersInHub(playerbackup_t playerBackup[MAXPLAYERS])
 {
     DENG_ASSERT(playerBackup);
 
@@ -3296,7 +3296,7 @@ void SV_HxBackupPlayersInCluster(playerbackup_t playerBackup[MAXPLAYERS])
     }
 }
 
-void SV_HxRestorePlayersInCluster(playerbackup_t playerBackup[MAXPLAYERS],
+void SV_HxRestorePlayersInHub(playerbackup_t playerBackup[MAXPLAYERS],
     uint entryPoint)
 {
     mobj_t *targetPlayerMobj;

doomsday/plugins/hexen/include/acscript.h

@@ -207,10 +207,10 @@ class ACScriptInterpreter
     AutoStr *scriptDescription(int scriptNumber);
 
     void writeWorldScriptData(Writer *writer);
-    void readWorldScriptData(Reader *reader, int mapVersion);
+    void readWorldScriptData(Reader *reader, int saveVersion);
 
-    void writeMapScriptData(Writer *writer);
-    void readMapScriptData(Reader *reader, int mapVersion);
+    void writeMapScriptData(MapStateWriter *msw);
+    void readMapScriptData(MapStateReader *msr);
 
 public: /// @todo make private:
     BytecodeScriptInfo &scriptInfoByIndex(int index);

doomsday/plugins/hexen/include/p_mapinfo.h

@@ -30,7 +30,7 @@
 
 typedef struct mapinfo_s {
     uint         map; ///< Logical map number.
-    int          cluster;
+    int          hub;
     uint         warpTrans;
     uint         nextMap;
     int          cdTrack;

doomsday/plugins/hexen/src/acscript.cpp

@@ -492,11 +492,11 @@ void ACScriptInterpreter::writeWorldScriptData(Writer *writer)
     }
 }
 
-void ACScriptInterpreter::readWorldScriptData(Reader *reader, int mapVersion)
+void ACScriptInterpreter::readWorldScriptData(Reader *reader, int saveVersion)
 {
     int ver = 1;
 
-    if(mapVersion >= 7)
+    if(saveVersion >= 7)
     {
         ver = Reader_ReadByte(reader);
     }
@@ -541,15 +541,17 @@ void ACScriptInterpreter::readWorldScriptData(Reader *reader, int mapVersion)
             }
         }
 
-        if(mapVersion < 7)
+        if(saveVersion < 7)
         {
             SV_Seek(12); // Junk.
         }
     }
 }
 
-void ACScriptInterpreter::writeMapScriptData(Writer *writer)
+void ACScriptInterpreter::writeMapScriptData(MapStateWriter *msw)
 {
+    Writer *writer = msw->writer();
+
     for(int i = 0; i < _scriptCount; ++i)
     {
         BytecodeScriptInfo &info = _scriptInfo[i];
@@ -563,8 +565,10 @@ void ACScriptInterpreter::writeMapScriptData(Writer *writer)
     }
 }
 
-void ACScriptInterpreter::readMapScriptData(Reader *reader, int /*mapVersion*/)
+void ACScriptInterpreter::readMapScriptData(MapStateReader *msr)
 {
+    Reader *reader = msr->reader();
+
     for(int i = 0; i < _scriptCount; ++i)
     {
         BytecodeScriptInfo &info = _scriptInfo[i];

doomsday/plugins/hexen/src/p_mapinfo.cpp

@@ -62,7 +62,7 @@ void MapInfoParser(Str const *path)
         // Prepare a default-configured definition, for one-shot initialization.
         mapinfo_t defMapInfo;
         defMapInfo.map             = -1; // Unknown.
-        defMapInfo.cluster         = 0;
+        defMapInfo.hub             = 0;
         defMapInfo.warpTrans       = 0;
         defMapInfo.nextMap         = 0; // Always go to map 0 if not specified.
         defMapInfo.cdTrack         = 1;
@@ -180,10 +180,10 @@ void MapInfoParser(Str const *path)
                     }
                     if(!Str_CompareIgnoreCase(lexer.token(), "cluster"))
                     {
-                        info->cluster = lexer.readNumber();
-                        if(info->cluster < 1)
+                        info->hub = lexer.readNumber();
+                        if(info->hub < 1)
                         {
-                            Con_Error("MapInfoParser: Invalid cluster number '%s' in \"%s\" on line #%i",
+                            Con_Error("MapInfoParser: Invalid 'cluster' (i.e., hub) number '%s' in \"%s\" on line #%i",
                                       lexer.token(), F_PrettyPath(Str_Text(path)), lexer.lineNumber());
                         }
                         continue;
@@ -237,8 +237,8 @@ void MapInfoParser(Str const *path)
     for(MapInfos::const_iterator i = mapInfos.begin(); i != mapInfos.end(); ++i)
     {
         mapinfo_t const &info = i->second;
-        App_Log(DE2_DEV_RES_MSG, "MAPINFO %s { title: \"%s\" cluster: %i map: %i warp: %i }",
-                                 i->first.c_str(), info.title, info.cluster, info.map, info.warpTrans);
+        App_Log(DE2_DEV_RES_MSG, "MAPINFO %s { title: \"%s\" hub: %i map: %i warp: %i }",
+                                 i->first.c_str(), info.title, info.hub, info.map, info.warpTrans);
     }
 #endif
 }
@@ -258,29 +258,29 @@ mapinfo_t *P_MapInfo(Uri const *mapUri)
 
 uint P_TranslateMapIfExists(uint map)
 {
-    uint matchedWithoutCluster = P_INVALID_LOGICAL_MAP;
+    uint matchedWithoutHub = P_INVALID_LOGICAL_MAP;
 
     for(MapInfos::const_iterator i = mapInfos.begin(); i != mapInfos.end(); ++i)
     {
         mapinfo_t const &info = i->second;
 
         if(info.warpTrans == map)
         {
-            if(info.cluster)
+            if(info.hub)
             {
-                App_Log(DE2_DEV_MAP_VERBOSE, "Warp %i translated to logical map %i, cluster %i", map, info.map, info.cluster);
+                App_Log(DE2_DEV_MAP_VERBOSE, "Warp %i translated to logical map %i, hub %i", map, info.map, info.hub);
                 return info.map;
             }
 
-            App_Log(DE2_DEV_MAP_VERBOSE, "Warp %i matches logical map %i, but it has no cluster", map, info.map);
-            matchedWithoutCluster = info.map;
+            App_Log(DE2_DEV_MAP_VERBOSE, "Warp %i matches logical map %i, but it has no hub", map, info.map);
+            matchedWithoutHub = info.map;
         }
     }
 
-    App_Log(DE2_DEV_MAP_NOTE, "Could not find warp %i, translating to logical map %i (without cluster)",
-            map, matchedWithoutCluster);
+    App_Log(DE2_DEV_MAP_NOTE, "Could not find warp %i, translating to logical map %i (without hub)",
+            map, matchedWithoutHub);
 
-    return matchedWithoutCluster;
+    return matchedWithoutHub;
 }
 
 uint P_TranslateMap(uint map)