🖥️Version History

Cancelled value added to EM2_HttpResponseStatus

Affected Features: Http

What’s broken and why?

We have added a new “Cancelled” status to the EM2_HttpResponseStatus enum. Whilst this in itself is not breaking, users me be using the “Switch” block in blueprint to handle the http results.

If this is the case, the addition of the new Cancelled status will result in an unmapped pin, which may cause your blueprint to not handle the case of cancelled requests. This would only happen if you explicitly cancel a request.

How to fix it?

You have two options:

1. If you are using the enum and mapping all but the “OK” pin to a failure state, you should swap to using an Equals “OK” and branch node.

1. If you still wish to use the switch, you must map this to your cancellation handler (or failure case)

How to test it?

Check your http requests are handling the responses you expect.

World Builder settings migration

Affected Features: World Builder

What’s broken and why?

We’ve migrated some settings from DefaultEditorPerProjectUserSettings.ini to DefaultGame.ini. Nothing will break, but some steps are provided to avoid this causing issues with version control.

How to fix it?

We migrate the settings automatically.

If you’re using a version control system, you’ll need to submit the modified Config/DefaultGame.ini as part of the upgrade.

How to test it?

Navigate to Project Settings -> M2 World Builder and ensure your old settings e.g. Mod Id and Maps are still present:

Crowd Animation blend support

Affected Features: CrowdAnimBlueprint, SkeletalCrowd

What’s broken and why?

Nothing should be broken. In order to support blend nodes within crowd ABP, this change contains some very fundamental modifications to how crowd animations are running, and as such projects should double check crowd animations are working as expected.

How to test it?

Crowd members should be animating as they used to before the change, precisely what this means will depend on the project.

Pubnub-based Chat simplification

Affected Features: Social (Chat)

What’s broken and why?

As part of the Pubnub-based text chat simplification process, we have ported the chat from C++ to Blueprint to allow customers to take control of the implementation. As a result of this, there is one change that must be addressed when taking this version of MSquared.

In order to continue using the current version of text chat you must add the ps.pndsn.com domain to your Developer Dashboard url allow list settings for the Client. See the next section for details.

Secondly, we have removed the “announcements” support. This feature was not used by any projects as so there should be no project impact.

Additionally, the “Fetch Channel History” function on the UM2_TextChatComponent has changed signature from having a delegate passed in, to using a broadcast delegate for all history messages. This is due to the function implementation being moved from C++ to Blueprint. This should only be impactful if you have implemented a custom chat UI.

How to fix it?

To add the ps.pndsn.comas an allowed domain, you must:

1. Navigate to your developer dashboard

2. Select the Admin tab

3. Select External Urls

4. Expand the Client section

5. Set "External Url Access" section to "Allow content to access only URLs with specified domains"

6. Click “+ Add Domain”

7. Add "ps.pndsn.com" to the new entry

8. Click Update to save the setting

If your chat UI is using the announcement messages feature of the M2_TextChatComponent; then it is recommended you begin removing the use of it, as in the future the functions will be removed.

When binding Fetch Channel History, you should now bind to the broadcast delegate “On Chat History Message Received” delegate to continue receiving the historical responses.

How to test it?

General chat should function as normal; minus the ability to receive announcement messages.

• Check your history messages still appear

• Check you can still send and receive normal chat messages

Cleaned up/consolidated excess DT Roles tables

Affected Features: Roles

What’s broken and why?

The following data tables have been removed:

• DT_ApproachabilityGym_Roles

• DT_FeatureTestGym_Roles

• DT_NexusRoles

• DT_QARoles

• DT_RolesExampleMap

• DT_RolesScaleTestMap

Any uses of them internally have been replaced with our default DT_RolesExample.

The example roles table has also had some changes to it:

• The “starting inventory assets” have been removed, since this is a feature that is being deprecated.

• The Director role has been granted 4 “sizes” that it can switch between using + and -.

How to fix it?

If you want the default roles setup, please use DT_RolesExample. If you want custom roles behavior, it is best to use your own roles table. (See https://docs.msquared.io/creation/unreal-development/features-and-tutorials/game-roles#example-setup )

How to test it?

In your level(s), go to the world settings, and filter by “role” - if the default role or data tables arrays have missing values, it may be that you were using one of the removed data tables. This will need to be replaced.

Similarly, if you try to change roles, and see that the roles are missing, or that your startup character isn’t as expected, that could be a sign that the role data table needs updating.

You will also see warnings along these lines:

LogLinker: Warning: [AssetLog] [X]: Failed to load '[Y]': Can't find file.
LogLinker: Warning: [AssetLog] [X]: VerifyImport: Failed to load package for import object '[Y]'

If so, that will highlight the removed data tables that are being referenced.

Party Functionality Permanently Disabled

Affected Features: Parties

What’s broken and why?

As part of the M2 Platform simplication process, we have permanently disabled parties and related functionality. As such, it is no longer possible to:

• Enable party support

• Create a party

• Join a party

• Leave a party

• Send a party message

• Receive party messages

• Use party voice chat

The Party Component is still present but is no longer functional. It will be removed in a future version of the M2 Platform.

How to fix it?

If parties are required in your project, you will need to create or integrate a third party solution. Contact your support representative if you require assistance.

Removed UM2_WebPlatformRealtimeNFTWebsocket

Affected Features: Collections

What’s broken and why?

As part of M2 platform simplification, the UM2_WebPlatformRealtimeNFTWebsocket class has been removed.

How to fix it?

If you require this funtionality, you can implement it in your own project by using the Web Socket Connection and M2 Web Platform API documentation

Interface Change: UM2_WebServicesRoleDataProvider / UM2_WebServicesProfileDataProvider

Affected Features: Web Platform Integration

What’s broken and why?

The interfaces to UM2_WebServicesRoleDataProvider / UM2_WebServicesProfileDataProvider have changed. Instead of taking FM2_AuthUserContext as a parameter, they now take int LocalUserIndex. This is to simplify / remove assumptions about users for custom web platform integrations.

This change should not impact anyone yet unless they have implemented their own data providers.

How to fix it?

Instead passing FM2_AuthUserContext to any of the functions (which was hard to determine in Blueprint), you can pass LocalUserIndex. In 99% of cases, this will be 0, except for bots, which would be the index of the current bot.

How to test it?

Profile and role fetching should function as normal.

Deleted UserRolesSubsystem / UserRolesService

Affected Features: Services

What’s broken and why?

As part of MSquared platform simplification; the C++ querying of user roles has been removed to allow users to perform their own queries to either the web platform, or a service of their own choosing.

As a result of this, existing C++ Web Platform roles integration code has been removed.

This change should not impact users as it extremely unlikely that you’ll be manually querying role data.

How to fix it?

If previously you queried roles via either the UserRolesSubsystem or the UserRolesService (Web Platform), then you need to replace those calls with a Get World Service query, passing M2 Web Platform Roles Data Provider or an explicit derivative.

How to test it?

Role querying should work as normal.

CorrelationId added to Response of SendHttpRequest

Affected Features: Http

What’s broken and why?

CorrelationId has been added to the Response event used by SendHttpRequest. This is to allow users to correlate a response event with the request that initiates it; which is useful for storing state between the sending and response handling.

However, if you are using a bound function to handle the responses, you will experience a blueprint compile error due to the signature of the event changing.

How to fix it?

For every function you have bound to the completion delegate of SendHttpRequest, you must add an extra parameter to the Signature:

Name: CorrelationId, Type: Guid

Once you have done this, try compling the blueprint again and saving it.

How to test it?

If the blueprint compiles correctly, then no further action is required (once you’ve saved it).

Skin PDAs need a resave

What’s broken and why?

The underlying skins logic has been moved, but PDAs don’t handle redirectors nicely. As a result, without a resave of the active skin, PIE will be blocked in the “waiting for HUD” step.

How to fix it?

If you have a custom skin for your project, find it, and resave it. Easiest way to check what skin is being used is by going to the project settings → M2 UI Skins, and checking the Default Skin

How to test it?

If you can PIE and successfully enter the world, it has been fixed!

Disabled Remote Viewers Web Platform Connectivity

Affected Features: Remote Viewers

What’s broken and why?

The Remote Viewers feature is being removed as part of platform simplification. This step disables the connectivity of the Remote Viewers system to the M2 Web Platform services, effectively disabling the feature.

Removed JLR_Plugin_NoFPDependencies

Affected Features: Linting

What’s broken and why?

The firepit linting rule does not do anything, so has now been removed. That means the classes JunoLintRule_Plugin_NoFPDependencies and JLR_Plugin_NoFPDependencies are no longer present. If you have any custom lint rules, the file will be missing.

How to fix it?

There will be a “none” in place of the removed linting rule in any of your custom rule set assets. Remove these. (Or a resave would also be sufficient to stop things complaining)

How to test it?

If your preflights run fine, all is well!

Health in HealthComponent no longer replicated in background

Affected Features: Health Component

What’s broken and why?

The Health variable as part of the HealthComponent is no longer replicated in the background. This is because it was very expensive and could limit the scale of deployments.

How to fix it?

If your project is relying on background health, or the health increased / damage taken callbacks in the background, the game design will need to be adjusted to avoid this.

How to test it?

Check that any health based functionality in your project still works.

Improved Raycastable Crowd Prioritization

Affected Features: Shooting

What’s broken and why?

Raycastable Crowd prioritization is now more configurable from Blueprints.

How to fix it?

Open the RaycastableCrowd asset used by your project’s Animated crowd. This will most likely be in the DA_Pawns asset linked in your Roles Data table.

In the RaycastableCrowd asset, there is a new PriorityCalculation property that exposes multiple prioritization strategies and their configurations.

The default strategies that were in-use before this change were the View Frustum and the Area Of Influence so you will need to enable and configure (based on your project needs) both of these strategies like the following:

Refer to Enabling Raytracing for Crowd Members for more guidance.

How to test it?

1. Start a PIE session with bots/other players.

2. Force everyone into LOD1 so they will be using RaycastableCrowd

3. Shoot at other players and verify they are still receiving damage/interacting.

Removed JM_ModularCharacterComponent and AddedCrowdStaticMeshesOverride

Affected Features: Avatars

What’s broken and why?

In v29 the JM_ModularCharacterComponent was deprecated with the removal of modular characters, and its functions merged into M2M_CharacterAssetComponent. In v30 JM_ModularCharacterComponent has been removed entirely.

JM_CharacterBase::AddedCrowdStaticMeshesOverride and JM_CharacterBase::UpdateDefaultCrowdMemberInitializer have also been removed in favour of the equivalent functions on M2M_CharacterAssetComponent as they’ve been deprecated for several version.

How to fix it?

Anywhere you call a function on JM_ModularCharacterComponent, you should instead call the equivalent function on M2M_CharacterAssetComponent instead. The JM_CharacterBase class has both of these components, so you can get the M2M_CharacterAssetComponent directly from the same actor. v29 had deprecation messages on each function to tell you the equivalent - they are nearly all named exactly the same, except for functions with Interop in the name where this word has been removed.

If you’ve set an asset in JM_ModularCharacterComponent::PostProcessAnimBlueprint you should instead set it in M2M_CharacterAssetComponent::PostProcessAnimBlueprint as this can’t be automatically migrated.

Anywhere you set JM_CharacterBase::AddedCrowdStaticMeshesOverride you should instead set M2M_CharacterAssetComponent::AddedCrowdStaticMeshesOverride. Any call to JM_CharacterBase::UpdateDefaultCrowdMemberInitializer should be replaced by M2M_CharacterAssetComponent::ReloadCharacter.

How to test it?

Blueprints will compile and avatars will behave the same as before.

Removed BP_NPCCrowdActor

Affected Features: NPC Crowd Actor blueprint

Does this breaking change need publishing for external users? Yes

What’s broken and why?

BP_NPCCrowdActor was an experimental blueprint that spawned a random crowd of non-interactive fake modular characters, for making a map look more populated. With the removal of the modular character system this is no longer functional and has been removed.

How to fix it?

Projects should use their own system of adding fake crowds to a map, for instance using instanced meshes.

How to test it?

The map should run without errors.

Removed high-scale mode

Affected Features: Live config, networking

What’s broken and why?

Six live config fields have been deleted from the morpheus schema: five containing the substring HighScale plus Movement.UseHighResolutionMovementQuantization.

We no longer support high-scale mode (the alternative to low-latency mode); the deleted fields are the ones that activated it and controlled its behaviour. We’ve dropped the feature because low-latency mode is fine for the maximum scale requirements of all existing projects.

Any projects relying on high-scale mode (we don’t believe there are any) may encounter performance problems.

How to fix it?

Remove overrides for those live config fields from the project live config file.

How to test it?

Game should run without live config errors.

Removed the BT_BotAvatarClothes bot behavior

Affected Features: bots

What’s broken and why?

The following bot related assets have been removed

• BT_BotAvatarClothes

• BTT_RandomizeOutfit

This is because the underlying logic has been removed and so the behaviors are now non-functional

If you had reference to these assets, you may see errors.

e.g. if you had a reference to the “clothes” bot behavior in your bot behavior store, it’ll have been removed, and give a warning. It is fine to just resave, or you could remove the map entry for cleanliness

How to test it?

Everything should compile and run as expected.

Forced-foreground characters now default to using Carnival

Affected Features: Avatars

What’s broken and why?

By default, roles that are forced into the foreground don’t render with Carnival and instead use the standard GLTF renderer. This is typically used on large 'presenter' characters. The is a live config to control this Carnival.DontUseCarnivalForForcedForeground which used to default to true but has been changed to false.

This change was made because the GLTF renderer isn’t as performant, and to simplify the rendering by pushing all characters through the same renderer. Currently large presenters may not look detailed enough when using Carnival, so until that is fixed you can use this live config to revert to the old behaviour.

How to fix it?

Set Carnival.DontUseCarnivalForForcedForeground to true if your project uses scaled-up forced-foreground characters, and they have lost detail since taking the update.

How to test it?

Forced-foreground characters will look the same as previously.

Removing modular character support

Affected Features: Avatars

What’s broken and why?

Modular Characters have been deprecated for a long time, in favour of MML avatars. Modular Character support is now being removed.

This first part is removing the ability to set Avatar Scheme Sets in the Roles tables.

• Previously players could have one of three types of avatars - their default MML avatar from the profile, a modular character defined in a scheme set, and finally the default mesh asset on the pawn.

• Modular Characters were defined in a data asset deriving from J_AvatarSchemeSet and these could be set per role, and were used if the player didn’t have an MML avatar set on their profile. These have now been removed, so players without an MML avatar will now use the pawn’s default mesh.

• The default pawn mesh has also been updated to SK_Andor_01 instead of the black silhouette mesh. As there are no longer and scheme sets, offline players and bots would look broken with the silhouette avatar so a generic default mesh has been set.

The second part is the removal of all Modular Character functions from JM_ModularCharacterComponent. These allowed you to manually specify a scheme set for a player, modify individual components, and randomize the avatar from the scheme set. These are no longer supported with the removal of modular characters.

Finally the M2M_CharacterAssetComponent::OnCharacterLoaded delegate now has a parameter which is the URL of the avatar that was successfully loaded. You may need to add this parameter to your bound functions.

How to fix it?

Projects should transition to using MML avatars: Avatars | Public Docs

For users without an MML avatar, projects should set an appropriate fallback mesh as the default mesh on their pawn blueprint class (replacing the new default SK_Andor_01). This will be your blueprint that derives from BP_M2_PlayerCharacterBase. Find the Mesh component and set the SkeletalMeshAsset to the default character mesh you wish to use:

How to test it?

Players will load if with either their MML avatar or the default pawn mesh.

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

Simplified Access to “Get Server World Time Seconds” on M2M Morpheus Game State

Affected Projects: All

Affected Features: Morpheus Game State Singleton

What’s broken and why?

Previously you were required to check if the Morpheus Game State was available before you could get Server World Time, but now we have a static function that works much like the above workaround.

We will return the time from our singleton, but if it isn’t ready yet you will be returned the time from the underlying native GameState.

How to fix it?

Replace any broken references with the new static version of the function

How to test it?

Verify the behaviour remains the same as before.

AutoOpen now defaults to “on” for Control Panels

Affected Projects: All

Affected Features: Control Panels

What’s broken and why?

Control panels inheriting from BPM_ControlPanelBase will now auto-open by default. This may mean that if you had control panels you wanted to not auto-open, that directors will have them open even if not intended.

How to fix it?

For any control panels that you don’t want to auto-open, go to their BPM, go to the ControlRegister component, and uncheck the Auto Open flag.

How to test it?

If you PIE, and switch to a role that can view control panels (e.g. director), there should only be the control panels auto-opening that you want to be shown.

Cleanup of crowd audio settings

Affected Features: Audio

What’s broken and why?

• The CrowdAudio|Source and CrowdAudio|Input settings that were previously in CrowdAudioOberverSettings have now been split into a new CrowdAudioSpeechSourceSettings. This helps clarify the distinction between the two types of settings: Speech Source Settings are related to your voice, and how it is sent to other people. Observer Settings are related to how you hear other voices, and what muffling etc. you apply to them.

• Some unused settings have been removed, e.g. DensitySettings, AmbientVolumeSettings and StableLoudnessSettings. If you were using them (outside of those in Observer/SpeechSource settings), feel free to unplug them - they weren’t doing anything anyway.

How to fix it?

If you used any of the settings that got moved, it will give compile errors. Please move them across to the appropriate ones in CrowdAudioSpeechSourceSettings.

Similarly, if you had overrides to these in a morpheus.override.json file, LiveConfig will fail to generate. To fix this, you will need to move the settings to the right place.

How to test it?

Everything should compile. If so, you’re good to go!

“Splash screens” have been removed

Affected Features: Splash Screen

What’s broken and why?

The “Splash Screen” logic (the SplashScreenDisplayData in the world settings) has been removed. This is because it has been unsupported for some time, and was introducing a large number of bugs. Since it is an unused feature, and wouldn’t be too hard to implement downstream, there’s no need for us to maintain it.

How to fix it?

If you were using it, let us know, and we can advise on how to achieve the same thing downstream.

The basic idea here though, if you do need to do this yourself:

• The splash screen worked by adding a step to the bootflow (after your player had spawned, and its profile has been set up, but before the player was given control) where it added a widget, and blocked the bootflow until the splash screens/videos had finished.

• You can achieve a similar effect by adding a bootflow listener to e.g. HandlePlayerProfileCompleted, and adding a widget on top, disabling player movement if needed.

• Or alternatively, you could extend the player profile setup step, which already opens a widget before giving the player control, and add your splash screens there.

How to test it?

If you were expecting some splash screens that are no longer there, please reach out!

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

Removed unused CustomSettingDefaultValues live config fields

Affected Features: Config

What’s broken and why?

A few previously unused live config flags have been removed from the CustomSettingDefaultValues section. The only two that are still in use are over_the_shoulder_cam and hold_to_sprint. This change will typically have no effect, but if you previously attempted to override them, live config will fail to generate.

How to fix it?

Go to your any game.override.json in your project. If they have overrides to the CustomSettingDefaultValues section that aren’t the mentioned ones, remove them. The section should look something like this (or have less than this if you don’t need the overrides:

"CustomSettingDefaultValues": { "over_the_shoulder_cam": "on", "hold_to_sprint": "off" }

How to test it?

If you PIE, the live config error should not show up.

Using profile MML avatars by default

Affected Features: Avatars

What’s broken and why?

The Character.UseCharacterFromProfile live config now defaults to true. This means that by default, users will load their default MML avatar stored on their profile when entering an experience. This is usually what you want anyway, so you no longer need to explicitly enable this live config.

How to fix it?

To maintain the old behaviour, set Character.UseCharacterFromProfile back to false in your project’s live config overrides.

How to test it?

Load into your experience while logged in with a default MML avatar set on your profile, and check if it loads or not.

“Paint the park” removed

Date of change: 09/09/2024

Affected Features: Paint the park

What’s broken and why?

The “Paint the park” feature, and all its related code & assets have been removed. This feature was not documented, and has been untouched for years.

How to fix it?

If you were using the feature, please get in touch! The expectation here is that nobody was using this.

How to test it?

PIE - there should be no differences to your experience.

Remove AnimVars:Forward and AnimVars:Right

Affected Features: Animation

What’s broken and why?

The Forward and Right anim vars have been removed. This is because they were slightly broken, and somewhat obsolete anyway due to UnrotatedSpeed2D doing a similar thing.

How to fix it?

Hopefully no changes needed - if you weren’t using the anim vars, nothing will break. If you were, please get in touch! Hopefully your use case can be instead handled by the AnimVars:UnrotatedSpeed2D var instead.

For cleanliness, if you made your own ABP as a duplicate of the M2 one, you can delete the AnimVars:Forward and AnimVars:Right macros, but them being present won’t break anything, unless they were used.

How to test it?

Play in editor/Cook. If there are no compile errors related to missing variables, you’re good!

“Player Spawner Singleton” removed from list - morpheus actor now controlled via the game mode

Affected Features: Core

What’s broken and why?

To simplify the user experience of developing on MSquared, we’ve made things more in line with native Unreal’s style. One of these changes was to add support for defining the player morpheus actor class on the game mode, so you don’t need to make a child of the player spawner singleton, update it in your world settings, and set the player morpheus actor class there. The old flow of requiring a player spawner singleton was deprecated, and is now being removed.

There should have been warnings in v25, about this flow being removed in an upcoming release. This is that release.

If you have old player spawners (inheriting from e.g. BPM_Origin_PlayerSpawner) these will now not work and will need to be deleted.

How to fix it?

• Go to your game mode (also found in the world settings), and set the PlayerMorpheusActorClass to the actor class that was in your player spawner singleton

• Delete the old player spawner singleton, now that it is not used.

• (It may complain about deleting the player spawner singletons, if they were previously used in maps. If so, resaving the maps will fix those up. Or equally, force deletes should be safe here, since the spawner isn’t actually being used following these changes)

How to test it?

Play in editor. When the game is running, search for BPM - if the BPM player character is the correct one, you’re all good!

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

Moving Live config and UI scaling from Origin Player character to base

Affected Features: Character Camera

Does this breaking change need publishing for external users? Yes

What’s broken and why?

As part of our clean up into a single player character class the origin live config settings have been moved into base. By default BP_M2_PlayerCharacterBase will now apply camera boom offset values from live config.

How to fix it?

If you wish to stop the live config camera boom offset values from being applied, turn off the live config value: Approachability.UseCameraBoomOverrides .

How to test it?

Test your experience and note the camera will be in the same position it was before this change.

Moving sprint and walk functionality from origin player character to base

Affected Features: Walking & Sprinting

What’s broken and why?

We are migrating our Origin player character functionality down into base as part of a clean up to offer a single extendable class to downstream projects. As part of that BP_M2_PlayerCharacterBase sprint/walk functionality is now gated behind capabilities, and a hold_to_sprint setting which controls whether the feature will revert to normal movement after the button is released or not.

If you are extending from the BP_Origin_PlayerCharacter this will not be broken for you, only if you were already extending from BP_M2_PlayerCharacterBase.

How to fix it?

If you want to mimic previous behaviour from PlayerCharacterBase the user will need the Capabilities.Movement.CanSprint / CanWalk capabilites. Then make sure the hold_to_sprint custom user setting is on (it is on by default at time of writing).

Please note that holding to both sprint and walk (vs pressing the button to toggle) are currently coupled; it is not possible at this time to have one require holding while the other be a toggle.

How to test it?

Load up a level & attempt to sprint / walk. The respective buttons should either be disabled, require holding, or act as a toggle based on settings.

Moving BP_Skypark_PlayerCharacter_FacialMocap & dependencies to M2Development

Affected Features: Facial Mocap

What’s broken and why?

BP_Skypark_PlayerCharacter_FacialMocap will no longer be available in the packaged editor. We are simplifying our Character classes to present a single clear class to extend. This class was used as a tech Demo and does not contain supported functionality, and as such is being removed from the editor.

How to fix it?

There is no fix for this, as we are removing an unsupported class. If you were using this class please reach out to your support engineer

No 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.

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

Added Scope to RequestDelegatedAuthToken (UM2_WebPlatformDelegatedTokenService)

Affected Features: UE integration with the Web Platform

What’s broken and why?

The web platform scope was previously hardcoded to World, which caused issues in PIE. Instead, have allowed this to be configured.

How to fix it?

Add a scope to the call in Blueprint. If in doubt, use Project (although World is preferred).

How to test it?

Should see a delegated token be issued.

Removing Get/SetBackgroundRotation from CombatComponent

Affected Features: Action Gameplay

What’s broken and why?

Get/SetBackgroundRotation in M2M_CombatComponent has been removed because it was too expensive for the Mark decoder.

How to fix it?

Remove any instances of SetBackgroundRotation and replace instances of GetBackgroundRotation with the MorpheusActor’s rotation (via MorpheusActor->MorpheusActorMovementComponent->GetCurrentMovement().Rotation).

How to test it?

Test that instances in your game code that relied on background rotation are working correctly.

Replacing Unreal’s game state with a morpheus game state

Affected Features: Engine

What’s broken and why?

Projects now need to point to a morpheus game state in their game mode. They can use the default M2M_MorpheusGameState.

Also, all calls to GetGameState are now deprecated and they should instead call GetMorpheusGameState to access the same functions

How to test it?

Test that your project compiles without warnings and that Play-in-Editor does not crash

Removed some respawning callbacks

Affected Features: Respawning

What’s broken and why?

The HandleRespawnStarted and HandleRespawnEnded callbacks have been removed, and respawning is now driven via Blueprints.

The bRespawning and RespawnTime variables have been moved to the BPM_M2_PlayerCharacter BP.

The respawn timer is in the BPM_M2_PlayerCharacter blueprint under Respawning. To override the default respawn-on-death behaviour, override the Start Player Respawning event.

How to test it?

Test that your respawning is still working correctly.

Removed unused settings tables (and WBP_Login)

Affected Features: Settings

What’s broken and why?

The old unused settings tables have been removed, since the only asset still in use is DT_Origin_SettingList

The assets that have been removed:

• DT_SettingList

• DT_Showcase_SettingList_Press

• DT_Showcase_SettingList

• WBP_Login

How to fix it?

If you refer to one of the old settings, it may get lost. in that case, please update your references to DT_Origin_SettingList

(If you refer to the WBP_Login widget, you will need to use a different widget. If this is in the case, and it’s not an easy fix, please get in touch!)

How to test it?

If you open your esc menu, you should still have the same settings you are expecting.

Addition of J_SettingAsset Param to the J_SettingExecutor::Execute event

Affected Features: Settings UI

What’s broken and why?

Possible need to fix up (re-save / re-compile) any UI Settings Executor’s that override / provide a custom Execute Event

How to fix it?

Should just need to refresh / replace the Event: Execute node in the executor graph. Existing M2 executors required no change.

How to test it?

UI Settings widgets should work as expected.

No 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.

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

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

Remove the function ToggleUIMode from BP_PlayerController

Affected Features: Toggling UI Mode

What’s broken and why?

Deprecating the function ToggleUIMode and replace it with more explicit calls to enter or exit UI mode

How to fix it?

Replace usages of ToggleUIMode with TrySetUIMode

How to test it?

Make sure UI mode enters and exits as expected

Updating BP_M2_PlayerCharacterBase to add an array of context mappings instead of a single variable

Affected Features: Character movement input mapping context

What’s broken and why?

BP_M2_PlayerCharacterBase was adding a variable mapping context, CharacterMovementMappingContext. It became clear that a downstream user may want to add multiple contexts at this point, or none. So it has been updated to an array to allow any number of contexts to be added at the point of character possession.

How to fix it?

If you were previously changing the value of CharacterMovementMappingContext, you will instead want to add your mapping context to the new array OnPossessInputMappingContexts (& remove the default context if not intending to use it).

How to test it?

Compile and run your game, check that your input still functions as expected.

No Known Issues

New performance metrics will be available from v25 onwards

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.

Meadow map assets removed

Affected Features: Base Project Meadow Template

What’s broken and why?

The Meadow map consisted of assets which were unable to be distributed at scale.

These assets were removed so any references to those assets are also removed.

How to fix it?

Resave or delete the Meadow map to remove any of the warnings or errors you see.

How to test it?

Cook and upload; the upload should succeed as normal.

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,