Fixed several screen reader issues during the gameplay

Bianca Marina Stana · Bianca Marina Stana · commit e95ed02a45b1 · 2025-10-03T01:09:35.000-04:00
diff --git a/Assets/Scripts/Gameplay/GameViewController.cs b/Assets/Scripts/Gameplay/GameViewController.cs
@@ -169,7 +169,11 @@ bool OnLetterCardSelected()
                 AccessibilityManager.GetService<UGuiAccessibilityService>()?.ActivateOtherAccessibilityNodes(false, letterCardContainer);
 
                 letterCard.SetDraggingVisuals(true);
-                SetLetterCardsAccessibilityLabel(false);
+
+                var element = m_AccessibilityFocusedCard.GetComponent<AccessibleElement>();
+                // TODO: This should be localized.
+                element.hint = "Navigate left or right to move. Submit to unselect.";
+                element.SetNodeProperties();
             }
             else
             {
@@ -178,7 +182,10 @@ bool OnLetterCardSelected()
                 AccessibilityManager.GetService<UGuiAccessibilityService>()?.ActivateOtherAccessibilityNodes(true, letterCardContainer);
 
                 letterCard.SetDraggingVisuals(false);
-                SetLetterCardsAccessibilityLabel(true);
+
+                var element = m_AccessibilityFocusedCard.GetComponent<AccessibleElement>();
+                element.hint = LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "LETTER_CARD_HINT");
+                element.SetNodeProperties();
             }
 
             return true;
@@ -192,6 +199,9 @@ void MoveAccessibilityFocusOnClue()
 
         public void OnWordReorderingCompleted()
         {
+            m_AccessibilitySelectedCard.SetDraggingVisuals(false);
+            m_AccessibilitySelectedCard = null;
+
             StartCoroutine(DelayWordReorderingCompleted());
             return;
 
@@ -276,17 +286,6 @@ void MoveSelectedCard()
             }
         }
 
-        void SetLetterCardsAccessibilityLabel(bool hasLabel)
-        {
-            foreach (Transform letterCardTransform in letterCardContainer)
-            {
-                var element = letterCardTransform.GetComponent<AccessibleElement>();
-                element.label = hasLabel ? letterCardTransform.name : null;
-                element.hint = hasLabel ? LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "LETTER_CARD_HINT") : null;
-                element.SetNodeProperties();
-            }
-        }
-
         void MoveCard(bool shouldMoveLeft, int count)
         {
             var draggable = m_AccessibilitySelectedCard;
diff --git a/Assets/Scripts/UITk/Card.cs b/Assets/Scripts/UITk/Card.cs
@@ -4,6 +4,7 @@
 using UnityEngine.Accessibility;
 using UnityEngine.UIElements;
 using Unity.Samples.ScreenReader;
+using UnityEngine.Localization.Settings;
 
 namespace Unity.Samples.LetterSpell
 {
@@ -68,15 +69,8 @@ public void Select()
             {
                 cardListView.selectedCard = this;
 
-                // Check whether the card is focused or not.
-                var focused = focusController?.focusedElement == this;
-
                 // TODO: This should be localized.
-                accessible.hint = focused ? "Submit to unselect." : "Submit to select.";
-
-                // TODO: These should be localized.
-                AssistiveSupport.notificationDispatcher.SendAnnouncement($"Card {text} selected. Navigate left or " +
-                    "right to move the card." + (focused ? "Submit to unselect it." : ""));
+                accessible.hint = "Navigate left or right to move. Submit to unselect.";
 
                 OnScreenDebug.Log("Selected card: " + text);
             }
@@ -86,16 +80,10 @@ public void Unselect()
         {
             if (this == cardListView.selectedCard)
             {
-                // Check whether the card is focused or not.
-                var focused = focusController?.focusedElement == this;
                 cardListView.selectedCard = null;
 
-                // TODO: This should be localized.
-                accessible.hint = focused ? "Submit to unselect." : "Submit to select.";
-
-                // TODO: These should be localized.
-                AssistiveSupport.notificationDispatcher.SendAnnouncement($"Card {text} selected. Navigate left or " +
-                    "right to move the card." + (focused ? "Submit to unselect it." : ""));
+                // TODO: Change to "Submit to select, then navigate left or right to move."
+                accessible.hint = LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "LETTER_CARD_HINT");
             }
         }
 
@@ -115,6 +103,8 @@ public UITkLetterCard()
 
             // Accessibility
             m_TextElement.GetOrCreateAccessibleProperties().ignored = true;
+
+            accessible.hint = LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "LETTER_CARD_HINT");
             accessible.selected += () =>
             {
                 if (!selected)
diff --git a/Assets/Scripts/UITk/MainView.cs b/Assets/Scripts/UITk/MainView.cs
@@ -247,7 +247,9 @@ UITkLetterCard accessibilityFocusedCard
             set
             {
                 if (m_AccessibilityFocusedCard == value)
+                {
                     return;
+                }
 
                 m_AccessibilityFocusedCard?.Blur();
 
@@ -262,12 +264,14 @@ UITkLetterCard accessibilityFocusedCard
                 // Note: we don't want to steal the focus if the user is dragging a card.
                 OnScreenDebug.Log("In Acc Focus " + (m_AccessibilityFocusedCard != null ? m_AccessibilityFocusedCard.name : "null") +
                     " selected " + (m_LetterCardContainer.selectedCard != null ? m_LetterCardContainer.selectedCard.name : "null"));
+
                 if (m_AccessibilityFocusedCard != null && m_LetterCardContainer.selectedCard == null)
+                {
                     m_AccessibilityFocusedCard.Focus();
+                }
 
                 OnScreenDebug.Log("After Acc Focus " + (m_AccessibilityFocusedCard != null ? m_AccessibilityFocusedCard.name : "null") +
                                   " selected " + (m_LetterCardContainer.selectedCard != null ? m_LetterCardContainer.selectedCard.name : "null"));
-
             }
         }
 
@@ -623,6 +627,7 @@ void StateTheLetters()
         public void OnWordReorderingCompleted()
         {
             m_LetterCardContainer.canPlayCards = false;
+            m_LetterCardContainer.selectedCard.Unselect();
 
             m_MainView.schedule.Execute(_ => AnnounceCorrectWord()).ExecuteLater(2000);
 
@@ -650,18 +655,17 @@ void FadeSuccessImageOut()
 
         void OnNodeFocusChanged(AccessibilityNode node)
         {
-            if (node != null)
+            if (node == null)
             {
-                var service = AccessibilityManager.GetService<UITkAccessibilityService>();
-                var element = service.GetVisualElementForNode(m_MainView.panel, node);
-
-                accessibilityFocusedCard = element as UITkLetterCard;
-                MoveSelectedCardOnAssistedFocus();
-            }
-            else
-            {
-                accessibilityFocusedCard = null;
+                return;
             }
+
+            var service = AccessibilityManager.GetService<UITkAccessibilityService>();
+            var element = service.GetVisualElementForNode(m_MainView.panel, node);
+
+            accessibilityFocusedCard = element as UITkLetterCard;
+
+            MoveSelectedCardOnAssistedFocus();
         }
 
         void MoveSelectedCardOnAssistedFocus()
@@ -716,28 +720,35 @@ void MoveCard(bool shouldMoveLeft, int count = 1)
 
             // OnScreenDebug.Log("MoveCard " + (shouldMoveLeft ? "left" : "right" + " count " + count));
 
+            var updater = m_LetterCardContainer.selectedCard.panel.GetAccessibilityUpdater();
+            var node = updater.GetNodeForVisualElement(m_LetterCardContainer.selectedCard);
+
+            var selectedCardText = m_LetterCardContainer.selectedCard.text;
+
+            var index = m_LetterCardContainer.IndexOf(m_LetterCardContainer.selectedCard);
+            var otherCardIndex = shouldMoveLeft ? index - 1 : index + 1;
+            var otherCard = m_LetterCardContainer[otherCardIndex] as UITkLetterCard;
+            var otherCardText = otherCard?.text;
+
             var moved = shouldMoveLeft ?
                 m_LetterCardContainer.selectedCard.MoveLeft(count) :
                 m_LetterCardContainer.selectedCard.MoveRight(count);
 
+            m_MainView.schedule.Execute(() =>
+                AssistiveSupport.notificationDispatcher.SendLayoutChanged(node)
+                ).ExecuteLater(50);
+
             if (moved)
             {
-                var index = m_LetterCardContainer.IndexOf(m_LetterCardContainer.selectedCard);
-                var otherCardIndex = shouldMoveLeft ? index + 1 : index - 1;
-                var otherCard = m_LetterCardContainer[otherCardIndex] as UITkLetterCard;
-
                 // TODO: This should be localized.
-                var message = $"Moved {m_LetterCardContainer.selectedCard.text} {(shouldMoveLeft ? "before" : "after")} {otherCard?.text}";
+                var message = $"Moved {selectedCardText} {(shouldMoveLeft ? "before" : "after")} {otherCardText}";
 
                 // Announce that the card was moved.
-                AssistiveSupport.notificationDispatcher.SendAnnouncement(message);
+                m_MainView.schedule.Execute(() =>
+                    AssistiveSupport.notificationDispatcher.SendAnnouncement(message)
+                ).ExecuteLater(100);
             }
 
-            var updater = m_LetterCardContainer.selectedCard.panel.GetAccessibilityUpdater();
-            var node = updater.GetNodeForVisualElement(m_LetterCardContainer.selectedCard);
-
-            AssistiveSupport.notificationDispatcher.SendLayoutChanged(node);
-
             /*var accElement = draggable.transform.GetComponent<AccessibleElement>();
 
             if (shouldMoveLeft ? draggable.MoveLeft() : draggable.MoveRight())

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`using UnityEngine.Accessibility;`
`5`	`5`	`using UnityEngine.UIElements;`
`6`	`6`	`using Unity.Samples.ScreenReader;`
	`7`	`+using UnityEngine.Localization.Settings;`
`7`	`8`
`8`	`9`	`namespace Unity.Samples.LetterSpell`
`9`	`10`	`{`
`@@ -68,15 +69,8 @@ public void Select()`
`68`	`69`	`{`
`69`	`70`	`cardListView.selectedCard = this;`
`70`	`71`
`71`		`- // Check whether the card is focused or not.`
`72`		`- var focused = focusController?.focusedElement == this;`
`73`		`-`
`74`	`72`	`// TODO: This should be localized.`
`75`		`- accessible.hint = focused ? "Submit to unselect." : "Submit to select.";`
`76`		`-`
`77`		`- // TODO: These should be localized.`
`78`		`- AssistiveSupport.notificationDispatcher.SendAnnouncement($"Card {text} selected. Navigate left or " +`
`79`		`- "right to move the card." + (focused ? "Submit to unselect it." : ""));`
	`73`	`+ accessible.hint = "Navigate left or right to move. Submit to unselect.";`
`80`	`74`
`81`	`75`	`OnScreenDebug.Log("Selected card: " + text);`
`82`	`76`	`}`
`@@ -86,16 +80,10 @@ public void Unselect()`
`86`	`80`	`{`
`87`	`81`	`if (this == cardListView.selectedCard)`
`88`	`82`	`{`
`89`		`- // Check whether the card is focused or not.`
`90`		`- var focused = focusController?.focusedElement == this;`
`91`	`83`	`cardListView.selectedCard = null;`
`92`	`84`
`93`		`- // TODO: This should be localized.`
`94`		`- accessible.hint = focused ? "Submit to unselect." : "Submit to select.";`
`95`		`-`
`96`		`- // TODO: These should be localized.`
`97`		`- AssistiveSupport.notificationDispatcher.SendAnnouncement($"Card {text} selected. Navigate left or " +`
`98`		`- "right to move the card." + (focused ? "Submit to unselect it." : ""));`
	`85`	`+ // TODO: Change to "Submit to select, then navigate left or right to move."`
	`86`	`+ accessible.hint = LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "LETTER_CARD_HINT");`
`99`	`87`	`}`
`100`	`88`	`}`
`101`	`89`
`@@ -115,6 +103,8 @@ public UITkLetterCard()`
`115`	`103`
`116`	`104`	`// Accessibility`
`117`	`105`	`m_TextElement.GetOrCreateAccessibleProperties().ignored = true;`
	`106`	`+`
	`107`	`+ accessible.hint = LocalizationSettings.StringDatabase.GetLocalizedString("Game Text", "LETTER_CARD_HINT");`
`118`	`108`	`accessible.selected += () =>`
`119`	`109`	`{`
`120`	`110`	`if (!selected)`