Back to Home

ESO Lua File v101050

ingame/subtitles/subtitles.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
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
----
-- ZO_Subtitle
----
local ZO_Subtitle = ZO_Object:Subclass()
function ZO_Subtitle:New(...)
    local subtitle = ZO_Object.New(self)
    subtitle:Initialize(...)
    return subtitle
end
do
    local CHARACTERS_PER_SECOND_DEFAULT = 10
    local CHARACTERS_PER_SECOND_OVERRIDE =
    {
        ["jp"] = 5,
        ["zh"] = 5,
    }
    -- Check if any new language needs a custom characters per second value
    internalassert(OFFICIAL_LANGUAGE_MAX_VALUE == 6)
    local MIN_DISPLAY_LENGTH_SECONDS = 3
    local MAX_DISPLAY_LENGTH_SECONDS = 12
    function ZO_Subtitle:Initialize(messageType, speaker, message)
        self.messageType = messageType
        self.speakerName = speaker
        self.messageText = message
        self.startTimeSeconds = 0
        local messageLength = ZoUTF8StringLength(message)
        local language = GetCVar("Language.2")
        local charactersPerSecond = CHARACTERS_PER_SECOND_OVERRIDE[language] or CHARACTERS_PER_SECOND_DEFAULT
        self.displayLengthSeconds = zo_clamp(messageLength / charactersPerSecond, MIN_DISPLAY_LENGTH_SECONDS, MAX_DISPLAY_LENGTH_SECONDS)
    end
end
function ZO_Subtitle:GetMessageType()
    return self.messageType
end
function ZO_Subtitle:GetMessage()
    return self.messageText
end
function ZO_Subtitle:GetSpeakerName()
    return self.speakerName
end
function ZO_Subtitle:GetFormattedMessage(showSpeakerName)
    if showSpeakerName then
        return zo_strformat(SI_SUBTITLE_FORMAT, self.speakerName, self.messageText)
    else
        return zo_strformat(SI_SUBTITLE_FORMAT_WITHOUT_SPEAKER, self.messageText)
    end
end
function ZO_Subtitle:GetDisplayLength()
    return self.displayLengthSeconds
end
function ZO_Subtitle:GetStartTime()
    return self.startTimeSeconds
end
function ZO_Subtitle:SetStartTime(startTimeSeconds)
    self.startTimeSeconds = startTimeSeconds
end
function ZO_Subtitle:HasExpired(currentTimeSeconds)
    return self.startTimeSeconds + self.displayLengthSeconds <= currentTimeSeconds
end
----
-- ZO_SubtitleManager
----
ZO_SubtitleManager = ZO_Object:Subclass()
function ZO_SubtitleManager:New(...)
    local manager = ZO_Object.New(self)
    manager:Initialize(...)
    return manager
end
function ZO_SubtitleManager:Initialize(control)
    SUBTITLE_HUD_FRAGMENT = ZO_HUDFadeSceneFragment:New(control)
    SUBTITLE_UI_FRAGMENT = ZO_FadeSceneFragment:New(control)
    self.control = control
    self.messageBackground = self.messageText:GetNamedChild("Background")
    self.fadeInAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("ZO_Subtitles_TextFadeIn", self.messageText)
    self.control:RegisterForEvent(EVENT_SHOW_SUBTITLE, function(event, ...) self:OnShowSubtitle(...) end)
    EVENT_MANAGER:RegisterForUpdate("ZO_SubtitleManager", 1000, function(...) self:OnUpdate(...) end)
end
--platform style
local KEYBOARD_STYLES = {
                            textTemplate = "ZO_Subtitles_Text_Keyboard_Template",
                            textWidth = 1200,
                        }
local GAMEPAD_STYLES =  {
                            textTemplate = "ZO_Subtitles_Text_Gamepad_Template",
                            textWidth = 890,
                        }
function ZO_SubtitleManager:UpdatePlatformStyles(styleTable)
    ApplyTemplateToControl(self.messageText, styleTable.textTemplate)
    self.messageText:SetWidth(styleTable.textWidth)
end
function ZO_SubtitleManager:InitializePlatformStyles()
    ZO_PlatformStyle:New(function(...) self:UpdatePlatformStyles(...) end, KEYBOARD_STYLES, GAMEPAD_STYLES)
end
function ZO_SubtitleManager:FadeInSubtitle()
    if self.fadeInAnimation:IsPlaying() then
        self.fadeInAnimation:PlayForward()
    else
        -- if we are already fully faded in, then do a bit of a "flash"
        -- to help transition to the new text that is being displayed
        if self.messageText:GetAlpha() >= 0.8 then
            self.fadeInAnimation:SetProgress(0.6)
            self.fadeInAnimation:PlayForward()
        else
            self.fadeInAnimation:PlayFromStart()
        end
    end
end
function ZO_SubtitleManager:FadeOutSubtitle()
    if self.fadeInAnimation:IsPlaying() then
        self.fadeInAnimation:PlayBackward()
    else
        -- if we are already faded out, don't do anything
        local alpha = self.messageText:GetAlpha()
        if alpha ~= 0 then
            self.fadeInAnimation:PlayFromEnd()
        end
    end
end
do
    local HIDE_SAME_SPEAKER_NAME_TIME_WINDOW_SECONDS = 5
    function ZO_SubtitleManager:OnShowSubtitle(messageType, speaker, message)
        self.previousSubtitle = self.currentSubtitle or self.previousSubtitle
        local subtitle = ZO_Subtitle:New(messageType, speaker, message)
        local showSpeakerName = true
        local currentTime = GetFrameTimeSeconds()
        local previousSubtitle = self.previousSubtitle
        if previousSubtitle and previousSubtitle:GetSpeakerName() == speaker then
            -- if the same person says something within 5 seconds of when the last subtitle would end
            -- then hide the speaker name
            if previousSubtitle:GetStartTime() + previousSubtitle:GetDisplayLength() + HIDE_SAME_SPEAKER_NAME_TIME_WINDOW_SECONDS >= currentTime then
                showSpeakerName = false
            end
        end
        local messageControl = self.messageText
        messageControl:SetText(subtitle:GetFormattedMessage(showSpeakerName))
        local r, g, b
        if showSpeakerName then
            r, g, b = ZO_NORMAL_TEXT:UnpackRGB()
        else
            r, g, b = ZO_SELECTED_TEXT:UnpackRGB()
        end
        messageControl:SetColor(r, g, b, self.messageText:GetAlpha())
        --resize the background to match the size of the text not the size of the label
        local width = messageControl:GetTextWidth()
        self.messageBackground:SetWidth(width)
        subtitle:SetStartTime(currentTime)
        self.currentSubtitle = subtitle
        self:FadeInSubtitle()
    end
end
function ZO_SubtitleManager:OnUpdate(currentMS)
    if self.currentSubtitle then
        local currentSeconds = currentMS / 1000.0
        if self.currentSubtitle:HasExpired(currentSeconds) then
            self.previousSubtitle = self.currentSubtitle
            self.currentSubtitle = nil
            self:FadeOutSubtitle()
        end
    end
end
    ZO_SUBTITLE_MANAGER = ZO_SubtitleManager:New(control)
end