annotate modules/VehicleExit.lua @ 177:5c01c0d3bf79

updated LibShowGrid reference
author Flick <flickerstreak@gmail.com>
date Wed, 20 Oct 2010 18:30:24 +0000
parents df68b5a40490
children e63aefb8a555
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@159 44 ReAction:RegisterBarType(L["Exit Vehicle Floater"],
flickerstreak@159 45 {
flickerstreak@159 46 type = moduleID ,
flickerstreak@159 47 defaultButtonSize = 36,
flickerstreak@159 48 defaultBarRows = 1,
flickerstreak@159 49 defaultBarCols = 1,
flickerstreak@159 50 defaultBarSpacing = 3
flickerstreak@159 51 })
flickerstreak@159 52 end
flickerstreak@159 53
flickerstreak@159 54 function module:OnDisable()
flickerstreak@159 55 ReAction:UnregisterBarType(L["Exit Vehicle Floater"])
flickerstreak@159 56 end
flickerstreak@159 57
flickerstreak@159 58 function module:OnCreateBar(event, bar, name)
flickerstreak@159 59 if bar.config.type == moduleID then
flickerstreak@159 60 self:OnRefreshBar(event, bar, name)
flickerstreak@159 61 end
flickerstreak@159 62 end
flickerstreak@159 63
flickerstreak@159 64 function module:OnRefreshBar(event, bar, name)
flickerstreak@159 65 if bar.config.type == moduleID then
flickerstreak@159 66 local profile = self.db.profile
flickerstreak@159 67 if profile.buttons[name] == nil then
flickerstreak@159 68 profile.buttons[name] = {}
flickerstreak@159 69 end
flickerstreak@159 70 local btnCfg = profile.buttons[name]
flickerstreak@159 71
flickerstreak@159 72 if profile.buttons[name] == nil then
flickerstreak@159 73 profile.buttons[name] = { }
flickerstreak@159 74 end
flickerstreak@159 75 if self.buttons[bar] == nil then
flickerstreak@159 76 local success, r = pcall(Button.New, Button, 1, profile.buttons[name], bar)
flickerstreak@159 77 if success and r then
flickerstreak@159 78 self.buttons[bar] = r
flickerstreak@159 79 bar:AddButton(1,r)
flickerstreak@159 80 end
flickerstreak@159 81 else
flickerstreak@159 82 self.buttons[bar]:Refresh()
flickerstreak@159 83 end
flickerstreak@159 84 bar:ClipNButtons(1)
flickerstreak@159 85 self:UpdateRegistration(bar)
flickerstreak@159 86 end
flickerstreak@159 87 end
flickerstreak@159 88
flickerstreak@159 89 function module:OnDestroyBar(event, bar, name)
flickerstreak@159 90 if self.buttons[bar] then
flickerstreak@159 91 self.buttons[bar]:Destroy()
flickerstreak@159 92 self.buttons[bar] = nil
flickerstreak@159 93 end
flickerstreak@159 94 end
flickerstreak@159 95
flickerstreak@159 96 function module:OnEraseBar(event, bar, name)
flickerstreak@159 97 self.db.profile.buttons[name] = nil
flickerstreak@159 98 end
flickerstreak@159 99
flickerstreak@159 100 function module:OnRenameBar(event, bar, oldname, newname)
flickerstreak@159 101 local b = self.db.profile.buttons
flickerstreak@159 102 b[newname], b[oldname] = b[oldname], nil
flickerstreak@159 103 end
flickerstreak@159 104
flickerstreak@159 105
flickerstreak@159 106 function module:UpdateRegistration(bar)
flickerstreak@159 107 -- auto show/hide when on a vehicle
flickerstreak@159 108 local config = self.db.profile.buttons[bar:GetName()]
flickerstreak@159 109 local f = bar:GetFrame()
flickerstreak@159 110 if config.withControls then
flickerstreak@159 111 if bar.vehicleExitStateRegistered then
flickerstreak@159 112 UnregisterStateDriver(f, "unitexists")
flickerstreak@159 113 bar.vehicleExitStateRegistered = false
flickerstreak@159 114 end
flickerstreak@159 115 bar:RegisterUnitWatch("vehicle",true)
flickerstreak@159 116 else
flickerstreak@159 117 bar:RegisterUnitWatch("vehicle",false)
flickerstreak@159 118 if not bar.vehicleExitStateRegistered then
flickerstreak@159 119 f:SetAttribute("unit","vehicle")
flickerstreak@165 120 RegisterStateDriver(f, "unitexists", "[target=vehicle,exists,novehicleui] show; hide") -- spoof onstate-unitexists
flickerstreak@159 121 bar.vehicleExitStateRegistered = true
flickerstreak@159 122 end
flickerstreak@159 123 end
flickerstreak@159 124 end
flickerstreak@159 125
flickerstreak@159 126 ---- Options ----
flickerstreak@159 127 local Handler = { }
flickerstreak@159 128 local meta = { __index = Handler }
flickerstreak@159 129
flickerstreak@159 130 function Handler:New(bar)
flickerstreak@159 131 return setmetatable(
flickerstreak@159 132 {
flickerstreak@159 133 bar = bar
flickerstreak@159 134 }, meta)
flickerstreak@159 135 end
flickerstreak@159 136
flickerstreak@159 137 function Handler:GetConfig()
flickerstreak@159 138 return module.db.profile.buttons[self.bar:GetName()]
flickerstreak@159 139 end
flickerstreak@159 140
flickerstreak@159 141 function Handler:GetPassengerOnly()
flickerstreak@159 142 return not self:GetConfig().withControls
flickerstreak@159 143 end
flickerstreak@159 144
flickerstreak@159 145 function Handler:SetPassengerOnly(info, value)
flickerstreak@159 146 self:GetConfig().withControls = not value
flickerstreak@159 147 module:UpdateRegistration(self.bar)
flickerstreak@159 148 end
flickerstreak@159 149
flickerstreak@159 150
flickerstreak@159 151 function module:GetBarOptions(bar)
flickerstreak@159 152 if bar.config.type == moduleID then
flickerstreak@159 153 return {
flickerstreak@159 154 type = "group",
flickerstreak@159 155 name = L["Exit Vehicle"],
flickerstreak@159 156 handler = Handler:New(bar),
flickerstreak@159 157 args = {
flickerstreak@159 158 passengerOnly = {
flickerstreak@159 159 name = L["Show only when passenger"],
flickerstreak@159 160 desc = L["Only show the button when riding as a passenger in a vehicle (no vehicle controls)"],
flickerstreak@159 161 order = 2,
flickerstreak@159 162 width = "double",
flickerstreak@159 163 type = "toggle",
flickerstreak@159 164 get = "GetPassengerOnly",
flickerstreak@159 165 set = "SetPassengerOnly",
flickerstreak@159 166 },
flickerstreak@159 167 }
flickerstreak@159 168 }
flickerstreak@159 169 end
flickerstreak@159 170 end
flickerstreak@159 171
flickerstreak@159 172