|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 |
end
end
end
--Helper function for determining if something is a narratable object
return true
end
return false
end
--TODO XAR: Make an enum for this
local NARRATION_ENTRY_TYPE_PARAMETRIC_LIST_ENTRY = 1
local NARRATION_ENTRY_TYPE_SOCIAL_LIST_ENTRY = 2
local NARRATION_ENTRY_TYPE_SORT_HEADER = 3
local NARRATION_ENTRY_TYPE_COMBO_BOX = 4
local NARRATION_ENTRY_TYPE_GRID_LIST_ENTRY = 5
local NARRATION_ENTRY_TYPE_EDIT_BOX = 6
local NARRATION_ENTRY_TYPE_TEXT_SEARCH_HEADER = 7
local NARRATION_ENTRY_TYPE_DIALOG = 8
local NARRATION_ENTRY_TYPE_FADING_CONTROL_BUFFER = 9
local NARRATION_ENTRY_TYPE_FOCUS_ENTRY = 10
local SCREEN_NARRATION_QUEUE_DELAY_MS = 250
---------------------------------------------
-- Narratable Object
---------------------------------------------
end
end
--TODO XAR: Look into potentially allowing us to add the narration text to the front
--Adds the specified narration text. Narration text can be a string, table of strings, or number
return
end
else
end
end
--Sets the pause time to use when forming the final narration string
--Pause time and delimiter are mutually exclusive; setting one will clear the other
end
--Sets the delimiter to use when forming the final narration string
--Pause time and delimiter are mutually exclusive; setting one will clear the other
end
--If a delimiter is set use that, otherwise fall back to pause time
else
end
end
---------------------------------------------
-- Screen Narration Params
---------------------------------------------
end
--Calling ZO_ClearTable on self will clear out any variables that were set on this object
end
end
end
end
end
--TODO XAR: Is priority a thing we need?
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
end
---------------------------------------------
-- Screen Narration Manager
---------------------------------------------
self.parametricListTargetChangedCallback = function(list, targetData, oldTargetData, reachedTarget, targetSelectedIndex, reselectingDuringRebuild)
end
end
if activated then
local NARRATE_HEADER = true
end
end
--Re-narrate any active parametric lists upon hiding dialogs
local NARRATE_HEADER = true
end
end
end
end
end
end
--Do not start any narrations while a load screen is active
return
end
--TODO XAR: Support multiple queues
end
end
end
end
end
EVENT_MANAGER:RegisterForEvent("ScreenNarrationManager", EVENT_APP_GUI_HIDDEN_STATE_CHANGED, OnAppGuiHiddenStateChanged)
end
end
end
--Narration params need to re-set their pool and key each time we acquire due to us calling ZO_ClearTable(self) in the reset
end
return narratableObject
end
end
end
CALLBACK_MANAGER:RegisterCallback("AllDialogsHidden", self.parametricListAllDialogsHiddenCallback, list)
--Store off the associated parametric list narration info for this list, so we can access it later
end
local narrationInfo =
{
end,
end,
}
end
CALLBACK_MANAGER:UnregisterCallback("AllDialogsHidden", self.parametricListAllDialogsHiddenCallback, list)
end
dialog.entryList:RegisterCallback("TargetDataChanged", function(list, targetData, oldTargetData, reachedTarget, targetSelectedIndex, reselectingDuringRebuild)
if not reselectingDuringRebuild then
end
end)
if activated then
end
end)
end
end)
end)
end
end
end)
if selectedData then
end
end)
CALLBACK_MANAGER:RegisterCallback("AllDialogsHidden", self.gridListAllDialogsHiddenCallback, gridList)
end
end
end)
end
return narrationParams
end
return narratableObject
end
end
end
--TODO XAR: Look into making each case a function in a table indexed by narration type
if narrationType == NARRATION_ENTRY_TYPE_PARAMETRIC_LIST_ENTRY then
self:NarrateParametricListEntry(narrationInfo, list, list:GetTargetData(), list:GetTargetControl(), narrationParams:GetNarrateParametricListHeader())
end
elseif narrationType == NARRATION_ENTRY_TYPE_SOCIAL_LIST_ENTRY then
end
elseif narrationType == NARRATION_ENTRY_TYPE_SORT_HEADER then
if list:IsActive() and sortHeaderGroup:IsEnabled() and sortHeaderGroup:IsKeyCurrentSelectedIndex(key) then
end
elseif narrationType == NARRATION_ENTRY_TYPE_COMBO_BOX then
elseif narrationType == NARRATION_ENTRY_TYPE_GRID_LIST_ENTRY then
end
elseif narrationType == NARRATION_ENTRY_TYPE_EDIT_BOX then
elseif narrationType == NARRATION_ENTRY_TYPE_TEXT_SEARCH_HEADER then
self:NarrateEditBox(textSearchHeader:GetEditBox(), GetString(SI_SCREEN_NARRATION_EDIT_BOX_SEARCH_NAME))
end
elseif narrationType == NARRATION_ENTRY_TYPE_DIALOG then
end
elseif narrationType == NARRATION_ENTRY_TYPE_FADING_CONTROL_BUFFER then
self:NarrateFadingControlBuffer(narrationParams:GetFadingControlBufferEntryData(), narrationParams:GetFadingControlBufferTemplateData())
elseif narrationType == NARRATION_ENTRY_TYPE_FOCUS_ENTRY then
end
else
end
end
end
end
end
end
if queuedNarration and queuedNarration:GetNarrationType() == NARRATION_ENTRY_TYPE_PARAMETRIC_LIST_ENTRY then
--If the list we are queueing is the same one we are overwriting, then make sure we still read the header if necessary
narrateHeader = queuedNarrateHeader
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_PARAMETRIC_LIST_ENTRY, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_SOCIAL_LIST_ENTRY, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_SORT_HEADER, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_COMBO_BOX, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_EDIT_BOX, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
--TODO XAR: Do we actually need this to be a separate function?
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_GRID_LIST_ENTRY, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_TEXT_SEARCH_HEADER, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_DIALOG, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_FADING_CONTROL_BUFFER, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
local narrationParams = self:CreateNarrationParams(NARRATION_ENTRY_TYPE_FOCUS_ENTRY, SCREEN_NARRATION_QUEUE_DELAY_MS)
end
end
--TODO XAR: Look into having the message params return narratable objects
--CSAs do not need to wait before sending to the C++, so attempt to narrate them immediately
--TODO XAR: Have this go into a different queue
end
end
--CSAs do not need to wait before sending to the C++, so attempt to narrate them immediately
--TODO XAR: Have this go into a different queue
end
end
do
local KEYBIND_PAUSE_TIME_MS = 100
--Gets a narratable object for the currently active keybinds on the keybind strip
local formatter = i == 1 and SI_SCREEN_NARRATION_FIRST_KEYBIND_FORMATTER or SI_SCREEN_NARRATION_KEYBIND_FORMATTER
else
local formatter = i == 1 and SI_SCREEN_NARRATION_FIRST_KEYBIND_FORMATTER_NO_LABEL or SI_SCREEN_NARRATION_KEYBIND_FORMATTER_NO_LABEL
end
end
return keybindNarration
end
end
--Recursively populates a narratable object representing a tooltip read in the order it is laid out visually
--If this is just a string, we can just add it to the narration as-is
--If this is a table, loop through each entry and add it to the narration
end
end
end
--Gets a table of narratable objects representing the narration text for a tooltip or tooltips
--If optionalTooltipType is not specified, the table returned will contain a narratable object for each visible tooltip
--Get the table of tooltip strings
--The table is ordered based on the order the strings should be read visually
--If an optional tooltip type was specified tooltipStrings will either be a table of strings representing a single tooltip, or an empty string
--This means we only need one narratable object
if optionalTooltipType then
return { narration }
else
--If an optional tooltip type was not specified, then tooltipStrings will be a table of tables for each visible tooltip
--In this situation, we loop and create a narratable object for each individual tooltip
local narrations = {}
end
return narrations
end
end
function ZO_ScreenNarrationManager:NarrateParametricListEntry(narrationInfo, list, entryData, entryControl, narrateHeader)
local narrations = {}
if headerNarration then
end
end
--If the list is empty, then narrate the no item text instead
end
--If the narration text is a function it should return either a narratable object or table of narratable objects
else
end
else
end
else
--Entries using a custom value via entryData.narrationText need to handle sublabels themselves if they want it
ZO_CombineNumericallyIndexedTables(narrations, ZO_GetSharedGamepadEntrySubLabelNarrationText(entryData, entryControl))
end
end
end
if entryData then
local narrations = {}
--If the narration text is a function it should return either a narratable object or table of narratable objects
else
end
else
end
end
end
end
end
local narrations = {}
end
local narrations = {}
end
local narrations = {}
end
if focus then
local narrations = {}
if focusNarration then
end
end
end
--Forms a table of the narrations that are common amongst all the dialog types
function ZO_ScreenNarrationManager:GetDialogBaseNarration(dialog, dialogInfo, dialogType, textParams, narrateBaseText)
local narrations = {}
--narrateBaseText should only be true upon first opening the dialog
if narrateBaseText then
table.insert(narrations, ZO_GamepadGenericHeader_GetNarrationText(dialog.header, dialog.headerData))
elseif dialogInfo.title then
end
end
--Centered dialogs do not support sub text or warning
if dialogType ~= GAMEPAD_DIALOGS.CENTERED then
if dialogInfo.subText then
end
if dialogInfo.warning then
end
end
if dialogInfo.baseNarrationTooltip then
ZO_CombineNumericallyIndexedTables(narrations, self:GetTooltipNarration(dialogInfo.baseNarrationTooltip))
end
end
return narrations
end
local dialogInfo = dialog.info
if dialogInfo.gamepadInfo then
local dialogType = dialogInfo.gamepadInfo.dialogType
local textParams = dialog.textParams or {}
--First, get the base narration
local narrations = self:GetDialogBaseNarration(dialog, dialogInfo, dialogType, textParams, narrateBaseText)
if dialogType == GAMEPAD_DIALOGS.BASIC then
--Do nothing, this dialog type is handled fully by the base narration
elseif dialogType == GAMEPAD_DIALOGS.PARAMETRIC then
--If the dialog type is parametric, attempt to narrate the currently selected entry in the list
end
else
end
else
end
else
--Entries using a custom value via entryData.narrationText need to handle sublabels themselves if they want it
ZO_CombineNumericallyIndexedTables(narrations, ZO_GetSharedGamepadEntrySubLabelNarrationText(entryData, entryControl))
end
--Dialogs only narrate tooltips when one is specifically specified
if entryData.narrationTooltip then
ZO_CombineNumericallyIndexedTables(narrations, self:GetTooltipNarration(entryData.narrationTooltip))
end
end
end
elseif dialogType == GAMEPAD_DIALOGS.COOLDOWN then
--If this is a cooldown dialog, attempt to narrate the loading text
if dialogInfo.loading then
end
end
elseif dialogType == GAMEPAD_DIALOGS.CENTERED then
--Do nothing, this dialog type is handled fully by the base narration
elseif dialogType == GAMEPAD_DIALOGS.STATIC_LIST then
--If the dialog type is static list, attempt to narrate each entry in the list
end
end
end
elseif dialogType == GAMEPAD_DIALOGS.ITEM_SLIDER then
--If the dialog type is item slider, attempt to narrate the associated slider
local itemName = ""
if bagId and slotIndex then
--Use the name of the item as the name of the slider
end
--If the narration text is a function it should return either a narratable object or table of narratable objects
else
end
else
end
else
end
end
elseif dialogType == GAMEPAD_DIALOGS.CUSTOM then
else
end
else
end
end
else
end
--Always add keybinds at the end
end
end
local narrations = {}
else
end
end
local lines = entryData.lines
if lines then
else
end
end
end
--TODO XAR: Have this use a separate queue from normal UI text
--We may want to have crafting results and alerts go to different queues differently
end
--TODO XAR: Do we need category here?
if chatMessage ~= "" then
--TODO XAR: Make a narrate text function that takes a narration type
end
end
end
--Adds a single narratable object to the pending narration and then releases the object
end
end
else
end
end
end
end
--Global functions
--Given a grid list entry, returns the narration text from the entry's object. Intended to be used for entries that inherit from ZO_Tile
if entryData and entryData.dataEntry then
end
end
end
--Generates narration text for a toggle control. The header parameter is optional
local isCheckedText = isChecked and GetString(SI_SCREEN_NARRATION_TOGGLE_ON) or GetString(SI_SCREEN_NARRATION_TOGGLE_OFF)
return SCREEN_NARRATION_MANAGER:CreateNarratableObject(zo_strformat(SI_SCREEN_NARRATION_TOGGLE_WITH_HEADER_FORMATTER, name, isCheckedText, header))
else
return SCREEN_NARRATION_MANAGER:CreateNarratableObject(zo_strformat(SI_SCREEN_NARRATION_TOGGLE_FORMATTER, name, isCheckedText))
end
end
--Generates narration text for a radio button control. The header parameter is optional
local isCheckedText = isChecked and GetString(SI_SCREEN_NARRATION_TOGGLE_ON) or GetString(SI_SCREEN_NARRATION_TOGGLE_OFF)
return SCREEN_NARRATION_MANAGER:CreateNarratableObject(zo_strformat(SI_SCREEN_NARRATION_RADIO_BUTTON_WITH_HEADER_FORMATTER, name, isCheckedText, header))
else
return SCREEN_NARRATION_MANAGER:CreateNarratableObject(zo_strformat(SI_SCREEN_NARRATION_RADIO_BUTTON_FORMATTER, name, isCheckedText))
end
end
do
local NUMERIC_ONLY_TEXT_TYPES =
{
[TEXT_TYPE_NUMERIC] = true,
[TEXT_TYPE_NUMERIC_UNSIGNED_INT] = true,
}
--Generates narration text for an edit control. The name parameter is optional.
if editControl then
--Use a slightly different string if the edit control is numeric (meaning it only accepts numbers)
if NUMERIC_ONLY_TEXT_TYPES[textType] then
else
end
--Default to using the current value text of the edit box, and then fall back to the default text if necessary
if valueText ~= "" then
else
end
narration:AddNarrationText(zo_strformat(SI_SCREEN_NARRATION_EDIT_BOX_INPUT_CHARACTER_LIMIT, editControl:GetMaxInputChars()))
return narration
end
end
end
--Generates narration text for a spinner.
--TODO XAR: Include directional input for the spinner
return SCREEN_NARRATION_MANAGER:CreateNarratableObject(zo_strformat(SI_SCREEN_NARRATION_SPINNER_FORMATTER, name, value))
end
--Generates narration text for a slider
--TODO XAR: Include directional input for the slider
return SCREEN_NARRATION_MANAGER:CreateNarratableObject(zo_strformat(SI_SCREEN_NARRATION_SLIDER_FORMATTER, name, value, min, max))
end
--Default function for getting the narration text for a dropdown entry in a parametric list
end
--Default function for getting the narration text for an edit box control in a parametric list
end
--Default function for getting the narration text for a toggle in a parametric list
end
--Function for getting a table of narratable objects for sublabels defined in a shared gamepad entry
local narrations = {}
else
end
else
table.insert(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(entryData.subLabelsNarrationText))
end
elseif entryData.subLabels then
local subLabelText
else
end
end
end
return narrations
end
do
local DEFAULT_PAUSE_TIME_MS = 200
--Forms a table of strings into a single string separated by pauses for narration.
pauseTime = pauseTime or DEFAULT_PAUSE_TIME_MS
end
end
-- Global singleton
-- The global singleton moniker is assigned by the Narration Manager's constructor in order to
-- allow data objects to reference the singleton during their construction.
|