Changelog

Table of Contents

• Changelog
  • 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.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.