Back to Home

ESO Lua File v101050

ingame/tutorial/uiinfoboxtutorial.lua

[◄ back to folders ]
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
ZO_UiInfoBoxTutorial = ZO_TutorialHandlerBase:Subclass()
local TUTORIAL_SEEN = true
local TUTORIAL_NOT_SEEN = false
--Allow extra space for icons and keybind backgrounds that can extend above and below the top and bottom lines.
ZO_TUTORIAL_DIALOG_DESCRIPTION_EDGE_PADDING_Y = 6
ZO_TUTORIAL_DIALOG_DESCRIPTION_TOTAL_PADDING_Y = ZO_TUTORIAL_DIALOG_DESCRIPTION_EDGE_PADDING_Y * 2
ZO_TUTORIAL_DIALOG_SOFT_MAX_HEIGHT = 350
ZO_TUTORIAL_DIALOG_HARD_MAX_HEIGHT = 360
function ZO_UiInfoBoxTutorial:Initialize()
    self:ClearAll()
    local dialogControl = ZO_TutorialDialog
    self.dialogPane = dialogControl:GetNamedChild("Pane")
    self.dialogScrollChild = self.dialogPane:GetNamedChild("ScrollChild")
    self.dialogDescription = self.dialogScrollChild:GetNamedChild("Description")
    self.dialogInfo =
    {
        canQueue = true,
        title = {},
        customControl = dialogControl,
        noChoiceCallback = function(dialog)
            dialog.data.owner:RemoveTutorial(dialog.data.tutorialIndex, TUTORIAL_SEEN)
        end,
        buttons =
        {
            {
                control = dialogControl:GetNamedChild("Cancel"),
                text = SI_EXIT_BUTTON,
                keybind = "DIALOG_NEGATIVE",
                clickSound = SOUNDS.DIALOG_ACCEPT,
                callback =  function(dialog)
                    dialog.data.owner:RemoveTutorial(dialog.data.tutorialIndex, TUTORIAL_SEEN)
                end,
            },
        },
    }
    ZO_Dialogs_RegisterCustomDialog("UI_TUTORIAL", self.dialogInfo)
    ZO_Dialogs_RegisterCustomDialog("UI_TUTORIAL_GAMEPAD",
        {
            canQueue = true,
            setup = function(dialog)
                dialog:setupFunc()
            end,
            gamepadInfo =
            {
                dialogType = GAMEPAD_DIALOGS.CENTERED,
            },
            title =
            {
                text = function()
                    return self.title
                end,
            },
            mainText = 
            {
                text = function()
                    return self.description
                end,
            },
            buttons =
            {
                {
                    -- Even though this is an ethereal keybind, the name will still be shown as the centered dialogs interact keybind and read during screen narration
                    name = GetString(SI_TUTORIAL_CONTINUE),
                    ethereal = true,
                    narrateEthereal = true,
                    keybind = "DIALOG_PRIMARY",
                    clickSound = SOUNDS.DIALOG_ACCEPT,
                    callback = function(dialog)
                        dialog.data.owner:RemoveTutorial(dialog.data.tutorialIndex, TUTORIAL_SEEN)
                    end,
                }
            },
            noChoiceCallback = function(dialog)
                if dialog.data then
                    dialog.data.owner:RemoveTutorial(dialog.data.tutorialIndex, TUTORIAL_SEEN)
                end
            end,
            removedFromQueueCallback = function(data)
                if data then
                    data.owner:RemoveTutorial(data.tutorialIndex, TUTORIAL_NOT_SEEN)
                end
            end,
        }
    )
    self.gamepadMode = false
end
function ZO_UiInfoBoxTutorial:GetDialog()
    return self.dialogs[self.gamepadMode]
end
function ZO_UiInfoBoxTutorial:SuppressTutorials(suppress, reason)
    -- Suppression is disabled in ZO_UiInfoBoxTutorial
end
function ZO_UiInfoBoxTutorial:GetTutorialType()
    return TUTORIAL_TYPE_UI_INFO_BOX
end
--Additional spacing to account for the backdrop behind a key label if there's one in the last line or the first line
function ZO_UiInfoBoxTutorial:DisplayTutorial(tutorialIndex)
    self.title, self.description = GetTutorialInfo(tutorialIndex)
    self.gamepadMode = IsInGamepadPreferredMode()
    if self.gamepadMode then
        ZO_Dialogs_ShowGamepadDialog("UI_TUTORIAL_GAMEPAD", { tutorialIndex = tutorialIndex, owner = self })
    else
        self.dialogInfo.title.text = self.title
        self.dialogDescription:SetText(self.description)
        local descriptionHeight = self.dialogDescription:GetTextHeight() + ZO_TUTORIAL_DIALOG_DESCRIPTION_TOTAL_PADDING_Y
        self.dialogScrollChild:SetHeight(descriptionHeight)
        --To prevent having this pane scroll over a tiny amount of space we only force it to scroll if it hits the hard max height. This guarentees that it will scroll at least (hard - soft UI units).
        local paneHeight = descriptionHeight
        if paneHeight > ZO_TUTORIAL_DIALOG_HARD_MAX_HEIGHT then
            paneHeight = ZO_TUTORIAL_DIALOG_SOFT_MAX_HEIGHT
        end
        self.dialogPane:SetHeight(paneHeight)
        ZO_Scroll_ResetToTop(self.dialogPane)
        ZO_Dialogs_ShowDialog("UI_TUTORIAL", { tutorialIndex = tutorialIndex, owner = self })
    end
end
function ZO_UiInfoBoxTutorial:OnDisplayTutorial(tutorialIndex, priority)
    if SCENE_MANAGER:IsInUIMode() then
        if not self:IsTutorialDisplayedOrQueued(tutorialIndex) then
            if self:CanShowTutorial() then
                self:DisplayTutorial(tutorialIndex)
            end
        end
    end
end
function ZO_UiInfoBoxTutorial:OnRemoveTutorial(tutorialIndex)
    self:RemoveTutorial(tutorialIndex, TUTORIAL_SEEN)
end
function ZO_UiInfoBoxTutorial:RemoveTutorial(tutorialIndex, seen)
    if self:GetCurrentlyDisplayedTutorialIndex() == tutorialIndex then
        if seen then
            SetTutorialSeen(tutorialIndex)
        end
        ZO_Dialogs_ReleaseDialog("UI_TUTORIAL")
        ZO_Dialogs_ReleaseDialog("UI_TUTORIAL_GAMEPAD")
    else
        self:RemoveFromQueue(self.queue, tutorialIndex)
    end
end
function ZO_UiInfoBoxTutorial:ClearAll()
    self.queue = {}
end