Sub Hubs

[This article is WIP]

Sub-hubs is a feature (introduced in the TheXTech since the version 1.3.6.5) that allows episode makers to mark multiple levels where player of their episode will be able to save the game, even if the episode uses a world map.

A small note that this feature doesn't work on existing SMBX 1.3 content: all existing episodes will behave same as before, as this feature is for new-developed episodes where episode maker can fill a list of sub-hubs where player can save.

Description

There are several projects that gave the idea of the sub-hubs concept for various purposes: having differently-styled "worlds" at the hub-based episodes, with many additional levels used to extend the main hub. However, all the time there was no ability of players to save the game here: every time player wants to save the game, they should return to the main hub. Otherwise, their progress will be lost on exit. Also, some episodes with world maps do use some levels as hubs to other levels, with no simple way to quit to the world map other than completing a level.

The "Sub-Hubs" feature of TheXTech allows episode makers to fill the "Sub-Hubs list" field at the World Map via Moondust Editor, where it is possible to list all the levels of the episode where the player will be able to save and resume the game, in addition to the world map or the main hub.

Preparation

In order to use this feature, the TheXTech must be updated to 1.3.6.5 or newer, and both the latest Moondust Devkit from the "Laboratory" and the latest version of "TheXTech SDK" config pack are required (otherwise, the sub-hubs list will not be shown in the World Map editor).

Usage

The use of this feature is quite easy: while editing the world map via Moondust Editor, you can open the "World Settings" toolbox where you can add any level of the episode into the Sub-Hubs list. Once a level is added to this list, the Pause Menu during the playthrough will be shown as it looks on the Main Hub or the World Map. Once player saves the game on the Sub-Hubs-listed level and quits the game, the next time when the player starts playing this episode using the same gamesave, they will continue the game at the start point or the last used level warp of the sub-hub level where the player saved the game. Additionally, player will be able to switch the playable character here.

Behaviour logic

In order to avoid further confusions, here is a list of actions that may happen during various cases:

• When the player uses the normal level exit (ball, sphere, tape, etc.) on an ordinary level (not listed as a Sub-Hub), they return to the sub-hub they entered this level from (if any).
• When player fails on an ordinary level (assuming that the "restart on failure" episode option is not enabled), they return to the recent sub-hub.
• When player quits an ordinary level via off-screen exit, they return to the world map or the main hub (ignoring any Sub-Hubs).
• When the player uses the normal level exit on a Sub-Hub level (explicitly listed as a Sub-Hub), they return to the world map or the main hub.
• When player fails on the sub-hub level, they return to the world map or the main hub.

If you want to fully control the route of player's going between sub-hubs and ordinary levels, there are next tips:

• Use the warp exit only (with destination sub-hub and the warp index) to let player exit level or go to another place. For such purposes you can use warp of next types: Doors, Pipes, or Portals, but not the "Instant" type as it doesn't allow to go between levels at all (According SMBX64 standard).
• Enable the "restart on failure" option to prevent going of player into the unexpected place.