Non-ASCII characters are not displayed properly with TextMeshProUGUI and SoftMask.

[wiseyestudio00]

To Reproduce
Steps to reproduce the behavior:

1. Create a TextMeshPro FontAsset with English font, and attach non-English font to its fallback list (I am using Noto Serif)
2. Create a Canvas with RenderMode set to Camera, and attach a Camera to it.
3. Create TextMeshProUGUI component under a SoftMask parent.
4. Non-English texts are not displayed correctly (see screenshots below).

Expected behavior
The texts should be displayed properly.

Screenshots

^ English (Displaying properly)

^ Traditional Chinese (Error)

^ Japanese (Error)

^ If I remove the SoftMask in Viewport, the error goes away.

^ Setting Masking Mode to Normal works correctly, as well as Anti-Aliasing.

^ How the font is set up. The font itself is a static font with ASCII characters, with 3 fallback Japanese font (first 2 static, the last is dynamic fallback).

^ Overlay causes error too; If I set the RenderCamera to overlay, the problematic texts disappear.

Environment (please complete the following information):

• Version 3.0.1
• Platform: Windows Editor
• Unity version: 6000.0.29f1
• Build options: [e.g. IL2CPP, .Net 4.x, LWRP]
• Unity 6 Text Mesh Pro Support is imported.

Additional context
I upgraded from 1.0.2, where the same error also existed.

UPDATE:
If I manually toggle on and off the "Ignore Children" option in Soft Maskable on the TextMeshProUGUI component, the texts starts rendering properly.

^ Before toggle On

^ Toggle On

^ Toggle Off (texts start displaying properly.)

[mob-sakai]

Thank you for your reporting!
Could you please attach a minimal project (included Assets, Packages and ProjectSettings directories) that reproduces the issue?
Of course, you don't need to include any secret assets from your project. Feel free to use free assets instead.

[mob-sakai]

As an alternative: Consider using RectMask2D or Anti-Aliasing mask mode.

https://github.com/mob-sakai/SoftMaskForUGUI?tab=readme-ov-file#rectmask2d-vs-softmask

https://github.com/mob-sakai/SoftMaskForUGUI?tab=readme-ov-file#comparison-of-masking-mode

[wiseyestudio00]

Thank you for your reporting! Could you please attach a minimal project (included Assets, Packages and ProjectSettings directories) that reproduces the issue? Of course, you don't need to include any secret assets from your project. Feel free to use free assets instead.

I am sorry, but this project has grown really large and it will be pretty complex & will take a long while to create a minimal project. Is it possible that I just privately share a fork of the project with you instead?

[wiseyestudio00]

As an alternative: Consider using RectMask2D or Anti-Aliasing mask mode.

https://github.com/mob-sakai/SoftMaskForUGUI?tab=readme-ov-file#rectmask2d-vs-softmask

https://github.com/mob-sakai/SoftMaskForUGUI?tab=readme-ov-file#comparison-of-masking-mode

I would love to, but I also want to use the SoftMask effect, especially in other parts of the project......I am not too tight on the time constraint, so I can resolve this issue with you + I think this will really benefit SoftMask's usability with other languages! It's so close to being the perfect solution for Soft-Masking in Unity!

[mob-sakai]

Is it possible that I just privately share a fork of the project with you instead?

Yes, that's no problem.

[wiseyestudio00]

Hi! Sorry it took a while. I just share the fork with you. To start, please start from with CompleteRestartScene, which should lead you automatically to TitleScreen, where you can access PlayerSetting Menu. Scroll to the bottom to change language to see the error!

• Sorry I may have to go to sleep now. I will reply if there is any progress tomorrow! Thank you so much!

[mob-sakai]

Okay, I cloned that repository. 👍

[mob-sakai]

Playing a CompleteRestartScene scene causes an error.

NullReferenceException: Object reference not set to an instance of an object
WiseyeStudio.Lily.Preload.PreloadMenuManager.StartAsync (System.Threading.CancellationToken cancellationToken) (at Assets/Scripts/WiseyeStudio/Lily/Preload/PreloadMenuManager.cs:57)
Cysharp.Threading.Tasks.UniTask+ExceptionResultSource.GetResult (System.Int16 token) (at ./Library/PackageCache/com.cysharp.unitask/Runtime/UniTask.Factory.cs:326)
Cysharp.Threading.Tasks.UniTask+Awaiter.GetResult () (at ./Library/PackageCache/com.cysharp.unitask/Runtime/UniTask.cs:316)
Cysharp.Threading.Tasks.UniTask+WhenAllPromise.TryInvokeContinuation (Cysharp.Threading.Tasks.UniTask+WhenAllPromise self, Cysharp.Threading.Tasks.UniTask+Awaiter& awaiter) (at ./Library/PackageCache/com.cysharp.unitask/Runtime/UniTask.WhenAll.cs:200)
--- End of stack trace from previous location where exception was thrown ---
Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1[TResult].GetResult (System.Int16 token) (at ./Library/PackageCache/com.cysharp.unitask/Runtime/UniTaskCompletionSource.cs:244)
Cysharp.Threading.Tasks.UniTask+WhenAllPromise.GetResult (System.Int16 token) (at ./Library/PackageCache/com.cysharp.unitask/Runtime/UniTask.WhenAll.cs:218)
Cysharp.Threading.Tasks.UniTask+Awaiter.GetResult () (at ./Library/PackageCache/com.cysharp.unitask/Runtime/UniTask.cs:316)
WiseyeStudio.Lily.Preload.PreloadSceneManager.Start () (at Assets/Scripts/WiseyeStudio/Lily/Preload/PreloadSceneManager.cs:63)
System.Runtime.CompilerServices.AsyncMethodBuilderCore+<>c.<ThrowAsync>b__7_0 (System.Object state) (at <a6d715f5ce8c4754a140b50ff638878a>:0)
UnityEngine.UnitySynchronizationContext+WorkRequest.Invoke () (at /Users/bokken/build/output/unity/unity/Runtime/Export/Scripting/UnitySynchronizationContext.cs:155)
UnityEngine.UnitySynchronizationContext.Exec () (at /Users/bokken/build/output/unity/unity/Runtime/Export/Scripting/UnitySynchronizationContext.cs:83)
UnityEngine.UnitySynchronizationContext.ExecuteTasks () (at /Users/bokken/build/output/unity/unity/Runtime/Export/Scripting/UnitySynchronizationContext.cs:109)

Edit: PreloadMenuManager scene > PreloadMenuManager.TutorialStoryBlock is null.

Edit: Skipped tutorial to show screen.

-           if (playerData.HasStatus(LilyFantasiaPlayerStatusKey.Completed_Tutorial_Song))
            {
                await LoadingScreenSpawner.LoadNextSceneAsync(
                    new LoadingScreenArgument(
                        SceneNames.TitleScreenScene,
                        durationInSecond: 1f,
                        animationMode: LoadingScreenAnimationMode.WhiteFade)
                    );
            }
-           else
-           {
-               var blockData = TutorialStoryBlock.CreateData();
-               await new StoryBookEnterNextSceneUtility().PlayFullStoryWithSongAsync(
-                   SceneNames.PreloadScene,
-                   SceneNames.TitleScreenScene,
-                   blockData,
-                   0,
-                   cancellationToken
-               );
-           }

[mob-sakai]

The issue is reproduced on my environment.

[wiseyestudio00]

I am sorry for the error! I was trying to create a fork in a hurry, so the mistake must have slipped through. Glad to see the error being reproducible though!

[mob-sakai]

As a workaround: by deactivating the relevant objects, they were displayed correctly.

Or, apply this patch: UtilityHubMenuManager.patch.zip

[mob-sakai]

By adding a delay before hiding the submenu, it was displayed correctly.

await UniTask.Delay(500, cancellationToken: CancellationToken.None);
await HideAllSubMenuAsync(0f, CancellationToken.None);

Considering the previous patch (calling gameObject.SetActive(true) after hiding the submenu), it seems that TextMeshProUGUI is processing "something" asynchronously when activated for the first time.

If we can find an accessible event that notifies when it completes, everything will be resolved!

[mob-sakai]

This may be due to the SoftMaskable component being above the SubMeshUI component.

[mob-sakai]

PERFECT!
I will release it soon. Good night.

[mob-sakai]

🎉 This issue has been resolved in version 3.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀