Mercurial > wow > reaction

annotate modules/VehicleExit.lua @ 218:e63aefb8a555

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Demodularization of buttons - register class instead of config
author Flick <flickerstreak@gmail.com>
date Fri, 19 Nov 2010 23:06:24 -0800
parents df68b5a40490
children d08a74e86c96
rev   line source
flickerstreak@159 1 --[[
flickerstreak@159 2 ReAction Vehicle Exit button module
flickerstreak@159 3
flickerstreak@159 4 The button module implements a single button which you can use
flickerstreak@159 5 to exit a vehicle that doesn't have controls (replacement for
flickerstreak@159 6 MainMenuBarLeaveVehicleButton).
flickerstreak@159 7
flickerstreak@159 8 --]]
flickerstreak@159 9
flickerstreak@159 10 -- local imports
flickerstreak@175 11 local addonName, addonTable = ...
flickerstreak@175 12 local ReAction = addonTable.ReAction
flickerstreak@159 13 local L = ReAction.L
flickerstreak@159 14
flickerstreak@159 15 -- module declaration
flickerstreak@159 16 local moduleID = "VehicleExit"
flickerstreak@159 17 local module = ReAction:NewModule( moduleID )
flickerstreak@159 18
flickerstreak@159 19 -- Button class
flickerstreak@159 20 local Button = ReAction.Button.VehicleExit
flickerstreak@159 21
flickerstreak@159 22 -- module methods
flickerstreak@159 23 function module:OnInitialize()
flickerstreak@159 24 self.db = ReAction.db:RegisterNamespace( moduleID,
flickerstreak@159 25 {
flickerstreak@159 26 profile = {
flickerstreak@159 27 buttons = { }
flickerstreak@159 28 }
flickerstreak@159 29 }
flickerstreak@159 30 )
flickerstreak@159 31 self.registered = { }
flickerstreak@159 32 self.buttons = { }
flickerstreak@159 33
flickerstreak@159 34 ReAction:RegisterBarOptionGenerator(self, "GetBarOptions")
flickerstreak@159 35
flickerstreak@159 36 ReAction.RegisterCallback(self, "OnCreateBar")
flickerstreak@159 37 ReAction.RegisterCallback(self, "OnDestroyBar")
flickerstreak@159 38 ReAction.RegisterCallback(self, "OnRefreshBar")
flickerstreak@159 39 ReAction.RegisterCallback(self, "OnEraseBar")
flickerstreak@159 40 ReAction.RegisterCallback(self, "OnRenameBar")
flickerstreak@159 41 end
flickerstreak@159 42
flickerstreak@159 43 function module:OnEnable()
flickerstreak@218 44 ReAction:RegisterBarType(Button)
flickerstreak@159 45 end
flickerstreak@159 46
flickerstreak@159 47 function module:OnDisable()
flickerstreak@218 48 ReAction:UnregisterBarType(Button)
flickerstreak@159 49 end
flickerstreak@159 50
flickerstreak@159 51 function module:OnCreateBar(event, bar, name)
flickerstreak@159 52 if bar.config.type == moduleID then
flickerstreak@159 53 self:OnRefreshBar(event, bar, name)
flickerstreak@159 54 end
flickerstreak@159 55 end
flickerstreak@159 56
flickerstreak@159 57 function module:OnRefreshBar(event, bar, name)
flickerstreak@159 58 if bar.config.type == moduleID then
flickerstreak@159 59 local profile = self.db.profile
flickerstreak@159 60 if profile.buttons[name] == nil then
flickerstreak@159 61 profile.buttons[name] = {}
flickerstreak@159 62 end
flickerstreak@159 63 local btnCfg = profile.buttons[name]
flickerstreak@159 64
flickerstreak@159 65 if profile.buttons[name] == nil then
flickerstreak@159 66 profile.buttons[name] = { }
flickerstreak@159 67 end
flickerstreak@159 68 if self.buttons[bar] == nil then
flickerstreak@159 69 local success, r = pcall(Button.New, Button, 1, profile.buttons[name], bar)
flickerstreak@159 70 if success and r then
flickerstreak@159 71 self.buttons[bar] = r
flickerstreak@159 72 bar:AddButton(1,r)
flickerstreak@159 73 end
flickerstreak@159 74 else
flickerstreak@159 75 self.buttons[bar]:Refresh()
flickerstreak@159 76 end
flickerstreak@159 77 bar:ClipNButtons(1)
flickerstreak@159 78 self:UpdateRegistration(bar)
flickerstreak@159 79 end
flickerstreak@159 80 end
flickerstreak@159 81
flickerstreak@159 82 function module:OnDestroyBar(event, bar, name)
flickerstreak@159 83 if self.buttons[bar] then
flickerstreak@159 84 self.buttons[bar]:Destroy()
flickerstreak@159 85 self.buttons[bar] = nil
flickerstreak@159 86 end
flickerstreak@159 87 end
flickerstreak@159 88
flickerstreak@159 89 function module:OnEraseBar(event, bar, name)
flickerstreak@159 90 self.db.profile.buttons[name] = nil
flickerstreak@159 91 end
flickerstreak@159 92
flickerstreak@159 93 function module:OnRenameBar(event, bar, oldname, newname)
flickerstreak@159 94 local b = self.db.profile.buttons
flickerstreak@159 95 b[newname], b[oldname] = b[oldname], nil
flickerstreak@159 96 end
flickerstreak@159 97
flickerstreak@159 98
flickerstreak@159 99 function module:UpdateRegistration(bar)
flickerstreak@159 100 -- auto show/hide when on a vehicle
flickerstreak@159 101 local config = self.db.profile.buttons[bar:GetName()]
flickerstreak@159 102 local f = bar:GetFrame()
flickerstreak@159 103 if config.withControls then
flickerstreak@159 104 if bar.vehicleExitStateRegistered then
flickerstreak@159 105 UnregisterStateDriver(f, "unitexists")
flickerstreak@159 106 bar.vehicleExitStateRegistered = false
flickerstreak@159 107 end
flickerstreak@159 108 bar:RegisterUnitWatch("vehicle",true)
flickerstreak@159 109 else
flickerstreak@159 110 bar:RegisterUnitWatch("vehicle",false)
flickerstreak@159 111 if not bar.vehicleExitStateRegistered then
flickerstreak@159 112 f:SetAttribute("unit","vehicle")
flickerstreak@165 113 RegisterStateDriver(f, "unitexists", "[target=vehicle,exists,novehicleui] show; hide") -- spoof onstate-unitexists
flickerstreak@159 114 bar.vehicleExitStateRegistered = true
flickerstreak@159 115 end
flickerstreak@159 116 end
flickerstreak@159 117 end
flickerstreak@159 118
flickerstreak@159 119 ---- Options ----
flickerstreak@159 120 local Handler = { }
flickerstreak@159 121 local meta = { __index = Handler }
flickerstreak@159 122
flickerstreak@159 123 function Handler:New(bar)
flickerstreak@159 124 return setmetatable(
flickerstreak@159 125 {
flickerstreak@159 126 bar = bar
flickerstreak@159 127 }, meta)
flickerstreak@159 128 end
flickerstreak@159 129
flickerstreak@159 130 function Handler:GetConfig()
flickerstreak@159 131 return module.db.profile.buttons[self.bar:GetName()]
flickerstreak@159 132 end
flickerstreak@159 133
flickerstreak@159 134 function Handler:GetPassengerOnly()
flickerstreak@159 135 return not self:GetConfig().withControls
flickerstreak@159 136 end
flickerstreak@159 137
flickerstreak@159 138 function Handler:SetPassengerOnly(info, value)
flickerstreak@159 139 self:GetConfig().withControls = not value
flickerstreak@159 140 module:UpdateRegistration(self.bar)
flickerstreak@159 141 end
flickerstreak@159 142
flickerstreak@159 143
flickerstreak@159 144 function module:GetBarOptions(bar)
flickerstreak@159 145 if bar.config.type == moduleID then
flickerstreak@159 146 return {
flickerstreak@159 147 type = "group",
flickerstreak@159 148 name = L["Exit Vehicle"],
flickerstreak@159 149 handler = Handler:New(bar),
flickerstreak@159 150 args = {
flickerstreak@159 151 passengerOnly = {
flickerstreak@159 152 name = L["Show only when passenger"],
flickerstreak@159 153 desc = L["Only show the button when riding as a passenger in a vehicle (no vehicle controls)"],
flickerstreak@159 154 order = 2,
flickerstreak@159 155 width = "double",
flickerstreak@159 156 type = "toggle",
flickerstreak@159 157 get = "GetPassengerOnly",
flickerstreak@159 158 set = "SetPassengerOnly",
flickerstreak@159 159 },
flickerstreak@159 160 }
flickerstreak@159 161 }
flickerstreak@159 162 end
flickerstreak@159 163 end
flickerstreak@159 164
flickerstreak@159 165