🗒️Release notes

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Removing support for legacy user collection endpoints

Affected Features: User Collection

What’s broken and why?

We have removed legacy methods of calling FetchObjectDefintion and MakeTransferRequest.

How to fix it?

Use the newer API functions with the same names.

How to test it?

Ensure you functionality works as intended.

Crowd Audio reverb live config settings moved

Affected Features: Audio

What’s broken and why?

All the live config settings relating to crowd audio’s “reverb” feature have been moved into a single setting struct, to make things neater. Some unused flags were removed, and some new ones were added, which will have no effect. However, some flags were moved. It’s very unlikely that overrides for these will have been applied, but if a project did have overrides, they will need to be migrated across.

The affected config flags were moved from CrowdAudioSettings.PreprocessorSettings to CrowdAudioSettings.ReverbSettings:

• EnableUnrealReverbApplication

• UnrealReverbGain

• EnableBotReverb

How to fix it?

If you have any morpheus.override.json files, make sure the values above are moved to the correct parent (ReverbSettings instead of PreprocessorSettings). If you don’t have any of these, then you don’t need to do anything!

How to test it?

Run the game - spatial audio should sound the same as before.

Interact function on Interact handler now takes an array of components

Affected Features: Interaction

What’s broken and why?

The Interact function now takes an array of Interactable components rather than a single component as a parameter. This is to re-enable MML interactables which have a unique component per interaction option, and thus multiple components per actor.

Any instances of calling the Interact function will no longer compile.

How to fix it?

Use a MakeArray node from the interactable component you are looking to pass in, then pass this array in as the new parameter.

How to test it?

Verify that your blueprint now compiles and your interaction logic runs as expected.

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

The map select buttons in the new upload menu do not function as expected. A workaround is to go to Project Settings -> M2 World Builder Data and modify the maps you wish to be uploaded there instead. This will be fixed in the next release.

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

This includes testing in both low latency (5k ccu) and High Scale (15k ccu) modes.

Low Latency Performance

High Scale Performance

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Role and Capability Updates

Affected Features: Roles and Capabilities

What’s broken and why?

Nearly all projects roles will be broken as role tables have been been adjusted heavily in MSquared. Many capabilities have been renamed or removed. This is in an attempt to clean up/simplify roles and capabilities.

How to fix it?

All references to capabilities that have been removed/renamed will need replacing in downstream assets.

We expect all projects to recreate their roles from scratch. Please use this document to aid in this process: https://docs.msquared.io/tutorials-and-features/roles/game-roles You probably want to copy DT_RolesExample and make adjustments, adding/removing roles and updating capabilities where needed.

Our old reference data table “DT_Origin_Roles“ has not been removed yet to allow people to view the how roles were setup before this change. It will be removed once projects have updated their roles.

Capability removals:

• Capabilities.DirectorBoothAccess

• Capabilities.DeathRing2ndWave

• Capabilities.DeathRing3rdWave

• Capabilities.VoiceNormalVolume.Boss

• Capabilities.VoiceNormalVolume.Presenter

• Capabilities.VoiceNormalVolume.Participant

• Capabilities.ChatAdmin

• Capabilities.Tutorial.AutoComplete

• Capabilities.Inventory.BindQuickbarActionsInHandler

• Capabilities.Repulsor.RegularAccess

• Capabilities.Approachability.HoldClickToMoveForwards

• Capabilities.Approachability.ClickMove

• Capabilities.Approachability.EdgeLook

• Capabilities.PlayerCount.FeatureFlag

• Capabilities.Director.UseControlPanelHandler

Capability renames:

• Capabilities.ObserverAudioMixer - Capabilities.ControlPanel.CanOperateAudioControls

• Capabilities.LiveConfigPanel - Capabilities.ControlPanels.LiveConfigControlsEnabled

• Capabilities.ActivityControls - Capabilities.ControlPanels.Enabled

• Capabilities.Director.AutoOpenPanels - Capabilities.ControlPanels.AutoOpen

• Capabilities.AlwaysShowProfileEmote - Capabilities.Emotes.AlwaysShowProfileEmote

• Capabilities.Voice.VoiceCommands - Capabilities.VoiceChat.CommandsEnabled

• Capabilities.HideAvatarSelection - Capabilities.CharacterCustomization.AvatarSettingVisible

• Capabilities.CanWalk - Capabilities.Movement.CanWalk

• Capabilities.CanWalk - Capabilities.Movement.CanSprint

• Capabilities.PlayerContent.Interop.ImportMML - Capabilities.MML.CanImportMML

• Capabilities.PlayerContent.MML.ImportMML - Capabilities.MML.AdminAccess

• Capabilities.InteropViewSourceUrls - Capabilities.Pedestals.CanSeeMMLUrls

• Capabilities.PlayerCount.Always - Capabilities.PlayerCount.Enabled

• Capabilities.Voice.VoiceAdmin - Capabilities.VoiceChat.Admin

• Capabilities.Voice.VoiceLoudspeaker - Capabilities.VoiceChat.LoudspeakerEnabled

• Capabilities.Voice.VoiceAuthority - Capabilities.VoiceChat.Authority

• Capabilities.Voice.VoiceCommands - Capabilities.VoiceChat.CommandsEnabled

• Capabilities.Voice.VoiceToggle - Capabilities.VoiceChat.ToggleEnabled

• Capabilities.Voice.VoiceChat - Capabilities.VoiceChat.Enabled

• Capabilities.IgnoreMassFollow - Capabilities.DeviceSettings.Capabilities.IgnoreMassFollow

• Capabilities.IgnoreMassTeleport - Capabilities.DeviceSettings.Capabilities.IgnoreMassTeleport

• Capabilities.CanModifyPlayerUserCollections - Capabilities.UserCollection.CanModifyPlayerUserCollections

• Capabilities.ObserverAudioMixer - Capabilities.ControlPanels.AudioControlsEnabled

• Capabilities.CanUseCinematicGraphics - Capabilities.Settings.CanUseCinematicGraphics

• Capabilities.ControlSettings.Approachability.VirtualCursor - ControlSettings.Approachability.VirtualCursor

• Capabilities.Interaction.CanOperateDoors - ControlSettings.Doors.CanOperateButtons

• Capabilities.OBSBroadcaster - ControlSettings.Streaming.OBSBroadcastEnabled

• Capabilities.Mocap - ControlSettings.Mocap.Enabled

Additional Fixes:

• The following functions have been removed from AJM_CapabilitiesManager: HasVoiceChatAdminCapability, HasVoiceChatCapability, HasVoiceChatAuthority. You should not need to go through the CapabilitiesManager to check for these capabilities as they are all accessible in blueprints.

• Capabilities.Approachability.HighlightInteractables has now been replaced by the live config value Game.Interaction.HighlightInteractingObjects. It is now no longer configurable per role.

• Capabilities.ObserverControls previously only disabled the emote and character customization UI. This capability has been replaced with opt in capabilities: Capabilities.Emotes.Enabled and Capabilities.CharacterCustomization.Enabled.

• ForceToForeground was previously enabled directly on the J_RoleConfiguration structure. A new capability Capabilities.Morpheus.ForceToForeground has replaced this bool.

• EmotesEnabled was previously enabled directly on the J_RoleConfiguration structure. A new capability Capabilities.Emotes.Enabled has replaced this bool.

How to test it?

Test your project roles and all functionality related to capabilities are functional as expected.

BP_PlayerController & BP_Origin_PlayerController cleanup

Affected Features: Player Controller

What’s broken and why?

Player Controller now handles getting live config values through ConfigUpdatedDelegate & GetLiveConfigValues . This change means the BP_Origin_PlayerController no longer needs to bind to the delegate or have it’s own event to get live config values, it now overrides the parent function GetLiveConfigValues.

If you were previously overriding GetLiveConfigValues from the Origin controller your controller will no longer compile.

How to fix it?

Override parent function GetLiveConfigValues . Make sure the call to Parent:GetLiveConfigValues is in the function. Move your logic from the old event override into the new function override.

How to test it?

Check that your controller compiles and that the logic runs as expected.

Ongoing BP_PlayerController cleanup

Affected Features: Player Controller

What’s broken and why?

Several event handlers stemming from begin play have been cleaned up into functions and renamed: Event: OnGameStart → function: OnBootflowStarted

Event: OnAuthActorSpawned → function: OnAuthActorSpawned Event: OnRenderTargetSpawned → function: OnAuthPawnSpawned

Event: OnInGame → function: OnBootflowFinished

How to fix it?

If your player controller was overriding any of the previously mentioned events, instead override the corresponding function and move your logic into the function.

How to test it?

Confirm that your Player Controller compiles and that the affected logic runs as expected.

Changed OnTextCommited event on WBP_M2_StandardInputTextButton to pass the Text and Commit Method through it

Affected Features: Standard UI

What’s broken and why?

Changed OnTextCommited event on WBP_M2_StandardInputTextButton to pass the Text and Commit Method through it

How to fix it?

Update any references to this event to accomodate the changes

How to test it?

Confirm that any blueprints that reference this event compiles and runs as expected

Removal of some modular character slots

Affected Features: Modular Characters

What’s broken and why?

The legacy Modular Character system is being deprecated in favor of MML avatars. Modular characters require a lot of background replicated properties for each ‘slot’, even though most slots are never used. To reduce the cost of the legacy system, the 11 least used of the 31 named slots are being removed. Each character can still have up to 20 meshes each, however some renaming may be required if you use any of the removed slots. The removed slots are: ArmL, ArmR, LegL, LegR, Crown, Jaw, Glasses, Earring, Lips, Wings, Tail.

How to fix it?

The slots have no semantic meaning, so if you use one of the removed slots you just need to switch it to one of the remaining slots. The only changes required for each affected slot are:

1. Change any direct uses of the removed enum values. E.g. use Eyes instead of Glasses.

2. Rename the affected modular character PDA directory to the new slot. E.g. rename /MyPDAPath/MyCharacter/Glasses/PDA_Sunglasses to /MyPDAPath/MyCharacter/Eyes/PDA_Sunglasses

How to test it?

You modular characters should behave as before with no missing parts.

BPC_M2_CharacterZeroGExample removed from BP_M2_PlayerCharacterBase

Affected Features: Zero-G (locomotion?)

What’s broken and why?

The BPC_M2_CharacterZeroGExample component isn’t needed by default, and thus has been removed from the base character. All related functionality has been isolated into the component itself.

How to fix it?

If you still require BPC_M2_CharacterZeroGExample, please re-add it on your character BPs deriving from BP_M2_PlayerCharacterBase.

How to test it?

Check that your character still responds to movement input correctly. If you use Zero-G in your project, enable it through the component and check that the movement input works as expected.

WorldBuilderData override image removed

Affected Features: World Builder / Self Serve platform

What’s broken and why?

We have removed the override image in the World Builder Data settings in Project Settings in favor of using the mod and world images.

How to fix it?

If you did not use an override image, or your override image was the same as your mod or world, you don’t need to do anything.

If you had a different image set, you need to take the image you used for the override image and set it for the mod or world via the dashboard by clicking “Update Image” on your world or mod page.

How to test it?

Launch and join a world. You should see your mod or world image used for the splash screen.

Deprecated UserData functions removed

Affected Features: User Data / Key Value Store

What’s broken and why?

The following deprecated methods have been removed from the UserDataStore Function Library due to the obsolete underlying api being removed.

• ReadUserDataObject

• ReadUserDataObjectBatch

• WriteUserDataObject

• WriteUserDataObjectBatch

How to fix it?

These methods have been flagged as deprecated since April 2023 and there have been no hits on the apis for >6 months so it’s unlikely anyone will be affected. Additionally, gameplay systems often consume these apis via the Persistence system, which was ported over a long time ago.

If you find that your system is using the legacy methods, you will need to port over to the replacement methods:

• ReadUserDataValue

• ReadUserDataValueBatch

• WriteUserDataValue

• WriteUserDataValueBatch

However, the replacements aren’t 1:1 in that there’s a potential for them to use different backing data structures.

If you believe that you have data in the old apis that you wish to keep, then please contact the MSquared Web Platform support.

How to test it?

Swap over to the new Read/WriteDataValue methods and verify that your system can still persist data.

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

This includes testing in both low latency (5k ccu) and High Scale (15k ccu) modes.

Low Latency Performance

High Scale Performance

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

M2Services config restructure

Affected Features: M2Services config

What’s broken and why?

To consolidate config definition, we’ve moved all M2_Services config into the M2Services config. We shouldn’t have had two config definitions at any point, and this change rectifies that.

The two config classes that were in the legacy config file and have now moved are UM2_DomainSettings and UM2_WorldUserDataComponent.

How to fix it?

Checking your project’s Config directory for any ini files with M2_Services in their name. Ensure to check for any variants that might include ByStream. Either rename the file to remove the underscore (eg. M2_Services.ini >> M2Services.ini) or if the destination file already exists, consolidate the changes of both files into the destination file.

How to test it?

Verify you’re able to launch a client in editor, and you’re able to connect to a deployment and access your project’s roles.

Quickbar TabsData array moved from WBP_QuickbarTabManager to M2M_TabbedQuickbarComponent

Affected Features: Tabbed quickbars

What’s broken and why?

The TabsData array in WBP_QuickbarTabManager was renamed to PreviewTabsData, and should be used only for previewing tabs in the Widget Designer. The OverrideTabsData array in WBP_ItemManagement has been removed, and projects are expected to define their tabs in a M2M_TabbedQuickbarComponent on their Morpheus Player Character. The WBP_QuickbarTabManager will reference the data in M2M_TabbedQuickbarComponent if found on the player character, otherwise it will fall back to the PreviewTabsData.

How to fix it?

Checking with an older editor version, take note of all OverrideTabsData entries from WBP_ItemManagement and any TabsData entries in WBP_QuickbarTabManager. In the latest editor, add these into a M2M_TabbedQuickbarComponent on the Morpheus Player Character. (This component should already exist on BPM_Origin_PlayerCharacter)

How to test it?

Ensure only the desired quickbar tabs display and work as expected.

Rename of folder SettingAssets to SettingData in M2Content/UI/Settings

Affected Features: UI Sliders

What’s broken and why?

Two assets have been moved, M2Content/UI/Settings/SettingAssets/DA_DefaultSliderSetting.uasset and M2Content/UI/Settings/SettingAssets/DA_OnOffToggleSetting.uasset to M2Content/UI/Settings/SettingData/. This is to adhere to M²'s linting rules.

How to fix it?

Core redirects have been added so ideally you shouldn’t have to fix anything. If you have UI assets or data tables like DT_SettingList which had references to the removed assets, you may have to fix those references manually to point to these assets again.

How to test it?

If your Audio sliders and other sliders in your UI appear and work fine, this has been resolved.

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

This includes testing in both low latency (5k ccu) and High Scale (15k ccu) modes.

v20 Low Latency Performance

v20 High Scale Performance

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Removed legacy chat server from singletons list

Affected Features: Legacy text chat system

What’s broken and why?

ChatServerClass has been removed from the singletons list. This was only required for the legacy text chat system, and would create a chat server actor in world. No projects should still be using this system.

How to fix it?

If you really need the legacy system you can add the chat server class back into the AdditionalSingletons section in the world details.

How to test it?

Text chat continues to work.

Various Audio Mixer channels and SoundClasses have been renamed/added

Affected Features: Audio

What’s broken and why?

Various Audio Channels / Sound Sub Mixes and Sound Classes (and corresponding Sound Control Buses) have been added/renamed to create the following Audio Mixer hierarchy:

How to fix it?

Any audio assets with an inappropriate SoundClass can be assigned one of the new Classes (which map 1:1 to the above Submix hierarchy. This can be done by setting the Class property on the audio asset. Setting a Class will automatically assign the correct submix, ensuring that the sound responds to volume sliders, etc.

How to test it?

The AudioMixer role can be used to view the new mixer hierarchy (by tapping I), the channels, and any audio content being received by them can be seen in the Mixer UI.

Moving AutoProfiler to its own plugin

Affected Features: AutoProfiler

What’s broken and why?

Due to development on the AutoProfiler for end-to-end tests, features within M2Content are needed in the AutoProfiler which cannot be accessed from M2Core. For example, waiting to reach the target CCU bot count and finish shader compilation requires M2Content. Because of this and the need for future extension, the AutoProfiler has been moved into its own plugin called M2AutoProfiler.

How to fix it?

Projects will need to include M2AutoProfiler as a plugin. M2Development.uproject and M2StarterProjectBP.uproject have already been updated.

How to test it?

Verify that the uproject successfully cooks.

Renaming OnInteractionRequested to OnOptionSelected

Affected Features: Interaction

What’s broken and why?

The delegate OnInteractionRequested in the interactable handler component was a bit of a misnomer, as it implies that it is broadcast at the point when the user instigates an interaction. It actually broadcasts at the point when the user selects an option. Previously this was a minor problem but as part of the interaction refactor I have added a new event OnInteractRequested which is broadcast at the point of an interact being requested, as such the old delegate needed a clarity rename.

How to fix it?

The core redirect should take care of the problem, but if your class is attempting to bind to OnInteractionRequested, make sure it now binds to OnOptionSelected instead.

How to test it?

Verify that any event you had previously bound to OnInteractionRequested is being called when you expect it to.

Removing “Single target interaction” from player controller

Affected Features: Interaction

What’s broken and why?

Previously the flow to trigger an interaction was to call TriggerSingleTargetInteract on the player controller, which then kept track of if it thought a single target interaction was in progress (vs no longer functional multi target) and handled a bunch of logic under the hood which added complexity and made the system more brittle and harder to understand.

How to fix it?

You can now simply call Interact on the Interactable handler, passing through the component you wish to interact with. This component can be found by calling FindTargets on the handler, with a targeting strategy to use for this as the parameter, or by any other external means.

How to test it?

Verify that your interaction still occurs using the new flow.

Removing UmediaPLayyer::OpenUrlInBackgroundThread

Affected Features: Engine

What’s broken and why?

OpenUrlInBackgroundThread is being removed as some of the code which it interacts with is not thread safe and subsequently using it can lead to a crash.

This function is not used any where in m2, I believe it was discovered to not be stable previously and was switched over to using a stable variant (not on a background thread); but the risky function was not removed.

How to fix it?

Use the OpenUrl function instead of OpenUrlInBackgroundThread.

How to test it?

Verify that your url opens as expected.

Modifications to Currency Widgets

Affected Features: Currency Widgets

What’s broken and why?

We have two example widgets for displaying currency. We have decided for simplicity to remove WBP_Currencies and keep WBP_Currency. WBP_Currency has also been updated so that it can be configured to display whatever currencies you like rather than all currencies in the project.

How to fix it?

Replace any use of WBP_Currencies with WBP_Currency or your own widget implementations. If you opt to use WBP_Currency, ensure it’s configurable “Currencies“ property is configured suitably.

Refactor of MML Inventory Component

Affected Features: Staring MML inventory items

What’s broken and why?

M2_MMLInventoryComponent - Removed M2M_PlaceModeComponent - Removed M2_MMLItemFunctionLibrary - Removed

We are refactoring the M2_MMLInventoryComponent and moving it into blueprints. This is because our example logic for turning user collection objects into inventory items live in blueprints. There is now a single extendable flow for managing user collection objects and adding representative inventory items.

How to fix it?

If you are using M2_MMLInventoryComponent or M2_MMLItemFunctionLibrary, reach out to the support channel to help fix the issue. If you are using M2M_PlaceModeComponent, you should be able to change referances of it to BPMC_PlaceModeComponent.

How to test it?

Check your MML user collection objects are still being turned into inventory items.

Changes to StartingObjects Live Config

Affected Features: Staring MML inventory items

What’s broken and why?

Due to a refactor, it no longer makes sense to add starting MML objects to your inventory using the Inventory.MML live config values.

How to fix it?

You should now use the settings under UserCollection.StartingObjects.MML instead. This will add objects to your user collection that can then be interpreted as inventory items.

How to test it?

Check your offline MML objects and devices appear as expected.

Avatar Editor refactor

Affected Features: Avatar Editor

What’s broken and why?

Common avatar editor functionality was moved the AvatarEditorActor into a component on the player so other systems could use it modify and save your avatar. The flow of initialising and opening the AvatarEditorActor has changed as you now need to supply it with the player that will be using it.

How to fix it?

If you’ve made your own copy of BP_AvatarEditorActor then you need to call SetCurrentPlayer instead of using HasItemDefinitions() and InitFromCurrentPlayerAvatar(). See the updated BeginPlay and OpenEditor in BP_AvatarEditorActor for an example of how it should work.

If possible though, stop using your own copy and go back to using BP_AvatarEditorActor as a base. This applies to Indus as it only took a copy to get some features early.

How to test it?

Avatar Editor should open as normal.

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

This includes testing in both low latency (5k ccu) and High Scale (15k ccu) modes.

v20 Low Latency Performance

v20 High Scale Performance

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Interaction Targeting Strategy cleanup

Affected Features: Interaction

What’s broken and why?

• M2_DefaultTargetingStrategy renamed M2_CursorLineTraceTargetingStrategy to be more explicit about it’s functionality rather than implying intended use case at the time of creation.

• Removed BP_ExplicitTargetingStrategy , was deprecated a while back as part of the interaction refactor. It was originally implemented to do several tasks not idiomatic to the system and is being removed in a robustness pass.

• Removed BP_ActorTargetinigStrategy, which was a temporary patch to maintain expected functionality until further refactor work could be done.

How to fix it?

Make sure any assets which previously referenced M2_DefaultTargetingStrategy are updated to use M2_CursorLineTraceTargetingStrategy. It is not expected that the deprecated targeting strategies are being used any where, but if you were using one of them to hold a target to be used later; it is now possible to simply call Interact(InteractableComponent* interactable) with a previously discovered interactable, so caching a target is no longer necessary.

How to test it?

Check that interactions still occur as expected.

Decoupling Interaction from Targeting strategies

Affected Features: Interaction

What’s broken and why?

The InteractableHandlerComponent has been refactored to allow interaction without relying on the under-the-hood targeting strategy. This is to make the interaction system simpler to use, and not have under-the-hood targeting potentially blocking an interaction the user expects without being clear why.

Several functions have been removed, including Target() and Interact() has changed.

How to fix it?

In order to trigger an interaction you simply need to call Interact(InteractableComponent* Interactable) passing the component you wish to interact with as the param. The target component can be obtain by using FindTargets(const TSubclassOf<UM2_InteractionTargetingStrategy> StrategyToUse) or by any other means.

How to test it?

Verify that interaction is working as expected.

Purchase Manager Actor Refactored into a subsystem

Affected Features: Purchasables

What’s broken and why?

The purchasable manager actor has been replaced with a subsystem and world component. This should make configuration simpler for projects.

How to fix it?

Use the world component to configure the purchasables in your world by adding the purchasable data tables the were used on your now depricated purchasable manager actor.

How to test it?

Ensure all your purchasables are still… purchasable.

Game Relevant User Collection System Depricated

Affected Features: User Collection

What’s broken and why?

The system has been removed as it is redundant.

How to fix it?

You will need to listen to updates coming from the user collection subsystem.

How to test it?

Ensure all you previous logic functions as desired.

Combat API has breaking changes and assets have been renamed or deleted

Affected Features: Action Gameplay

What’s broken and why?

Some of the combat API has been changed and projects using it will need to make changes to keep this working. Additionally, the combat folder and gym has been cleaned up and assets that projects may have been using as base assets may have been deleted or renamed, or had functionality stripped.

How to fix it?

Where blueprints fail to compile or functionality doesn’t work, use the examples in the combat gym as base points to fix up the project.

Assets that have been deleted or renamed are in M2Unreal\JunoSkypark\Content\Core\Combat.

How to test it?

Play the game and see that it works as usual with combat mechanics.

AvatarEditor changed to use dynamic render targets

Affected Features: Avatar Editor

What’s broken and why?

A change was made to the default avatar editor BPs and render target material to make it only create render targets on demand for perf reasons. Indus took a copy of the original BPs to work around some other limitations, but still uses M_AvatarEditor_RenderTarget which was changed. If you've not made a custom avatar editor, no changes are required.

How to fix it?

Quickest fix is to migrate to use your own copy of M_AvatarEditor_RenderTarget before updating to v19. The better fix is to remove the custom editor BPs and revert back to the M2 ones, as they now support the required functionality so the custom version shouldn’t be needed. Speak to @Andrew Fenwick for assistance.

How to test it?

Avatar editor should continue to show the character model.

Refactor Interaction Targeting Strategies from Unreal Interfaces to base UObject & rename

Affected Features: Interaction

What’s broken and why?

Any Targeting strategies that implemented the IM2_TargetingStrategy Interface will no longer work as expected. Using ScriptInterfaces for these caused some complexity and stopped us from adding some desired usability features, such as allowing a user to select which strategy to use from a dropdown.

This is in preparation to refactor the Interaction Handler to be more user friendly & robust.

How to fix it?

Any Targeting strategies which implemented the IM2_TargetingStrategy Interface will instead need to re-parent to the UM2_InteractionTargetingStrategy base class.

How to test it?

Test that your interaction targeting is working as expected.

Removed M2M_Seat asset

Affected Features: Seats

What’s broken and why?

Previous removal missed the actual asset. Base class and references were already handled, but this persisted and was blocking preflight on other interactables.

How to fix it?

This was already officially deprecated, so if something breaks please refer to the “Interactable Seats Removed From Origin” breaking change entry from 14/03/2024

How to test it?

Ensure all BP’s compile as expected.

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

This includes testing in both low latency (5k ccu) and High Scale (15k ccu) modes.

v19 Low Latency Performance

v19 High Scale Performance

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

IsItemValidForQuickbar uses ItemKeys instead of ItemNames

Affected Features: Inventory & Quickbar

What’s broken and why?

UM2_ItemQuickbarFunctionLibrary::IsItemValidForQuickbar and all related IsItemValidForQuickbar functions have int32 ItemKey instead of FName ItemName as their item parameter. This allows inspection of an inventory item’s properties, before assigning it to a quickbar. This is in preparation for the upcoming User Collection Item work, where properties will be more often used.

How to fix it?

Check that all blueprints inheriting from M2M_QuickbarComponent or M2_InventoryViewComponent still compile correctly. For those that have IsItemValidForQuickbar overrides, please get the ItemName as such:

How to test it?

Quickbar functions as expected, and all blueprints compile without errors or warnings

User Collection Object Tags to Properties What’s broken and why?

M2Connect are chaning the structure of user collections so that they no longer have a tags property. Tagging is now done by adding key value pairs to a “properties“ object on the user collection objects data property.

How to fix it?

If you use user collection object tags in someway, you will want use on of the following to gather a list of strings you can compare against: M2_UserCollectionFunctionLibrary::GetObjectContentTypes - If you are looking for “application“, “audio“, “image“, “model“ or “video“. M2_UserCollectionFunctionLibrary:: GetObjectProperties - If you are looking for anything else.

How to test it?

Ensure the functionality using tags now works with the new logic.

Removal of M2_UserCollectionItemDetails

Affected Features: User Collections

What’s broken and why?

We are removing M2_UserCollectionItemDetails in favour of a different configuration method.

How to fix it?

You can now configure the uid to item PDA mapping in the world settings.

Renamed Skypark BPM character and PlayerSpawner to Origin

Affected Features: gameplay

What’s broken and why?

BPM_Skypark_PlayerCharacter has been renamed to BPM_Origin_PlayerCharacter, and BPM_Skypark_PlayerSpawner has been renamed to BPM_Origin_PlayerSpawner, to fit our naming conventions, and more clearly establish them as our “defaults”. Redirectors should handle all BP use cases, but if there are any config references to the old files, they will need to be fixed up.

How to fix it?

Ctrl+F in the config files for _Skypark_ - if there are any hits for the old file names, they can be fixed up like so

Open image-20240423-164935.png

How to test it?

If you used the skypark character earlier, nothing should have changed.

Moved Remote Viewers action handling to blueprints

Affected Features: Remote Viewers

What’s broken and why?

The logic for handling Remote Viewer “Action” messages has moved from C++ to BP in order to give end users the ability to customise this logic - eg, adding project-specific ActionTypes. With this change, the base M2M_RemoteViewerControlComponent C++ class will no longer automatically handle emote messages and emotes will not trigger when a web viewer selects one from the web UI. This logic has instead been moved to a new BPMC_RemoteViewerVisualizerControlComponent blueprint component. Action messages are received by overriding the Perform Action event

How to fix it?

If your project is setup to use remote viewers and you already have a project-specific blueprint class that inherits from M2M_RemoteViewerControlComponent, you will need to reparent this class to the new BP base class BPMC_RemoteViewerVisualizerControlComponent in order for remote viewer-triggered emotes to function as expected.

How to test it?

Follow the steps below in the editor to trigger an action from an HTTP request and ensure that the action is received correctly in Blueprints.

The Unreal portion of the Remote Viewers system can be tested in-editor for quick iteration in a few ways:

1. Test spawning, user name display and avatars using the remoteviewers.simulate.start and remoteviewers.simulate.stop commands

   1. Configure the editor to connect the first PIE instance using M2_RemoteViewerConnection connection type
   2. Configure the remote viewer simulator settings as required. Tooltips for each setting explain their purpose
   3. Launch 2 or more PIE instances and run the remoteviewers.simulate.start {number to simulate} command in the remote viewer client instance. This will generally be the only PIE window where no players are visible as remote viewer clients do not receive updates for players

   4. Ensure that visualizers are spawned as expected using the other PIE instances

   5. Use the remoteviewers.simulator.stop command to stop sending updates. It will take some time for visualizers to despawn (controlled by Time Until RVDespawn property on the Remote Viewer Master actor that is being used by your project)

      

   6. 

2. Test spawning and actions using Postman or Curl:

a. Ensure that Use Development Messaging is enabled in editor preferences

b. Launch a PIE session with a remote viewer client, as described above

c. Send web requests to simulate those that would be sent from the web. There are two PubNub topics which control different aspects of the system

State update messages:

These messages are sent frequently by the web UI in order to signify the presence of a user and some base state. When the master actor stops receiving updates for a user within a configurable time window, they will be despawned. Different uuids can be used to simulate a number of different users and can be any unique string identifier

POST <https://ps.pndsn.com/publish/<pubnub-publish-key>/<pubnub-subscribe-key>/0/remoteviewer-state.lc-<channel-suffix>/0?uuid=<any-string-identifier>

Body:

{ "Name": "Mr R Viewer", "AvatarURL": "https://some.mml.avatar" (optional field) }

Action messages

Action messages are sent from the web UI to trigger arbitrary actions for a remote viewer. An example of these would be “emotes” which are implemented in base Origin code but can be overridden on a project specific basis.

POST <https://ps.pndsn.com/publish/<pubnub-publish-key>/<pubnub-subscribe-key>/0/remoteviewer-action.lc-<channel-suffix>/0?uuid=<any-integer-identifier>

Body:

{ "ActionType": "emote", "ActionId": "PDA_Emote_Wave" }

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

Gravity - in some situation when using the Gravity gadget - avatar animations will still show as floating on the floor

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

This includes testing in both low latency (5k ccu) and High Scale (15k ccu) modes.

v18 Low Latency Performance

v18 High Scale Performance

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Removed GetOrganizationCollectionService node

Affected Features: Collections API

What’s broken and why?

The GetOrganizationCollectionService blueprint node has been removed as the organization collection service is no longer used. It was only introduced in v16 and removed in v17.

How to fix it?

Just remove the nodes. None of the functions on the returned service will return any data. Use the User Collection Service to get data from public datasources, as they’ll show up in your user collection..

How to test it?

If it compiles it works.

Projects must add overrides for ProjectID, WorldID and LaunchContextID in Live Config

Affected Features: Live Config

What’s broken and why?

To prevent us leaking Origin internal project configuration to downstream projects, the defaults for ProjectID, WorldID and LaunchContextID in deployment.json have been removed.

How to fix it?

Add an overrides file for deployment.json and override these 3 values.

Overrides guide:

M2LiveConfig: How-Tos and FAQs | How can I override default live config values?

TL;DR:

• Add a {ProjectRoot}\Config\LiveConfig\Overrides\deployment.overrides.json

• Add this:

  • { "M2": { "Domains": { "ProjectId": "FILL_ME_IN", "WorldId": "FILL_ME_IN" } }, "Social": { "Chat": { "Editor": { "LaunchContextId": "FILL_ME_IN" } } } }

How to test it?

Make a build and ensure clients are connecting properly

Remove unnecessary UAT BuildGraph Zip task for compressing debug symbols

Affected Features: Editor build

What’s broken and why?

There is an unnecessary Zip task in the M2Development Editor BuildGraph which will compress debug symbols into an archive. This archive is not uploaded as a Buildkite artifact and can take a few minutes to complete.

How to fix it?

This is a “soft” breaking change; you can ignore this change if you prefer, but you will lose a few minutes for editor build times (e.g. in the juno-code-build Buildkite pipeline).

Copy the changes made in the breaking changelist (use the link in ‘CL’ field above) to the BuildGraph file at the following location:

Game/<game-project-name>/Build/Graph/BuildGraph.xml

Replace <game-project-name> with the name of your (full-engine) game project (e.g. “Juno” for Battenberg).

This file should be project-agnostic (there are no references specific to M2Unreal in the source file), so if you have not modified this file for your project, you can copy the file contents directly from //M2Unreal/main:

How to test it?

Run a build of the juno-code-build Buildkite build and expand the the Building editor log group.

At the bottom of this log group (under the Export Build header), if you see a log like:

Adding <number> files to C:\b\Game\artifacts\<game-project-name>-Editor-DebugFiles.zip...

Then your BuildGraph is still (unnecessarily) creating a zip file.

Replaced BP_MillicastCapture with BPM_MillicastCapture then reverted it later

What’s broken and why?

Millicast screens and some asset references related to BP_MillicastCapture blueprint.

How to fix it?

Get a CL equal or greater than 247865 from //M2Unreal/main/

How to test it?

Milicast screens work correctly and there are no broken references to BP_MillicastCapture singleton.

Removed TextChat.UseGlobalChat live config key in favour of TextChat.GlobalChatEnabled

Affected Features: Text Chat

What’s broken and why?

TextChat.UseGlobalChat has been removed as it was a duplicate key of TextChat.GlobalChatEnabled.

How to fix it?

If the removed key was explicitly referenced anywhere in your code then replace any use of TextChat.UseGlobalChat with TextChat.GlobalChatEnabled, otherwise no action required

How to test it?

Run your map and check Text Chat is working as expected

Removed unused Audio foley footstep assets

Affected Features: Audio

What’s broken and why?

Removed & Cleaned up unused footstep assets as they have been replaced/renamed to reduce bloat in the project for the following materials:

• Fabric

• Metal

• Stone

• Stone_Polished

• Water

• Water_Shallow

• Wood

• Wood_Plank

How to fix it?

Apply a valid Physics Material on Materials that have none attached.

How to test it?

Use the M2AudioTestGym or FeatureTestGym to verify footstep sounds & verify DT_M2_Audio_FootstepSounds has the correct Physics Materials listed.

Rename some inventory live config flags

Affected Features: Inventory, UI, LiveConfig

What’s broken and why?

The following live config flags have been renamed, so that all our inventory config is in under inventory (instead of having some in approachability, which is a somewhat obsolete name):

• Approachability.ShowItemManagement -> Inventory.ShowItemManagement

• Approachability.HideInventoryView -> Inventory.HideInventoryView

• Approachability.HidePlaceMode -> Inventory.HidePlaceMode

• Approachability.HideUnequipView -> Inventory.Quickbar.HideUnequipButton

• Approachability.HideQuickbarBackground -> Inventory.Quickbar.HideBackground

These have also been moved to the new live config version, so GitHub config overrides

How to test it?

Try toggling these flags - they should work.

Removing Area Interaction Mode

Date of change: 05/04/2024

CL: https://imp-p4-swarm.corp.i8e.io/reviews/247155

Affected Projects: All

Affected Features: Interaction

Point of contact: @Mike Pascoe

What’s broken and why?

Area Interaction mode is being removed, as it is not being used and adds unnecessary complexity to the Interaction system.

How to fix it?

It is not expected that any one is using this feature; if that is not the case please contact @Mike Pascoe , as demand will result in a feature request for a more robust version.

How to test it?

Open your level and confirm that interaction works as intended.

Update pre-exit hook script to be complaint with Mac Bash

Affected Projects: Full-engine projects with customer-specific/distinct/separate pipelines

Affected Features: Build

What’s broken and why?

The .buildkite/hooks/pre-exit script that is run by Linux and Mac Buildkite agents when a job finishes has been updated to avoid recent (version 5) Bash features so that Mac can run the script properly. As this file contains hard-coded Slack channel names, any project-specific changes to this file will be need to be made again.

How to fix it?

Take note of the Slack channels defined in the Bash associative array (starting from declare -A). Take the new version of the pre-exit file and replace the Slack channel names defined in the (new) case statement with those from the previous version.

Add further pipelines to the case patterns as appropriate.

For a quick guide on Bash case statements (with examples), read: https://linuxize.com/post/bash-case-statement/

How to test it?

Run builds of the pipelines you specify in the case statement patterns. If the Linux and Mac jobs log a message like:

Setting slack notify channel meta-data to: #your-channel-name-here

In their Running local pre-exit hook log group, then you have successfully updated the pre-exit script.

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

This includes testing in both low latency (5k ccu) and High Scale (15k ccu) modes.

v17 Low Latency Performance

v17 High Scale Performance

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Mac enabled by default

Affected Features: World Builder

What’s broken and why?

Mac is now enabled by default for all projects, and so requires adding MacClient as a platform for each project.

How to fix it?

Open the .uproject for your project and add “MacClient” as an entry under the TargetPlatforms list as shown:

How to test it?

Shelve your change, your preflight of m2-world-builder-project-ci should cook MacClient and complete successfully without error.

Remove support for Legacy Venues API for Players

Affected Features: Auth

What’s broken and why?

The Legacy Venue API is no longer supported as a connection service for the players. This was being used only if you pass a custom command line argument to your client -UseLegacyVenuesApi

How to fix it?

Make sure your client is not passing the argument -UseLegacyVenuesApi when connecting to a cloud deployment.

How to test it?

Player clients can successfully connect to cloud deployments.

Deprecated old chat system - Renamed to have _Mobile suffix & Renamed new ‘Unified’ text chat to use M2 naming conventions

Affected Features: Text Chat

What’s broken and why?

The old chat system is being deprecated in favour of the new text chat UI, previously called the ‘Unified Chat’. The old chat system will remain in the project for now to be used only for mobile platforms and as such have been renamed with _Mobile in its name as a suffix. This chat will eventually be removed once the new chat has a mobile friendly UI. With this change, the live config key UnifiedTextChat.Enabled has been removed in favour of TextChat.ForceMobileUI, which when set to true, will force the old chat UI to be used regardless of whether you’re running on Mobile or not.

How to fix it?

Check your project’s HUD is using the correct Text chat widgets. The new Text chat, desktop only is called WBP_M2_TextChat. The old text chat, required for mobile is now called WBP_TextChatWindow_Mobile

How to test it?

Run your map and check text chat is working as expected

Interaction Options refactor

Affected Features: Interactables (using New system)

What’s broken and why?

• Interaction options are no longer provided via the M2_InteractionOptions struct but instead entered directly on the M2_InteractableComponent's Defaults

• AddInteractionOption has been replaced with AddOption which no longer requires Constructing a new object

• Priority for interaction options is now ReadOnly; ordering can be done directly on the Options map

How to fix it?

Interaction options will need to be migrated to the Options map on the Interactable component. In this map you provide the ID for the option as the Key and the Prompt can be entered in the instantiated object value (see image). Existing M2_InteractionOptions structs will stay on BPs so you can copy over the values, but this struct itself is now deprecated.

If you use AddInteractionOption to dynamically create options, you will now have to use AddOption instead. This directly takes the Option ID and the Option Prompt, rather than needing a newly constructed InteractionOption object.

If you use Priority to sort your interaction options, you will now have to sort the Options map (accessible on the M2_InteractableComponent) manually.

How to test it?

Existing interactables should have the same options show up as before. They should appear in the same order as before. Dynamically created interaction options should show up when created

Deprecating World Builder Data asset in World Builder projects

Affected Features: Maps to upload, splash screen override image

What’s broken and why?

We have deprecated the use of the World Builder Data PDA that is currently required to be in all world builder projects. This asset is currently used to store information pertaining to maps that users want to upload (when going via the external cook and upload flow), and more importantly the override splash image that is shown when joining an experience. We've simplified this process by migrating the setting of these to Project Settings, meaning users no longer need to maintain this data asset in their projects/create one in their personal projects. This change will be part of the next Origin release (the one after this week's), so there's no action to be taken yet

How to fix it?

1. Go to Project Settings

2. Copy across the info from the PDA into the M2 World Builder Data section

3. It's recommended to also delete the world builder data asset as it won't be used at all for anything in projects now.

Note: not deleting the asset won't break anything, but the pda will not be used for anything in the project so it is safe to remove it once the relevant info is set in project settings).

How to test it?

When joining a deployment with an override image set, this should be shown on start-up over the launch context image

Deprecate Equip and Place mode specific InventoryHandler functions

Affected Features: Quickbar, Inventory

What’s broken and why?

The following functions on J_InventoryHandlerComponent have been deprecated:

• QuickbarUnequip - replace with M2_ItemQuickbarFunctionLibrary::Unequip

• EquipPreviouslySelectedItem- replace with M2_ItemQuickbarFunctionLibrary::EquipPreviouslySelectedItem

• QuickbarEquipSlot - replace with M2_ItemQuickbarFunctionLibrary::SetSelectedSlot

• PlaceModeDeselect - replace with M2_ItemQuickbarFunctionLibrary::ClearSelectedItem

• PlaceModeSelectSlot - replace with M2_ItemQuickbarFunctionLibrary::SetSelectedSlot

• ActivateQuickbar - replace with M2_ItemQuickbarWidget::ActivateQuickbar

• ToggleSlot - replace with M2_ItemQuickbarFunctionLibrary::ToggleSlot

The EJ_QuickbarType enum has also been deprecated. Please check for the quickbar type by checking its class instead.

This change allows us to generify all quickbar-related functionality, enabling full support for arbitrary quickbar types.

How to fix it?

Please replace blueprint nodes as described above for blueprints that have compilation warnings.

How to test it?

Check that your quickbar/gadgets work as expected, and all blueprints compile without warnings.

Removed RootComponent from AMorpheusActor

Affected Features: MorpheusActor

What’s broken and why?

RootComponent was removed from MorpheusActor, which now means MA-derived BP classes can now change the RootComponent (yay!). This is useful for things like replicating the movement of physics actors, since you can replace the RootComponent with a static mesh component. There's an engine patch to try and help mitigate the impact of this, but there will still be some issues described below.

This will have an impact onto all MorpheusActors that are placed in levels, and the defaults of some MAs too. You'll notice that MorpheusActors that are placed in levels in the details panel will still claim they have a "RootComponent" as their root rather than a default scene root node; recompile the blueprint and resaving the level for each of those actors will fix this.

You may also experience other bugs in levels, such as:

• The hierarchy of startup actors where they involve MAs could flatten.

• Certain properties of startup actors may reset to their defaults if they are a MA.

• Other miscellaneous editor/cook warnings and errors.

How to fix it?

To fix most of the warnings, just recompile the affected blueprints.

To fix the RootComponent appearing in the details panel of placed-in-world MAs, recompile the blueprint and resave the level.

To fix the other issues above, you'll need to manually fix the hierarchies and properties that have changed. Ping @Samuel Silvester for any questions!

Why was this change necessary? MorpheusActor in cpp constructed its own RootComponent, which prevents the RootComponent from being replaced or modified in child classes in BPs. This is a major regression from native Unreal workflows. We considered many solutions; from this change; introducing a new "MorpheusActorV2" and deprecating the old one; forking Origin and having all new projects use the fork; and so on. We concluded this breaking change was the best solution at this moment in time.

How to test it?

<Step by step guide for testing that the change has been integrated correctly>

Deprecated old Live Config blueprint nodes

Affected Features: Live Config

What’s broken and why?

The following nodes have been deprecated:

• GetLiveConfigString

• GetLiveConfigInt32

• GetLiveConfigFloat

• GetLiveConfigBool

• IsLiveConfigReady

These will be deprecated in Origin V16, and fully removed in Origin V17.

This is to push projects to use the GameData API, to allow for the rollout of the new LiveConfig system.

This will cause a deprecation warning to trigger during builds.

Usage of these nodes will fail builds.

How to fix it?

Please see the M2LiveConfig migration guide:

Migration Guide

But the TL;DR is: Use the GameData API instead

How to test it?

No testing required, if a build succeeds you are done

Removed the ability to change interaction strategy from an external source.

Affected Features: Interaction

What’s broken and why?

The member var StrategyForThisInteractable has been removed, which exposed input to the editor allowing selection an interaction strategy to be initialized during BeginPlay. We never use anything other than M2_DefaultInteractionStrategy for non-mml interactables and we have no current use case for the capability. As such we have stripped it back to remove unnecessary extra complexity, and the function to set the interaction strategy from an external source is no longer public.

How to fix it?

It’s highly unexpected that any one is using this as it is buried fairly deep in the interaction system. In the event that you were using an alternative interaction strategy please speak to @Mike Pascoe about the intended use case; if it is valid then returning SetInteractionStrategy to public access should be a simple change.

How to test it?

Attempt to interact with an M2 Interactable and confirm it behaves as expected.

Below is a list of all known issues with this release

Millicast screens may be presented in a poorly optimised fashion, with sharp jagged edges or issues with shading

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

Please note that the 'Bot Tested' target values have reduced from 18k to 5k due to now utilising Low Latency as Standard (see https://docs.msquared.io/tutorials-and-features/networking/high-scale-mode)

v16 Performance

Benchmark

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

📣 High Profile Breaking Change 📣

The below breaking changes have been introduced since the previous Origin Release:

RootComponent was removed from MorpheusActor, which now means MA-derived BP classes can now change the RootComponent. This is useful for things like replicating the movement of physics actors, since you can replace the RootComponent with a static mesh component. There's an engine patch to try and help mitigate the impact of this, but there will still be some issues described below. This will have an impact onto all MorpheusActors that are placed in levels, and the defaults of some MAs too. You'll notice that MorpheusActors that are placed in levels in the details panel will still claim they have a "RootComponent" as their root rather than a default scene root node; recompile the blueprint and resaving the level for each of those actors will fix this. You may also experience other bugs in levels, such as:

• The hierarchy of startup actors where they involve MAs could flatten.

• Certain properties of startup actors may reset to their defaults if they are a MA.

• Other miscellaneous editor/cook warnings and errors.

To fix most of the warnings, just recompile the affected blueprints. However, to fix the other issues above, you'll need to manually fix the hierarchies and properties that have changed.

Why was this change necessary? MorpheusActor in cpp constructed its own RootComponent, which prevents the RootComponent from being replaced or modified in child classes in BPs. This is a major regression from native Unreal workflows. We considered many solutions; from this change; introducing a new "MorpheusActorV2" and deprecating the old one; forking Origin and having all new projects use the fork; and so on. We concluded this breaking change was the best solution at this moment in time.

Removing RootComponent from AMorpheusActor

What’s broken and why?

RootComponent is removed from MorpheusActor. An engine change is in this CL to reparent existing MorpheusActor BP classes to use the default scene root, but this will cause issues with some preexisting levels and MorpheusActors, including:

• Some cook errors and warnings

• Actor hierarchy in levels with MorpheusActors being flattened

• Some (but rarely) properties in startup actors are reset to their defaults

• Some MA BP actors will produce warnings which need fixing

How to fix it?

In levels with startup MorpheusActors, if the details panel for the actor shows “RootComponent” as the default RootComponent, then open the Blueprint editor and recompile. The details panel should now display “Default Scene Node” as the RootComponent.

The issues listed above will need to be addressed on a case-by-case basis.

How to test it?

Run CI pipelines and test levels manually.

Interactable Seats Removed From Origin

Affected Features: Interaction

What’s broken and why?

M2M_Seat and the underlying C++ classes have been removed. The seats were causing more problems than they solved and it was decided that if a project requires seats, they should be responsible for their own implementation. Interaction as a feature at this time has not passed alpha, so having used this without getting support from the gameplay team will have been ill-advised.

How to fix it?

If assets have been built on top of M2M_Seat, they will need to be re-parented to something like the basic Actor and have the appropriate chair-related static mesh attached.

The action of sitting is not currently supported in Origin and the expectation is that projects needing this will either need to implement their own solution (see https://docs.msquared.io/tutorials-and-features/interaction) or request it as a feature from the gameplay team.

How to test it?

Open the editor with these changes and confirm project still compiles.

GetCustomSettingToggleWithCapabilityFallback has extra parameter

Affected Features: User settings

What’s broken and why?

The function GetCustomSettingToggleWithCapabilityFallback in J_GameUserSettings now takes an additional argument, a FGameplayTagContainer called SettingVisibleCapabilities. This is a list of capabilities that determine whether or not the setting is visible in the options menu and is required so we can make sure default values are used if the setting is hidden. It stops hidden settings from reading any locally stored user data that may have been written for the setting.

How to fix it?

If using this function and passing through the DefaultEnabledCapability argument to define a capability to set a toggle settings defaul value you should also now pass through a corresponding capability that determines whether or not this setting is visible in the options menu. Note if the setting is always visible an empty FGameplayTagContainer can be passed through. In blueprints this is the default so they’d just need to be recompiled.

How to test it?

Ensure that any toggle setting that has a default value based on a capability and visibility settings based on a set of capabilities uses the default value if it is hidden in the menu

Gameplay tags in World Builder require using Project Settings

Affected Projects: All

Affected Features: World Builder

What’s broken and why?

Gameplay tags in World Builder are buggy and not the easiest system to work with. We replace this old system with how native Unreal projects use gameplay tags, that is via the Project Settings.

How to fix it?

Navigate to https://docs.msquared.io/reference/development-workflows/adding-gameplay-tags

Find your gameplay tags you have added and move them from the plugin Tag.ini file into this new system.

How to test it?

Open the editor with these changes, gameplay tags should work as before. Run PIE and they should work there as well. Run your game in a deployment, and they should work as well.

Simplify deployment environments & change default to "Development"

Affected Features: CI, World Builder

What’s broken and why?

We are removing the "Native (Development,Production)" deployment environments as a means to simplify things.

Subsequently we are renaming the "Streaming (Development,Production)" environments to "Development" and "Production" respectively.

Finally we are changing the default deployment environment for the m2-world-builder-project-ci pipeline to "Development", as deployments and bots are generally cheaper to run in this environment.

How to fix it?

Projects that currently rely on running in "Production" by default will now need to select "Production" in the "launch main deployment" modal, and any scheduled / automated Buildkite pipelines will need to add the following environment variable:

OVERRIDE_DEPLOYMENT_ENVIRONMENT="production"

This is probably mostly relevant for Construct and Indus.

How to test it?

Run the m2-world-builder-project-ci pipeline, either manually or via a scheduled pipeline and check that the deployment ends up on either a jvp-dev-* cluster (for "Development") or jvp-prd-* cluster (for "Production").

Removing BP_ExplicitTargetingStrategy & renaming functions in BPC_Approachability_InteractableHandler

Affected Features: Interaction

Point of contact: @Mike Pascoe

What’s broken and why?

In BPC_Approachability_InteractableHandler - SetToDefaultTargetiingStrategy has been renamed SetToDefaultTargetingStrategy (removed second i in Targetiing). - CalculateInteractionPoint has been renamed FindInteractionPoint. BP_ExplicitTargetingStrategy has been removed. It was being used as part of a bad pattern to perform two tasks, triggering an interaction point calculation & storing a target from an external source, neither of which are the function of a targeting strategy.

How to fix it?

If calling SetToDefaultTargetiingStrategy, replace the call with the new function call. If calling CalculateInteractionPoint, where you were previously reading the calculated value, instead call FindInteractionPoint to synchronously obtain the values needed. If using BP_ExplicitTargetingStrategy: - If using it to calculate an interaction point to be read asynchronously, instead simply call FindInteractionPoint at the point where you are reading the value, this will calculate and return the interaction point. - If using as a target value store, please consider using a targeting strategy to acquire the target and M2_InteractableHnadlerComponent::PauseTargetingUpdates coupled with M2_InteractableHnadlerComponent::ResumeTargetingUpdates to retain a captured target. - If using for a different purpose, please contact @Mike Pascoe to discuss the use case and how to implement it using the idioms of the interaction system.

How to test it?

For function renames, check that your Blueprints compile and function correctly. For replicating functionality previously handled by BP_ExplicitTargetingStrategy, test by interacting with your object in the same way as you would before. Check that the interaction point is found correctly and that the intended target is interacted with (as opposed to a new target acquired during targeting updates).

Combined PDA_Skin_M2Content and PDA_Skin_Skypark into PDA_Skin_Origin

Affected Features: Skins

What’s broken and why?

To improve usability, we’ve removed the M2Content and Skypark skins and replaced them with a single “Origin” skin. If you were previously using the Skypark skin, there should be no visual changes, but if config (live config or project settings) still points to PDA_Skin_Skypark or PDA_Skin_M2Content, it will need to be updated to PDA_Skin_Origin

How to fix it?

Find all references to PDA_Skin_Skypark and PDA_Skin_M2Content in your project’s config and live config and remove them/replace them

If the skin looks visually different (i.e. you were using M2Content previously), and you aren’t happy with the Origin skin, please reach out.

How to test it?

PIE, the UI colours etc. should look correct.

Project default organisation and project IDs

Affected Features: Build

What’s broken and why?

The Buildkite build scripts will now be able to determine the organisation ID and project ID to use by parsing the Unreal Configuration (.ini) files. If the project has a .ini file which contains the following section and properties, their values will be recognised as the organisation ID and project ID:

[/Script/M2ServicesCore.M2_DomainSettings] OrganisationId=sample-org ProjectId=sample-proj

The .ini property will override the default build configuration value defined under .config/*.yaml.

If the project does not contain the above .ini section and property, then the build scripts will continue to use the default value defined in the YAML files. Meta-data and environment variables will take priority over the .ini file contents.

How to fix it?

If you have defined the OrganisationId and/or ProjectId properties in a [/Script/M2ServicesCore.M2_DomainSettings] section in an Unreal Configuration file, you should ensure that its value is what you want to use as the default (if not, update the project’s .ini property to match your desired default).

For most world-builder projects, you can find the property under the project's Config folder - you may have to open all the .ini files to find it.

If you wish, you can remove the m2_web_organization_id and m2_web_project_id build configuration fields from .config/*.yaml.

How to test it?

World-Builder projects

If you need to update the .ini file, create a changelist and run a build of the m2-world-builder-project-ci Buildkite pipeline and set the following fields:

• Branch should be your changelist number

• The environment variables should be:

  ORIGIN_BRANCH="<your-changelist-number-here>"

After you create the build, wait for the master director job to complete (you can cancel the build after that) and expand the Initial Build Configuration log group and look for a line starting with m2_web_organization_id and/or m2_web_project_id. If the line ends with the value you entered in the .ini file, then you have successfully updated your project configuration.

Full-engine projects

For M2Unreal streams, we define the relevant ini properties in the following file:

Game/M2Development/Config/DefaultM2_Services.ini

The properties defined in other .ini files (or may have stream-specific overrides).

If you wish to make changes to the .inifiles, create a changelist and run a build of the juno-ci-build Buildkite pipeline and set the Branch to the changelist number.

After you create the build, wait for the master director job to complete (you can cancel the build after that) and expand the Initial Build Configuration log group and look for a line starting with m2_web_organization_id and/or m2_web_project_id. If the line ends with the value you entered in the .ini file, then you have successfully updated your project configuration.

Modified the GadgetInHand offset

Affected Features: Gadget-in-hand (Inventory)

What’s broken and why?

The “gadget in hand” visuals added a hard-coded added 180 Pitch/Y rotation to the visuals details' RelativeTransform rotation. This has now been removed, so that the relative transform value in the BP_ItemVisualsDetails_MeshInHand matches the value if the mesh was added directly, or added to the crowd.

Also, the guidance regarding how to set up visuals details for the animated crowd has changed, since we have added a relative transform that can be set from the item PDA. Updated docs can be found at: https://docs.msquared.io/tutorials-and-features/the-inventory-system/how-to-make-devices/item-visuals#visuals-for-distant-clients-background-animated-crowd

How to fix it?

If you have any gadgets with visuals that look oddly rotated, try adding/subtracting 180 from your Y rotation.

How to test it?

Try equipping your gadgets-in-hand, see if they visually look OK.

Rejig the skins assets

Affected Features: Skins

What’s broken and why?

Hopefully nothing should be broken, but you may get some warnings along the lines of LogJunoUISkinPrimaryAsset: Warning: UJ_SkinPrimaryAsset::BuildFoundSettingsList: CustomSkinSetting of class J_EmoteSkinSettings will override an existing property on the asset (PDA_Skin_M2Content). Please move your custom setting changes over to the property, so that we get inheritance behaving nicely.

Basically, we have moved the core skins settings out of the SkinSettings list, into bespoke variables. If you have custom skin settings present, they will be kept and will trump the separate objects, but it is advised to fix them up so that we can get inheritance for each setting working nicely.

How to fix it?

If you made changes to an individual skin setting, you should be able to see an arrow by the property. Any properties that you have changed, you can copy across from the CustomSkinSettings array to the corresponding variable, or just copy and paste the entire object into the field. Then you can remove the setting from the custom skin settings list.

See https://docs.msquared.io/tutorials-and-features/ui/how-to-use-skins for the updated approach for using skins.

How to test it?

Your downstream skin should be used.

Moved Interaction Analytics off of M2_InteractableHandlerComponent

Affected Projects: All

Affected Features: Interaction

What’s broken and why?

• UM2_InteractableHandlerComponent::RecordInteractionAnalyticsEvent was removed

  • This caused usage of a bad pattern of adding Interactable Handlers to objects just to allow them to track analytics

• “Set New Interact Method” removed from Interaction Handler

  • It was used purely for tracking an analytic that was no longer desired

• Interaction Handler component removed from some assets

  • BPM_VideoScreen

  • BP_FocusCamTest

  • WBP_FocusCam_ExitButton

  • M2M_Seat

How to fix it?

• UM2_InteractableHandlerComponent::RecordInteractionAnalyticsEvent

  • Use UM2_InteractionFunctionLibrary::RecordInteractionAnalyticsEvent instead

• “Set New Interact Method”

  • Remove node

• “Missing” Interactable Handler

  • Remove any references to this component

  • NOTE: If you were using this, then you will have been using the interaction system incorrectly. Please contact someone on the Gameplay team for further support.

How to test it?

Check that all your blueprints compile and function as expected

Moved quickbar slot input handling out of J_InventoryHandlerComponent

Affected Features: Quickbar, Item Executors

What’s broken and why?

To support the modularization of quickbars and the recent “fractional quickbar views” work, all the input bindings are now handled by the quickbar widget.

• The following properties on J_InventoryHandlerComponent are no longer used and should be set in a M2_ItemQuickbarWidget instead (Origin sets these in WBP_GenericQuickbarWidget): InputMappingContext, UnequipAction , EquipSlotActions , PlaceModeDeselectAction , PlaceModeDeselectAction , PlaceModeSlotActions , EquipSlotPrioritizationName , UnequipSlotPriority , QuickbarUnequiprioritizationName , EquipSlotPriority

• The following functions on J_InventoryHandlerComponent are deprecated and should be called from a M2_ItemQuickbarWidget instead: GetUnequipAction , GetEquipSlotActions , GetPlaceModeDeselectAction , GetPlaceModeSlotActions , GetMappingContext , GetQuickbarInputsEnabled , SetQuickbarInputsEnabled

• QuickbarToggleSlot and PlaceModeToggleSlot on J_InventoryHandlerComponent are deprecated, please use M2_ItemQuickbarFunctionLibrary::ToggleSlot instead

• The BindQuickbarActions capability is no longer used

• The primary and secondary legacy input actions for J_ItemExecutors are no longer bound, please follow this guide on how to migrate Item Executors to EnhancedInput

How to fix it?

For the functions listed above, blueprint compilations will report warnings, and quickbar inputs may not work as expected. Please replace the nodes as described, the function names will be the same.

If custom inputs were used for the quickbar slots, please copy them from the InventoryHandlerComponent to a blueprint inheriting from WBP_GenericQuickbarWidget

How to test it?

Check that all your blueprints compile without warnings/errors, and that the quickbar and your item executors work as expected

Purchase executors now use enum rather than bool

Affected Features: Purchasables

What’s broken and why?

Purchasable executors now use an enum rather than bool making their implementation easier to follow.

How to fix it?

Simply update any custom executors to use the new new enum.

How to test it?

Ensure your purchase executors function the same as they did.

BP_InventorySkinSettings moved into BP_ItemManagementSkinSettings

Affected Features: Skins

What’s broken and why?

The BP_InventorySkinSettings asset was removed, and all of its settings were moved into BP_ItemManagementSkinSettings, to group them together under one skin setting.

If your downstream skin used the inventory skin settings, you may see errors along the lines of:

[2024.03.05-16.31.30:564][413]LogLinker: Warning: [AssetLog] D:\dev\...\Content\Core\UI\PDA_Skin_[X].uasset: Failed to load '/M2Core/JunoCoreUI/StandardButtons/BP_InventorySkinSettings': Can't find file.

How to fix it?

Go to your Skin PDA, and remove any empty entries in your SkinSettings list, and resave.

If you made any changes to the BP_InventorySkinSettings, unfortunately you will need to reapply them

How to test it?

Check your inventory widgets look how you’d expect

Move Quickbar related methods out of the component, into an interface

Affected Features: Inventory/Quickbar/Gadgets

What’s broken and why?

To support upcoming work where we can e.g. subdivide our equipment into multiple “quickbar tabs”, the quickbar related logic has been moved out of the quickbar component into the IM2_ItemQuickbarInterface and IM2_EquipmentQuickbarInterface interfaces. The helper functions have been moved into the M2_ItemQuickbarFunctionLibrary. This means old uses of the quickbar methods unfortunately broke.

How to fix it?

If you try to play/cook, it should raise the files that got broken by the change.

For uses of the quickbar component methods:

• Any uses of the old methods will give compile errors like this - it attempts to retarget to the function library, but puts the input to the function library's hidden "target" field.

  

• If you move the target to the quickbar view field, then refresh the node, it fixes things

  

In places where you try to get the quickbar component from the UI, you’ll need to instead get the interface (and maybe cast to an object, depending on your use case)

How to test it?

Once there are no compile errors, you should be good to go! Worth running a PIE, and checking that you can equip and use your gadgets as expected

This is a full list of everything that has been added or changed to this release

Below is a list of all known issues with this release

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

v15 Performance

Benchmark

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Updating default role logic on the RolesComponent

Affected Features: Roles

What’s broken and why?

Nothing is broken, this change should fix issues with default roles. Just want to add this here to prompt projects to check their roles and flag against this change if there are issues.

How to fix it?

NA

How to test it?

Ensure your current default roles are loaded correctly. (You should see no behavioural difference.

Moving Moderation Config Values

Affected Features: Moderation

What’s broken and why?

Classes have moved location meaning their config values may be affected. These values are: J_ModerationSubsystem.UseDefaultSubsystem J_CommunitySiftDeveloperSettings.bEnableOverride J_CommunitySiftDeveloperSettings.BaseUrl J_CommunitySiftDeveloperSettings.Password

How to fix it?

You may have to update your .ini files to reflect the new

How to test it?

Ensure the feature works as intended

Renamed and Reoganized Physics Material assets

Affected Features: Audio

What’s broken and why?

Renaming Physics Materials, removed unused Physics Materials & added new ones:

• Metal > Metal_Solid

• Sand > Sand_Dry

• Water > Water Sloshing

• Water_Shallow > Water_Puddle

• Wood > Wood_Board

• WoodPlank > Wood_Floor

• Fabric - REMOVED

• Flesh - REMOVED

• NoBounce - REMOVED

• Paper - REMOVED

• Plaster - REMOVED

How to fix it?

Apply a valid Physics Material

How to test it?

Use the M2AudioTestGym to verify footstep sounds

Wallet Component Refactor

Affected Features: Wallet Component

What’s broken and why?

OnWalletCompartmentsUpdated now uses FCurrencyValue struct.

How to fix it?

Blueprint logic should be simple enough to move over. FCurrencyValue is essentially is a replacement for FWalletCompartment and has all the same data.

How to test it?

Test your currency flows work as intended.

Helm chart compatibility

Affected Features: CI, GSS

What’s broken and why?

The Helm charts and which versions to use have been moved to .buildkite/config/charts.yaml which will be used as the source of truth going forward when registering build packages in the Web Platform and creating Worlds/deployments/bots/etc via the various deployment pipelines that exist.

As part of this the following environment variables have been changed:

+----------------------------------+------------------------------+ | old | new | +----------------------------------+------------------------------+ | GSS_TEMPLATE_NAME | SERVER_CHART_NAME | | GSS_TEMPLATE_VERSION | SERVER_CHART_VERSION | | OVERRIDE_CHART_VERSION | SERVER_CHART_VERSION | | SIMPLAYERS_TEMPLATE_NAME | SIMPLAYERS_CHART_NAME | | SIMPLAYERS_TEMPLATE_VERSION | SIMPLAYERS_CHART_VERSION | | REMOTEVIEWERS_TEMPLATE_NAME | REMOTEVIEWERS_CHART_NAME | | REMOTEVIEWERS_TEMPLATE_VERSION | REMOTEVIEWERS_CHART_VERSION | | MARKRECORDER_TEMPLATE_NAME | MARKRECORDER_CHART_NAME | | MARKRECORDER_TEMPLATE_VERSION | MARKRECORDER_CHART_VERSION | | M2_CONNECT_E2E_TEMPLATE_NAME | M2_CONNECT_E2E_CHART_NAME | | M2_CONNECT_E2E_TEMPLATE_VERSION | M2_CONNECT_E2E_CHART_VERSION | +----------------------------------+------------------------------+

How to fix it?

If you have specified any of the environment variables in the "old" column above in for example Buildkite schedules or documentation for how to create builds then you need to replace their usage with the replacement in the "new" column.

How to test it?

Run either of these Buildkite pipelines:

• juno-build + unblock the "Deploy to GSS" step

• juno-scale-test + unblock the "Configure" step

• m2-world-builder-project-ci + unblock the "Launch main deployment" step

Deployments, bots, remote viewers and such should work exactly like before.

Renamed Footstep Audio assets

Affected Features: Audio

What’s broken and why?

Changed folder and file names for the following Foley Footstep assets:

• Metal > Metal_Solid

• Sand > Sand_Dry

• Stone > Stone_Rough

• Stone_Polished > Stone_Smooth

• Water > Water_Sloshing

• Water_Shallow > Water_Puddle

• Wood > Wood_Board

• WoodPlank > Wood_Floor

How to fix it?

Check materials and meshes for missing Physics Materials & check the FootstepSounds Datatable

How to test it?

Go to the M2AudioTestGym and the Footstep Implementation Sublevel to verify that footstep material sounds can be heard for all surface types

Removed obsolete audio Blueprints from the Skypark plugin

Affected Features: Audio

What’s broken and why?

Removed the following Blueprints from the Skypark plugin: BP_Audio_ForestAmbient BP_Audio_MeadowAmbient BP_Audio_Fireworks

How to fix it?

Any usage of these blueprints should now be swapped to the new Ambience System.

How to test it?

Replace blueprints with the new Ambience system, and verify that the sounds can be heard.

Added WorldId scope to M2ServicesCore auth

Affected Features: World Travel

What’s broken and why?

We are now introducing WorldId as the preferred way for players to determine what deployments to connect to. This includes adding a new WorldId property to the BlueprintType FJ_WorldTravelWorld and the Blueprint callable UJ_WorldTravelService::WorldBuilderWorldTravel function. Now, any copying/assignment of these types in blueprint should also pass the WorldId property, as to prevent issues with world travel.

NOTE: This would only affect your project if you are running custom WorldTravel logic or implementation. If you are using world travel gates, portals, or command line as they are defined in M2Core, this will not affect your project.

How to fix it?

Search through all project blueprints for references for World Travel, or the types/functions specified above, and make sure that WorldId is passed alongside other settings such as project or launch context IDs. Here is an example from /M2Unreal/M2Core/Content/JunoWorldTravel/Blueprints/BPM_WorldTravel_Gate_Base.uasset:

Open WT_before.pngBefore fixOpen WT_after.pngAfter fix

How to test it?

Run two or more deployments in your project and test if world travel via portal, command line, or others works as expected.

Small API Changes to wallet component and user collection

Affected Features: Wallets and user collection

What’s broken and why?

Renaming functions/delegates for better readability.

How to fix it?

Any events bound to UserCollectionsUpdatedDelegate on the user collection now need to bind to UserCollectionsUpdatedDynamicDelegate. Any function calls to GetCurrencyOfType on the wallet component now need to call GetCurrencyValue.

How to test it?

Test each blueprint logic path you modified works as intended.

“Low latency mode” is now the default; old default has been renamed to an opt-in “high scale mode”

Affected Features: Networking, scale

What’s broken and why?

Default max CCU of all projects with this change goes from ~18k to around ~5k, with increased fidelity and decreased latency. Intended to improve the fidelity by default of M2UP projects, since most projects run with below 5k CCU. Blueprints referencing low latency settings (unlikely that there are any) will break.

How to fix it?

If your project needs to support a higher scale than ~5k CCU, you need to set a LiveConfig value to enable high scale mode. This is in morpheus.json: ConnectionParams.UseHighScaleModeOverride

How to test it?

Run a bot scale test with the maximum CCU you want your project to support and see if everything works. If you’re unsure, link your deployment metrics in #mvg-scale-testing for advice.

This is a full list of everything that has been added or changed to this release

Below is a list of all known issues with this release

Below is the performance data captured from our release testing - this should be used to guide on the performance your project should expect.

v14 Performance

Benchmark

Below are breaking changes which may need to be considered if you are ingesting this release into your project.

Vending Machine and Purchases Update

Affected Features: Vending Machine/Purchasables

What’s broken and why?

Class rename: UM2_PricedPurcheasable → UM2_BasePricedPurchasable Asset moves: JunoSkypark/Inventory/VendingMachine → JunoSkypark/Props/VendingMachine API Changes: FName IM2_Purchaseable::GetPurchaseableName() → FText IM2_Purchaseable::GetPurchaseableName()

How to fix it?

Should be able to move over to use the new assets fairly easily.

Avatar Attachment API Changes

Affected Projects: Any that has started using character attachments

Affected Features: Character Attachments (UM2M_CharacterAssetComponent)

What’s broken and why?

The API has changed to pass around a new FM2_StaticMeshAttachmentHandle instead of the attachment structure directly, due to the original structure becoming more complex.

How to fix it?

If you use UM2M_CharacterAssetComponent::RemoveAttachment you must now pass in the handle returned by AddAttachment. GetAttachments now returns a map of handles->attachments, instead of an array of just the attachments, so you'll need to use the map values instead.

How to test it?

Make sure it compiles, and attachments can be added and removed as before.

World-Builder project default Ubitus game label

Affected Projects: World-builder projects that use Ubitus

Affected Features: Ubitus (Game Streaming)

What’s broken and why?

The Buildkite build scripts will now be able to determine which Ubitus game label to use by parsing the Unreal Configuration (.ini) files. If the project has a .ini file which contains the following section and property, its value will be recognised as the Ubitus game label:

[/Script/JunoLiveContentEditor.M2_ExperienceSettings] UbitusGameLabel=???

The .ini property will override the default build configuration value defined under .config/*.yaml.

If the project does not contain the above .ini section and property, then the build scripts will continue to use the default value. Meta-data and environment variables will take priority over the .ini file contents.

How to fix it?

If you have defined the UbitusGameLabel property in a [/Script/JunoLiveContentEditor.M2_ExperienceSettings] section in an Unreal Configuration file, you should ensure that its value is what you want to use as the default (if not, update the project’s .ini property to match your desired default).

For most world-builder projects, you can find the property under the project's Config folder - you may have to open all the .ini files to find it.

How to test it?

If you need to update the .ini file, create a changelist and run a build of the m2-world-builder-project-ci Buildkite pipeline and set the following fields:

• Branch should be your changelist number

• The environment variables should be:

  ORIGIN_BRANCH="<your-changelist-number-here>" WORLD_BUILDER_BUILD="true"

After you create the build, wait for the master director job to complete (you can cancel the build after that) and expand the Initial Build Configuration log group and look for a line starting with ubitus_game_label. If the line ends with the value you entered in the .ini file, then you have successfully

Must explicitly unload MML/profile avatars if you want to show a Modular character

Affected Projects: All

Affected Features: Avatars

What’s broken and why?

We’re moving towards every avatar being defined in MML, and phasing out the slot-based modular characters. This change tidies up the API towards this goal, but changes how some of the existing JM_ModularCharacter functions work. Previously any function that modifies the state of the modular character configuration would also load that config onto the player’s avatar, even if they were using an MML character. Now the changes will only be applied if the player is not using an MML avatar. You must now explicitly unload an MML avatar to go back to showing the modular character with UnloadCharacterFromUrl.

Affected functions are in JM_ModularCharacterComponent: ApplyPrimaryAsset ApplyPrimaryAssetByName RandomizeCharacter RandomizeSlot ClearSlot ClearCharacter SetCustomValueForSlot SetCustomColorForSlot ClearCustomDataForSlot.

How to fix it?

If you call any of the functions above and expect them to switch you back from an MML character to a modular character, you should now call UnloadCharacterFromUrl at the same time. RandomizeCharacter is the most likely use-case - this will no longer do anything visible if you’re using an MML character, until you unload it.

New features added to the MSP_M2_RandomPlayer

Affected Projects: All

Affected Features: Audio

What’s broken and why?

The MetaSound Patch has been updated to add a new volume and pitch randomisation feature, and removing the pitch shift feature.

How to fix it?

This is the old version of the patch, the pitch shift variable has now been removed. If you need to pitch-shift the sound, you can modify the pitch variable on the MetaSoundSource.

This is the new version, containing the new pitch and volume randomisation features.

How to test it?

Set the pitch and volume randomisation variables, and click play - your sounds should be modulated with random pitch and volume adjustments.

Project settings replace plugin settings in World Builder

Affected Projects: All

Affected Features: World Builder plugin configs

What’s broken and why?

Plugin configs have changed to project configs so the project settings UI inside the editor can now be used again instead of manually modifying ini files.

How to fix it?

1. Delete DefaultEngine.ini , DefaultGame.ini , DefaultInput.ini files inside of <Project>/Config/ , as well as any other sections you do not wish to be applied to your project from other config files. These specific files are important as you want to keep your meaningful settings like DefaultM2_Services and DefaultEditorPerProjectUserSettings, but old/unused settings should be deleted.

2. If you have any configs located in <Project>/Plugins/<Plugin>/Config/<Type>.ini, copy the sections into the <Project>/Config/Default<Type>.ini equivalent file. This is to make sure your existing settings carry over correctly. The <Type> can be anything e.g. Game, Engine, Input, etc.

How to test it?

Run a test of your game to ensure the settings that used to be applied are still applied.

Enabled “New Interaction System” by default in M2UP Live Config

Affected Projects: All

Affected Features: Object Interaction

What’s broken and why?

"Old" interactions based on using JM_InteractableComponent will no longer work when the live config value game Interaction.UseNewInteractionSystem is set to true - which is now the default value in the m2unreal Live Config. We are moving support to focus on the new interaction system that implements M2_InteractableComponent

NOTE - If you don't use the old interactions, this shouldn't impact your project

How to fix it?

There are two options here:

1. Set Interaction.UseNewInteractionSystem false for your project/map in Live Config

   1. Make sure to restart your client

2. Convert old interactables to use the new system (Guide here)

How to test it?

Implement one of the two approaches above, ensure that interaction works as it did before this setting was changed.

Rename user collection polling live config values

Affected Projects: All

Affected Features: User Collection Polling

What’s broken and why?

We renamed the live config values to better differentiate between server and client values

How to fix it? UserCollection.Polling.Enabled -> UserCollection.Polling.ClientEnabled UserCollection.Polling.Frequency -> UserCollection.Polling.ClientFrequency

Removed Emote-o-Meter Feature

Affected Projects: All

Affected Features: Emote-o-meter

What’s broken and why?

We have removed the Emote o meter feature to reduce the maintenance overhead on an unused feature

How to fix it?

If you’re project still requires this feature, make a copy of the blueprints into your local project before updating your editor to take this change

How to test it?

If you’re not using this feature, then no action is required. If you are using this feature then do the above and check it still works as expected

Removed *_template_version options from gss_config.yaml

Affected Projects: All

Affected Features: CI, GSS

What’s broken and why?

The server_template_version and simplayers_template_version configuration options (version constraints really) have been removed from .buildkite/scripts/gss_config.yaml and will no longer be used in the deploy_to_gss.py script.

These have to my knowledge never been used by any project, and have only caused pain when copying between different depots and streams.

Instead we are working on a different approach for this that should be (more) sane and cause less pain, and in the meantime these version constraints are maintained/enforced in the deploy_to_gss.py script itself.

How to fix it?

Remove the server_template_version and simplayers_template_version options from .buildkite/scripts/gss_config.yaml.

How to test it?

Create any deployment using either the juno-build or juno-scale-test Buildkite pipelines. Everything should continue to work as previously.

Removed Icon variable from UM2_StandardButtonBaseData

Affected Projects: All

Affected Features: Any Blueprint that use ConstructObjectFromClass with ButtonData as template

What’s broken and why?

With the inclusion of new Icons to the button layout, the Icon variable deprecated and used the “Redirector” functionality from unreal to substitute it with IconLeft1. It worked on the majority of the cases, but some of the systems used the ConstructObjectFromClass call to create ButtonData and the Redirector didn't affect those calls. At the end it was decided to remove the Icon variable completely and fix those calls by hand. How to fix it?

For any system that uses the ConstructObjectFromClass call, if anything is assigned to the old Icon node, set the value to the new exposed parameter IconLeft1. New functions have been added to modify the new Icons (UpdateDetailsMultipleIcons & UpdateIcons)

How to test it?

All the blueprints that use the ConstructObjectFromClass call with the UM2_StandardButtonBaseData as the template should not have any warnings about the Input Pin “Icon” no longer existing. Also, any new Call to ConstructObjectFromClass should have the IconLeft1 input pin available where the previous value can be set.

This is a full list of everything that has been added or changed to this release

Below is a list of all known issues with this release

Refactored functionalities of M2Services into new M2ServicesCore plugin

What’s broken and why?

Certain functionalities of M2Services has been split into a new plugin, M2ServicesCore. This may cause a breaking change if your project has references to certain blueprints or project settings that were affected by this refactor.

How to fix it?

Search through all project setting .ini files for any references to the following settings: - [/Script/M2Services.M2_DomainSettings] - [/Script/M2Services.M2_ServicesEnvironmentSettings]

And replace M2Services with M2ServicesCore. An example is the DefaultM2_Services.ini file, which contains

[/Script/M2Services.M2_DomainSettings] OrganisationId={your-project-id} ...

This setting name should be replaced to reference M2ServicesCore :

[/Script/M2ServicesCore.M2_DomainSettings] OrganisationId={your-project-id} ...

How to test it?

Deploy a server from your stream via the world builder project CI pipeline. If the deployment is successful, connect to it and ensure that it’s operating as expected. Make sure web functionalities, such as authentication and user profiles works correctly

Emote Live config key changes

What’s broken and why?

The Emote live config keys were inconsistent in their naming convention so this change has just brought them all into one place. The keys that have changed are:

These keys have all been added the the m2unreal live config branch with these default values. How to fix it?

Update any existing values in your live config branch to the new keys if you have them different to the default values. Update any blueprint references to these keys to use the new keys

How to test it?

If you haven’t deliberately changed these values then just run your map and emote to check it all works as expected.

If you are explicitly overriding these keys then run any features using it to check it still behaves as expected.

New GSS instances in Web Platform

What’s broken and why?

gss_config.yaml has been updated to point to the domains for the new GSS instances. The old GSS instances will be deprecated soon (following brown-outs), and deployment attempts via the old GSS domains will fail.

How to fix it?

Changes to .buildkite/scripts/gss_config.yaml to update the domains were included in the last origin release (v10.0.0, 15/01/2024). The gss_config.yaml file is isolated due to stream-specific live config URLs. If you haven’t already, merge this file into your stream and update any live config URLs to match your stream.

How to test it?

Check that your .buildkite/scripts/gss_config.yaml file only contains GSS URLs of the form <env>.gss.m2hosting.io.

During a brown-out, deploy a server from your stream via the world builder project CI pipeline. If the deployment is successful, connect to it and ensure that it's operating as expected. Make sure to check that the live config is correct.

Refactored the quickbar widgets

What’s broken and why?

The quickbar widgets have been refactored to share methods with a single base class: M2_ItemQuickbarWidget. Some methods and properties have been renamed, which may mean that if you have made custom quickbar widgets, they will have some errors.

• NotifyEquipmentUpdated has been renamed to NotifyQuickbarSlotsUpdated. This will be applied automatically, but EquipmentItemDetails has been renamed to ItemDetails, which will result in a compile error.
• EquipmentSlotsBorder and EquipmentSlotsContainer have been renamed to Quickbar[X] respectively. This means that the “bind widgets” won’t be found until they are renamed.

How to fix it?

• For NotifyQuickbarSlotsUpdated, simply drag the `ItemDetails` variable in wherever the old EquipmentItemDetails was.

• For the EquipmentSlotsBorder/Container widgets, rename them to QuickbarSlotsBorder/Container

• In the widget’s class defaults, make sure the QuickbarComponentClass and QuickbarSlotClass are provided.

How to test it?

Test in-game - if your quickbar looks correct, then all good! There should be no noticeable changes.

This is a full list of everything that has been added or changed to this release

Below is a list of all known issues with this release

Update ChartVersion to latest available (v7.15.1) for World Builder projects

Date of change: 18/01/2024

What’s broken and why?

We (Web Platform) are working towards migrating all clusters towards a new cluster topology, and will (eventually) need all projects to update to at least v7.14.1 of the colosseum Helm chart, but it is recommended to update to v7.15.1.

How to fix it?

Update the ChartVersion value in your project's DefaultEditorPerProjectUserSetting.ini configuration file to be 7.15.1.

How to test it?

Testing is most easily done by launching deployment(s) via the m2-world-builder-project-ci Buildkite pipeline, and then checking either in the (Web Platform) Admin UI or the GSS that the correct version was used for the deployment.

WBP_Approachability_EquipmentQuickbar has been removed

What’s broken and why?

The old (unused) WBP_Approachability_EquipmentQuickbar has now been removed. All projects should switch to using WBP_ItemManagement. If you use the old widget, it’ll instead now look like this:

NOTE: We modified our WBP_TH_HUD to no longer have this widget. If your project used an old copy of that HUD, you may see this text blink on during startup. If so, you can copy the steps done in WBP_TH_HUD to fix it:

• In the HUD widget, delete WBP_Approachability_EquipmentQuickbar, and do “Replace with child” on ItemWidgetSwitcher so that WBP_ItemManagement is all that's left.

  

• This will cause a compile error in HandleLiveConfigUpdated. Fix it up by removing the switcher logic, and replacing the widget whose visibility is being toggled with WBP_ItemManagement

  

Flip the “quickbar inputs” capability so we default to not using it

What’s broken and why?

Previously we had the default behaviour when there were no capabilities present to be that the InventoryHandlerComponent bound LMB and RMB when you have an item selected. The problem with this is that we have lots of other systems that want these too. Instead, we now make the individual items control their inputs with ItemExecutor::ListenToInputs. This way, we can support more types of inputs more flexibly.

If your project relied on “old style inventory input binding”, i.e. using the EventPrimaryInput or EventSecondaryInput events automatically, these will now be broken.

See docs page here for further details: https://docs.msquared.io/tutorials-and-features/the-inventory-system/how-to-use-devices#howtousedevices-note-deviceinputs

How to fix it?

Follow the steps in the doc: https://docs.msquared.io/tutorials-and-features/the-inventory-system/how-to-use-devices#howtousedevices-note-deviceinputs

You want to use ListenToInputs to listen to the inputs your item cares about, instead of using the default Primary and Secondary

NOTE: If you absolutely need to get this old behaviour back, you can go to your roles table and add the Capabilities.Inventory.BindQuickbarActionsInHandler capability to your required role(s)

How to test it?

Check the gadgets used by your project. If they all work, all good!

Replace BPC_M2_ApproachabilityCameraControl::UpdateClickToTurnOverride with Add/RemoveClickToTurnOverrideStack

What’s broken and why?

Instead of the old UpdateClickToTurnOverride method which sets the “click to turn override” to either true or false, we now use a “stack” approach. That way, if multiple places force you into “click to turn” mode, you only revert to the default once all have removed their overrides.

Any uses of the old method will be invalidated

How to fix it?

use the new methods, and pass the caller in

How to test it?

If things compile, and your input stack changes work, all’s good!

Currency and Purchase systems updates

What’s broken and why?

The J_CurrencySubsystem has been updated to a world subsystem. M2_Purchaser has some additional abstract functions. Vending machines have been updated and could potentially break derived assets.

How to fix it?

Fixing up an referance to J_CurrencySubsystem should be simple. You might have to recreate some nodes is all. If you have issues with vending machines, reach out directly to the point of contact.

How to test it?

Give any purchase flows a test and see if they are still functional.

World Builder deployment scripts now use Worlds

What’s broken and why?

We are moving away from using Deployments and Launch Contexts directly, and will instead use a new (central) “Worlds” concept.

The various Python scripts used in the m2-world-builder-project-ci and m2-world-builder-playtest pipelines have been replaced with new scripts that will use Worlds, and World IDs, rather than Launch Contexts and Launch Context IDs.

This means that any “persistent” Launch Context that has previously been used with these pipelines will have to be replaced with (persistent) Worlds instead.

How to fix it?

Persistent Worlds can be created through the Web Platform Admin UI by navigating to the “Worlds” page using the sidebar, and then clicking the “+ New” button in the top-right corner.

This will bring up a modal for you to fill in with appropriate values, which will be dependent on the (customer/internal) project that the World is to be created for.

This page makes an attempt to cover how to create a World based on information in a persistent Launch Context

This page contains additional information about notable changes to the Buildkite pipelines

The following environment variables have also been updated. Please update any usage of them.

OVERRIDE_LAUNCH_CONTEXT_ID >> OVERRIDE_WORLD_ID (needs to be an actual World ID and not the Launch Context ID, see the link above how to create a World based on an existing Launch Context).

OVERRIDE_LAUNCH_CONTEXT_NAME >> OVERRIDE_WORLD_NAME

EXTRA_MAPS_LIST >> if used on the <map-name>+<existing-resource-id> format it now expects a World ID instead of a Launch Context ID for the <existing-resource-id> part.

How to test it?

Testing is most easily done by running either of the m2-world-builder-project-ci or m2-world-builder-playtest Buildkite pipelines using World IDs when prompted (or configured via environment variables).

World Builder dependency cooking is now enabled by default

What’s broken and why?

Dependency cook is a preferable way of cooking content as it can significantly reduce download file sizes. Instead of cooking everything, you provide a set of maps to cook - similar to how the -map argument works in native Unreal Engine.

How to fix it?

If you do not have an M2_WorldBuilderData data asset, create one:

Set the Maps to contain whichever maps you would like cooked in your content, alongside a name for that map which is required for cooking.

If you do not want to use dependency cooking at all, you can disable it via the World Builder Settings under Dependency Cook or set DEPENDENCY_COOK=false as a CI environment variable.

How to test it?

Cook your project with no extra environment variables in CI. The Buildkite annotations should include the maps you asked, as well as any sublevels as required. Load into your game and it should function exactly as before, but should be a smaller file size.

This is a full list of everything that has been added or changed to this release