Back to Home

ESO Lua File v101035

libraries/zo_radialmenu/zo_radialmenucontroller.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
--[[
Radial Menu Controller Base class, requires the control passed in to have a child radial menu named "Menu".
Does basic initialization and provides callbacks / function overrides to populate the menu and interact with it.
]]
ZO_RadialMenuController = ZO_InitializingObject:Subclass()
function ZO_RadialMenuController:Initialize(control, entryTemplate, animationTemplate, entryAnimationTemplate, actionLayerNames)
    self.menuControl = control:GetNamedChild("Menu")
    self.menu = ZO_RadialMenu:New(self.menuControl, entryTemplate, animationTemplate, entryAnimationTemplate, actionLayerNames or "RadialMenu")
    local function SetupEntryControl(entryControl, data)
        self:SetupEntryControl(entryControl, data)
    end
    local function OnSelectionChangedCallback(selectedEntry)
        self:OnSelectionChangedCallback(selectedEntry)
    end
end
function ZO_RadialMenuController:ShowMenu()
    self.menu:Clear()
    self:PopulateMenu()
    self.menu:Show()
end
--override
function ZO_RadialMenuController:SetupEntryControl(control, data)
    -- Should be Overridden
end
function ZO_RadialMenuController:OnSelectionChangedCallback(selectedEntry)
    -- Should be Overridden
end
function ZO_RadialMenuController:PopulateMenu()
    -- Should be Overridden
end
--[[
Interactive Radial Menu Controller. This is the base class to use for in-game radial menus tied to keybinds where the user holds down a key/button to
bring up the radial menu for use. Releasing the key/button that opened the menu will close the menu and select the currently selected entry.
]]
local TIME_TO_HOLD_KEY_MS = 250
ZO_InteractiveRadialMenuController = ZO_RadialMenuController:Subclass()
function ZO_InteractiveRadialMenuController:Initialize(control, entryTemplate, animationTemplate, entryAnimationTemplate, actionLayerNames)
    ZO_RadialMenuController.Initialize(self, control, entryTemplate, animationTemplate, entryAnimationTemplate, actionLayerNames)
    control:SetHandler("OnUpdate", function() self:OnUpdate() end)
    self.menu:SetOnClearCallback(function() self:StopInteraction() end)
end
function ZO_InteractiveRadialMenuController:StartInteraction()
    if not self.isInteracting and not self.beginHold then
        if self:PrepareForInteraction() then
            self.beginHold = GetFrameTimeMilliseconds()
            return true
        end
    end
end
function ZO_InteractiveRadialMenuController:StopInteraction(clearSelection)
    local wasShowingRadial = self.beginHold == nil
    self.beginHold = nil
    if self.isInteracting then
        self.isInteracting = false
        LockCameraRotation(false)
        RETICLE:RequestHidden(false)
        if clearSelection then
            self.menu:ClearSelection()
        end
        self.menu:SelectCurrentEntry()
    end
    return wasShowingRadial
end
function ZO_InteractiveRadialMenuController:IsInteracting()
    return self.isInteracting
end
function ZO_InteractiveRadialMenuController:OnUpdate()
    if self.beginHold and GetFrameTimeMilliseconds() >= self.beginHold + TIME_TO_HOLD_KEY_MS then
        self.beginHold = nil
        if not self.isInteracting then
            self:ShowMenu()
        end
    end
    if self.isInteracting and IsInteracting() and GetInteractionType() ~= INTERACTION_HIDEYHOLE then
        self:StopInteraction()
    end
end
function ZO_InteractiveRadialMenuController:ShowMenu()
    ZO_RadialMenuController.ShowMenu(self)
    self.isInteracting = true
    LockCameraRotation(true)
    RETICLE:RequestHidden(true)
end
--override
function ZO_InteractiveRadialMenuController:PrepareForInteraction()
    return true
end
function ZO_InteractiveRadialMenuController:SetupEntryControl(control, data)
    -- Should be Overridden
end
function ZO_InteractiveRadialMenuController:OnSelectionChangedCallback(selectedEntry)
    -- Should be Overridden
end
function ZO_InteractiveRadialMenuController:PopulateMenu()
    -- Should be Overridden
end