Changelog

Table of Contents

• Changelog
  • Version 1.10.0
  • Version 1.9.5
  • Version 1.9.1
  • Version 1.9.0
  • Version 1.8.2
  • Version 1.8.1
  • Version 1.8.0
  • Version 1.7.3
  • Version 1.7.2
  • Version 1.7.1
  • Version 1.7.0
  • Version 1.6.0
  • Version 1.5.0
  • Version 1.4.1
  • Version 1.4.0
  • Version 1.3.0
  • Version 1.2.0
  • Version 1.1.0
  • Version 1.0.1
  • Version 1.0.0

Changelog

Changelog of the MultiWorld plugin.

Version 1.10.0

Migration notes (from v1.9):

• the new feature Auto handling of the Input Mode introduces a breaking change, since it's enabled by default. We suggest to update your code to take advantage of the new feature, because it simplifies the Worlds' initialization code and makes them able to work also when launched directly (helpful for testing them). To use the new feature in normal use-cases, you should simply move your code that configures the InputMode in the Levels' BeginPlay method, removing the implementation of the IMultiWorldActorInterface interface if no more needed. If instead you prefer or need to preserve the old behavior: call UMultiWorldStatics::SetAutoHandleInputModeForMainWorld() once passing false during your game initialization; then set FMultiWorldLoadParameters::bAutoHandleInputMode to false on each call of the LoadWorld*() methods.
• Function UMultiWorldStatics::EndWorld() is marked as deprecated and will be removed in a future update. Call UMultiWorldStatics::EndWorldWithDelegate() or the EndAllWorldsAsync BP node instead.

New features:

• Input Mode is automatically handled when switching between worlds. The feature is enabled by default and makes the common pattern of setting the Input Mode in the BeginPlay of a Level to work out-of-the-box also with MultiWorld, not requiring any change to existing code and allowing the Level to be tested directly with Play-In-Editor or with a simple OpenLevel. For advanced scenarios, the feature can be controlled by FMultiWorldLoadParameters::bAutoHandleInputMode and UMultiWorldStatics::SetAutoHandleInputModeForMainWorld(). Read more at Input Modes.
• Added functions UMultiWorldStatics::EndWorldWithDelegate(), UMultiWorldStatics::EndAllWorldsWithDelegate(), EndWorldAsync BP node,EndAllWorldsAsync BP node.
• Added the function UMultiWorldStatics::GetWorldPtr(), to retrieve a UWorld * given a FMultiWorldHandle.
• Added the property FMultiWorldLoadParameters::URLOptions, it's an optional string of options like the ones passed to the standard OpenLevel function. For example it can be used to instantiate a custom Game Mode in the loaded Level setting it to "?Game=<GameModeClass>".

Bug fixes:

• Fixed UMultiWorldManager::LoadWorldAsync() failing to load the same map multiple times.
• Fixed an assert firing when using the World Partition.
• Fixed an assert firing when using the World Composition in PIE.

Version 1.9.5

Bug fixes:

• (UE5.5) Fixed GameInstance's WorldContext resetting when unloading a Secondary World.

Version 1.9.1

Bug fixes:

• Fixed UMultiWorldStatics::GetAllObjectsWithInterface() returning also objects potentially marked as pending kill or garbage.

Version 1.9.0

New features:

• (UE5.3+) New implementation of automatic handling of UMG Widgets. The new implementation uses a custom SOverlay layer as top Slate layer for each UWorld instance, this ensures that all UMG Widgets are added-to/removed-from it transparently. When changing the active UWorld instance, the custom SOverlay layers are switched accordingly. This solution is much more robust when handling corner cases (e.g. UMG Widgets added during a Secondary World initialization, handling of UMG Widgets from Background Worlds, etc.), and more efficient when switching the Active World.
• (UE5.3+) Added the C++ utility class FScopeLocalPlayerOnWorld to temporarily force a given ULocalPlayer (and APlayerController) on a UWorld.
• Added tentative support for non-Unity builds. Setting bUseUnity = false; in the module should now compile the plugin without major errors.

Bug fixes:

• Fixed Out of Memory error when using a UMultiWorldSceneCaptureComponent2D component to render a Background World using Distance Fields.
• Fixed Level Sequences not working in Secondary Worlds. Please read the notes on existing limitations.
• Fixed Sublevels in Secondary Worlds not loaded in-editor until activating the Secondary World.
• Fixed a possible crash during plugin shutdown when calling GameViewportClientEx::SetAudioDevice().

Version 1.8.2

Bug fixes:

• Fixed asserts in UE5.3 when loading a map using the World Partition.

Version 1.8.1

Bug fixes:

• Fixed "freezing" of the game viewport when switching between PIE and SIE.

Version 1.8.0

New features:

• Added methods UMultiWorldStatics::RequestSwitchWorld() and UMultiWorldManager::RequestSwitchWorld().

Bug fixes:

• Fixed minor issues with the replication of the Main World when PIE.
• Fixed crash at exit when two or more XAudio devices are disposed.

Version 1.7.3

Bug fixes:

• Fixed VR head tracking not working in Secondary Worlds.

Version 1.7.2

Bug fixes:

• Fixed Navigation System initialization in Secondary Worlds.
• Fixed missing BlueprintSpawnableComponent specifier for UMultiWorldSceneCaptureComponent2D, that now it's listed in the component types available in the Blueprint editor.

Version 1.7.1

Bug fixes:

• Fixed a possible crash in UE5 after an UWorld instance is ended. This is caused by an UE5 engine bug when the outer of a FTickableGameObject object is destroyed by the GC, but the tickable object remains alive and marked PendingKill; the engine continues ticking it, causing an UB (and possibly a crash). See also UDN #1, UDN #2.

Version 1.7.0

New features:

• revamped public demo project for Unreal Engine 5, with updated assets and samples. Check it on GitHub: https://github.com/UNAmedia/ue5-multiworld-demo. A pre-built version is also available: https://github.com/UNAmedia/ue5-multiworld-demo/releases.
• new video trailer: https://youtu.be/8hp0d_bq7eI
• new video tutorial: https://youtu.be/qVn2TjH8GbA

Notes:

• The Skylight could not render correctly in the UMultiWorldSceneCaptureComponent2D component when the "Real Time Capture" option is enabled and the component is in a Background World. For details and the workaround see Skylight "Real Time Capture".

Bug fixes:

• Fixed input action gets stuck if active during a seam transition.
• Fixed UMultiWorldSceneCaptureComponent2D missing a persistent rendering state, resulting in wrong captures.
• Fixed UMultiWorldSceneCaptureComponent2D stops updating when used with seam transitions between a group of different worlds.
• Fixed crash/assert when the main viewport content is not containing a SConstraintCanvas widget. In this case the fallback is to keep the widget on screen when switching world.
• Fixed crash/assert when PIE with a mobile previewer.
• Fixed crash/assert when the virtual joystick/touch interface is enabled.
• Fixed crash/assert when ESceneCaptureSource::SCS_FinalToneCurveHDR is used on UE4 mobile renderers. UE4 mobile renderers don't support capturing SCS_FinalToneCurveHDR, so SCS_FinalColorHDR is used instead.

Version 1.6.0

Migration notes (from v1.5.0):

• The syntax of all the Load World methods has changed. This was required to support the new Enhanced Input plugin used by default in UE5.1, that defers some important activities. This change allowed us to improve the existing API, providing a better and homogenous solution.
  • Blueprint changes:
    • the new nodes Load World and Load World Async are provided; they have a Completed execution flow that is activated when the Secondary World is ready and its World Handle is returned;
    • if delegates are preferred, the nodes Load World with Delegate and Load World Async with Delegate can be used instead.
  • C++ changes:
    • UMultiWorldManager::LoadWorld() and UMultiWorldManager::LoadWorldAsync() now use a completion callback to return the FMultiWorldHandle;
    • if delegates are preferred, you can use UMultiWorldStatics::LoadWorldWithDelegate() and UMultiWorldStatics::LoadWorldAsyncWithDelegate();
  • while all the methods pairs above share the same syntax now, they work in a very different way:
    • the non-Async versions are blocking calls, check this documentation for the details;
    • the Async versions are non-blocking calls, check this documentation for the details.
• UMultiWorldManager::OnAsyncLoadCompleted is now UMultiWorldManager::OnLoadWorldCompleted.

New features:

• Added support for Unreal Engine 5.1.
• Added support for the World Partition feature in UE5.1 (this feature is not supported on UE5.0).

Bug fixes:

• Fixed compatibility with the Enhanced Input plugin.

Version 1.5.0

New features:

• Added method UMultiWorldStatics::GetPlayerController() to workaround issues with the UE5 implementation of UGameplayStatics::GetPlayerController(). Check the dedicated notes for important information.

Bug fixes:

• Fixed ULocalPlayer referencing the wrong UPlayerController during UWorld ticking of Background Worlds.
• Fixed Level Streaming refreshing content on World Switching.

Version 1.4.1

• Fixed: UMG Widgets can be garbage collected when initialized in a Background World.
• Fixed: the audio device handle used by the viewport is not synced with the one of the Active World.

Version 1.4.0

Migration notes (from v1.3.0):

• The following methods of UMultiWorldOverrides have been renamed for consistency:
  • AddViewportWidgetContent() is now GameViewportClient_AddViewportWidgetContent();
  • AddViewportWidgetForPlayer() is now GameViewportClient_AddViewportWidgetForPlayer().
• In the documentation of each method of UMultiWorldOverrides is now described how the call to the Super implementation must be handled, review your implementation accordingly.
• UE5.0.2 fixed the issues introduced with UE5.0.0 and documented in the notes about UGameplayStatics::GetPlayerController(). The described workarounds are no more needed in UE5.0.2.

Bug fixes:

• Fixed a crash in UE5.0 when closing a PIE session started with Net Mode set to Play As Client.
• Fixed renaming packages in UE5.0 when using the Zen Loader (mainly in non-editor builds). One of the possible issues was UMultiWorldManager::LoadWorldAsync() freezing.

Version 1.3.0

Migration notes (from v1.2.0):

• If you are using a custom Game Viewport Client class instead of the provided UMultiWorldGameViewportClient, you must implement few new overrides:

  • AddViewportWidgetContent()
  • AddViewportWidgetForPlayer()

  Check the documentation in UMultiWorldOverrides for details.

• UE5.0 introduced a bug in a few commonly used functions, read notes about UGameplayStatics::GetPlayerController() for the needed workarounds. This does not apply to UE4.

New features:

• Added support for Unreal Engine 5 (UE5.0). Check notes about UGameplayStatics::GetPlayerController() for important notes.
• You can now use the common Pause/Step/Resume debug buttons when multiple Worlds are ticking in a Play-In-Editor session.
• Breakpoints on Blueprints are now pausing all the ticking worlds.

Bug fixes:

• UMG Widgets added to the viewport during the tick are now handled correctly: if they don't live in the Active World (e.g. because crated in a Background World), they will be added later when the corresponding owning world will become the Active one.

Version 1.2.0

New features:

• Material Instances are now supported by UMultiWorldSeamTransition (see Visual transitions on World Switching).
• New parametrized materials, to be used with UMultiWorldSeamTransition, are provided with the plugin.

Bug fixes:

• If no Audio Device Manager is detected, all Secondary Worlds will share the same audio device of the Main World (thanks to Luben for the report).
• Fixed UWidgetComponent appearing also as 2D widgets on screen when switching the Active World (thanks to lovewater for the report).
• Fixed missing calls when closing a Secondary World (in particular: EndPlay() on actors and flushing of streamed levels).
• Render Target textures used by UMultiWorldSeamTransition are now properly resized if the viewport size changes between distinct transitions.

Version 1.1.0

New features:

• You can now change the Active World playing a nice and customizable visual transition effect. Read more on Visual transitions on World Switching .
• You can now capture scenes from Background Worlds, using the render targets as you prefer. Read more on Scene capture .
• It's now safe and supported to call UMultiWorldStatics::EndWorld() on the Active World (in this case UMultiWorldStatics::ReturnToMainWorld() is called automatically).

Bug fixes:

• (breaking change) Removed the property bDuplicateOnLoad from FMultiWorldLoadParameters: duplicating packages with cooked data could cause errors at runtime, so now the package is renamed with an unique name instead of duplicating it. Note that this implies that calling UMultiWorldStatics::LoadWorld() a second time on an already loaded map will force a new load of the corresponding package.
• Fixed an issue when UMultiWorldStatics::EndWorld() is called on a ticking world while PIE.
• Fixed a possible assert on UE4.26 when FMultiWorldLoadParameters::bCreateDedicatedAudioDevice is false.

Version 1.0.1

• Fixed an issue with level streaming and World Composition when Playing-In-Editor.

Version 1.0.0

• First release.