annotate CyborgMMO7.lua @ 35:16b2ff47b6db

Added a conversion function to extract as much information as possible from old profiles.
author madcatzinc@35b17cf1-18cd-47ff-9ca3-31d6b526ef09
date Thu, 25 Apr 2013 01:31:36 +0000
parents 6ce173840e68
children 8fc4f8a25225
rev   line source
madcatzinc@13 1 --~ Warcraft Plugin for Cyborg MMO7
madcatzinc@0 2 --~ Filename: CyborgMMO7.lua
madcatzinc@0 3 --~ Description: Plugin entry point, String tables and other generic crap that I could not think to put anywhere else.
madcatzinc@0 4 --~ Copyright (C) 2012 Mad Catz Inc.
madcatzinc@0 5 --~ Author: Christopher Hooks
madcatzinc@0 6
madcatzinc@0 7 --~ This program is free software; you can redistribute it and/or
madcatzinc@0 8 --~ modify it under the terms of the GNU General Public License
madcatzinc@0 9 --~ as published by the Free Software Foundation; either version 2
madcatzinc@0 10 --~ of the License, or (at your option) any later version.
madcatzinc@0 11
madcatzinc@0 12 --~ This program is distributed in the hope that it will be useful,
madcatzinc@0 13 --~ but WITHOUT ANY WARRANTY; without even the implied warranty of
madcatzinc@0 14 --~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
madcatzinc@0 15 --~ GNU General Public License for more details.
madcatzinc@0 16
madcatzinc@0 17 --~ You should have received a copy of the GNU General Public License
madcatzinc@0 18 --~ along with this program; if not, write to the Free Software
madcatzinc@0 19 --~ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
madcatzinc@0 20
madcatzinc@4 21 function CyborgMMO_LoadStrings(self)
madcatzinc@15 22 -- CyborgMMO_DPrint("LoadStrings("..self:GetName()..") = "..CyborgMMO_StringTable[self:GetName()])
madcatzinc@13 23 self:SetText(CyborgMMO_StringTable[self:GetName()])
madcatzinc@0 24 end
madcatzinc@0 25
madcatzinc@20 26 local VarsLoaded = false
madcatzinc@20 27 local EnteredWorld = false
madcatzinc@20 28 local BindingsLoaded = false
madcatzinc@21 29 local SettingsLoaded = false
madcatzinc@20 30 local SaveName = GetRealmName().."_"..UnitName("player")
madcatzinc@21 31 local Settings = nil
madcatzinc@0 32
madcatzinc@0 33
madcatzinc@4 34 function CyborgMMO_MiniMapButtonReposition(pos)
madcatzinc@4 35 CyborgMMO_MiniMapFrame:SetPoint("TOPLEFT",
madcatzinc@0 36 "Minimap",
madcatzinc@0 37 "TOPLEFT",
madcatzinc@13 38 52 - (80 * cos(pos)),
madcatzinc@13 39 (80 * sin(pos)) - 52)
madcatzinc@0 40 end
madcatzinc@0 41
madcatzinc@0 42
madcatzinc@4 43 function CyborgMMO_MiniMapButtonOnUpdate()
madcatzinc@0 44
madcatzinc@0 45 local xpos,ypos = GetCursorPosition()
madcatzinc@0 46 local xmin,ymin = Minimap:GetLeft(), Minimap:GetBottom()
madcatzinc@0 47
madcatzinc@0 48 xpos = (xmin)-(xpos / UIParent:GetScale())
madcatzinc@0 49 ypos = (ypos/ UIParent:GetScale())-(ymin)
madcatzinc@0 50
madcatzinc@13 51 local degrees = math.deg(math.atan2(ypos, xpos))
madcatzinc@0 52
madcatzinc@13 53 while degrees < 0 do
madcatzinc@13 54 degrees = degrees + 360
madcatzinc@0 55 end
madcatzinc@0 56
madcatzinc@4 57 CyborgMMO_MiniMapButtonReposition(degrees)
madcatzinc@0 58 end
madcatzinc@0 59
madcatzinc@4 60 function CyborgMMO_MouseModeChange(mode)
madcatzinc@4 61 local MiniMapTexture = getglobal("CyborgMMO_MiniMapFrameButton_Icon")
madcatzinc@4 62 local MiniMapGlowTexture = getglobal("CyborgMMO_MiniMapFrameButton_IconGlow")
madcatzinc@13 63 local OpenButtonTexture = getglobal("CyborgMMO_OpenButtonPage".."OpenMainForm"):GetNormalTexture()
madcatzinc@13 64 local OpenButtonGlowTexture = getglobal("CyborgMMO_OpenButtonPage".."OpenMainForm"):GetHighlightTexture()
madcatzinc@13 65 if mode == 1 then
madcatzinc@0 66 MiniMapTexture:SetVertexColor(1,0,0,1)
madcatzinc@31 67 MiniMapGlowTexture:SetVertexColor(1,0.26,0.26,.75)
madcatzinc@13 68 OpenButtonTexture:SetVertexColor(1,0,0,0.75)
madcatzinc@31 69 OpenButtonGlowTexture:SetVertexColor(1,0.26,0.26,0.50)
madcatzinc@13 70 elseif mode == 2 then
madcatzinc@0 71 MiniMapTexture:SetVertexColor(0.07,0.22,1,1)
madcatzinc@13 72 MiniMapGlowTexture:SetVertexColor(0.13,0.56,1,.75)
madcatzinc@13 73 OpenButtonTexture:SetVertexColor(0.07,0.22,1,0.75)
madcatzinc@13 74 OpenButtonGlowTexture:SetVertexColor(0.13,0.56,1,0.5)
madcatzinc@13 75 elseif mode == 3 then
madcatzinc@0 76 MiniMapTexture:SetVertexColor(0.52,0.08,0.89,1)
madcatzinc@13 77 MiniMapGlowTexture:SetVertexColor(0.67,0.31,0.85,.75)
madcatzinc@13 78 OpenButtonTexture:SetVertexColor(0.52,0.08,0.89,0.75)
madcatzinc@13 79 OpenButtonGlowTexture:SetVertexColor(0.67,0.31,0.85,0.5)
madcatzinc@0 80 end
madcatzinc@0 81 end
madcatzinc@0 82
madcatzinc@4 83 function CyborgMMO_GetSaveData()
madcatzinc@32 84 assert(VarsLoaded)
madcatzinc@32 85 if not CyborgMMO7SaveData then
madcatzinc@32 86 CyborgMMO7SaveData = {}
madcatzinc@0 87 end
madcatzinc@34 88 return CyborgMMO7SaveData
madcatzinc@0 89 end
madcatzinc@0 90
madcatzinc@34 91 function CyborgMMO_SetRatSaveData(data)
madcatzinc@32 92 assert(VarsLoaded)
madcatzinc@34 93 local saveData = {}
madcatzinc@34 94 for mode=1,#data do
madcatzinc@34 95 saveData[mode] = {}
madcatzinc@34 96 for button=1,#data[mode] do
madcatzinc@34 97 if data[mode][button] then
madcatzinc@34 98 saveData[mode][button] = data[mode][button]:SaveData()
madcatzinc@34 99 end
madcatzinc@34 100 end
madcatzinc@34 101 end
madcatzinc@34 102 CyborgMMO_GetSaveData().Rat = saveData
madcatzinc@0 103 end
madcatzinc@0 104
madcatzinc@35 105 local function GetSpellID(name)
madcatzinc@35 106 local link = GetSpellLink(name)
madcatzinc@35 107 if link then
madcatzinc@35 108 local id = link:match('spell:(%d+)|')
madcatzinc@35 109 if id then
madcatzinc@35 110 return tonumber(id)
madcatzinc@35 111 end
madcatzinc@35 112 end
madcatzinc@35 113 end
madcatzinc@35 114
madcatzinc@35 115 local function ConvertOldRatData(oldData)
madcatzinc@35 116 local newData = {}
madcatzinc@35 117 for mode,modeData in ipairs(oldData) do
madcatzinc@35 118 newData[mode] = {}
madcatzinc@35 119 for button,buttonData in ipairs(modeData) do
madcatzinc@35 120 CyborgMMO_DPrint("converting mode:", mode, "button:", button)
madcatzinc@35 121 local type = buttonData.Type
madcatzinc@35 122 if type=='item' then
madcatzinc@35 123 -- not possible, the WowObject 'Type' field was overwritten by the item type
madcatzinc@35 124 elseif type=='macro' then
madcatzinc@35 125 local name = buttonData.Name
madcatzinc@35 126 newData[mode][button] = {
madcatzinc@35 127 type = type,
madcatzinc@35 128 detail = name,
madcatzinc@35 129 }
madcatzinc@35 130 elseif type=='spell' then
madcatzinc@35 131 local id = GetSpellID(buttonData.Name)
madcatzinc@35 132 CyborgMMO_DPrint("converting spell:", buttonData.Name, id)
madcatzinc@35 133 if id then
madcatzinc@35 134 newData[mode][button] = {
madcatzinc@35 135 type = type,
madcatzinc@35 136 detail = id,
madcatzinc@35 137 }
madcatzinc@35 138 end
madcatzinc@35 139 elseif type=='petaction' then
madcatzinc@35 140 -- no longer supported
madcatzinc@35 141 elseif type=='merchant' then
madcatzinc@35 142 -- no longer supported
madcatzinc@35 143 elseif type=='companion' then
madcatzinc@35 144 local id = GetSpellID(buttonData.Name)
madcatzinc@35 145 CyborgMMO_DPrint("converting companion:", buttonData.Name, id)
madcatzinc@35 146 if id then
madcatzinc@35 147 newData[mode][button] = {
madcatzinc@35 148 type = type,
madcatzinc@35 149 detail = buttonData.Subdetail,
madcatzinc@35 150 subdetail = id,
madcatzinc@35 151 }
madcatzinc@35 152 end
madcatzinc@35 153 elseif type=='equipmentset' then
madcatzinc@35 154 CyborgMMO_DPrint("converting equipment set:", buttonData.Detail)
madcatzinc@35 155 newData[mode][button] = {
madcatzinc@35 156 type = type,
madcatzinc@35 157 detail = buttonData.Detail,
madcatzinc@35 158 }
madcatzinc@35 159 elseif type=='callback' then
madcatzinc@35 160 CyborgMMO_DPrint("converting callback:", buttonData.Detail)
madcatzinc@35 161 newData[mode][button] = {
madcatzinc@35 162 type = type,
madcatzinc@35 163 detail = buttonData.Detail,
madcatzinc@35 164 }
madcatzinc@35 165 elseif type then
madcatzinc@35 166 -- maybe it's an item type
madcatzinc@35 167 local id = buttonData.Detail
madcatzinc@35 168 local class = select(6, GetItemInfo(id)) -- :NOTE: this may fail if the item is not yet in the cache
madcatzinc@35 169 if class == type then
madcatzinc@35 170 CyborgMMO_DPrint("converting item:", id, type, class)
madcatzinc@35 171 newData[mode][button] = {
madcatzinc@35 172 type = "item",
madcatzinc@35 173 detail = id,
madcatzinc@35 174 }
madcatzinc@35 175 end
madcatzinc@35 176 else
madcatzinc@35 177 CyborgMMO_DPrint("cannot convert:", type)
madcatzinc@35 178 end
madcatzinc@35 179 end
madcatzinc@35 180 end
madcatzinc@35 181 return newData
madcatzinc@35 182 end
madcatzinc@35 183
madcatzinc@4 184 function CyborgMMO_Event(self, event, ...)
madcatzinc@13 185 if event == "VARIABLES_LOADED" then
madcatzinc@20 186 VarsLoaded = true
madcatzinc@35 187 -- convert old profile
madcatzinc@35 188 if CyborgMMO7SaveData[SaveName] and not CyborgMMO7SaveData.Settings then
madcatzinc@35 189 local oldData = CyborgMMO7SaveData[SaveName]
madcatzinc@35 190 CyborgMMO7SaveData = {}
madcatzinc@35 191 CyborgMMO7SaveData.Settings = oldData.Settings
madcatzinc@35 192 CyborgMMO7SaveData.Rat = ConvertOldRatData(oldData.Rat)
madcatzinc@35 193 CyborgMMO7SaveData[SaveName] = oldData -- for now keep the data, we may have missed something in the conversion
madcatzinc@35 194 end
madcatzinc@13 195 elseif event == "PLAYER_ENTERING_WORLD" then
madcatzinc@20 196 EnteredWorld = true
madcatzinc@19 197 elseif event == "PLAYER_REGEN_DISABLED" then
madcatzinc@13 198 CyborgMMO_Close()
madcatzinc@0 199 else
madcatzinc@15 200 CyborgMMO_DPrint("Event is "..tostring(event))
madcatzinc@13 201 end
madcatzinc@0 202
madcatzinc@0 203 -- Fire Loading if and only if the player is in the world and vars are loaded
madcatzinc@20 204 if not BindingsLoaded and VarsLoaded and EnteredWorld then
madcatzinc@20 205 local data = CyborgMMO_GetSaveData()
madcatzinc@0 206
madcatzinc@20 207 CyborgMMO_RatPageModel:LoadData()
madcatzinc@20 208 BindingsLoaded = true
madcatzinc@0 209
madcatzinc@20 210 CyborgMMO_SetupModeCallbacks(1)
madcatzinc@20 211 CyborgMMO_SetupModeCallbacks(2)
madcatzinc@20 212 CyborgMMO_SetupModeCallbacks(3)
madcatzinc@0 213
madcatzinc@21 214 Settings = data.Settings
madcatzinc@21 215 if not Settings then
madcatzinc@21 216 Settings = {}
madcatzinc@21 217 Settings.Cyborg = 0.75
madcatzinc@21 218 Settings.Plugin = 0.75
madcatzinc@21 219 Settings.MiniMapButton = true
madcatzinc@21 220 Settings.CyborgButton = true
madcatzinc@21 221 data.Settings = Settings
madcatzinc@21 222 end
madcatzinc@21 223 SettingsLoaded = true
madcatzinc@0 224
madcatzinc@21 225 -- Reload Slider values:
madcatzinc@21 226 CyborgMMO_SetOpenButtonSize(Settings.Cyborg)
madcatzinc@21 227 CyborgMMO_SetMainPageSize(Settings.Plugin)
madcatzinc@0 228
madcatzinc@21 229 CyborgMMO_SetMiniMapButton(Settings.MiniMapButton)
madcatzinc@21 230 CyborgMMO_SetCyborgHeadButton(Settings.CyborgButton)
madcatzinc@0 231
madcatzinc@20 232 local xmin,ymin = Minimap:GetLeft(),Minimap:GetBottom()
madcatzinc@20 233 CyborgMMO_MiniMapButtonReposition(math.deg(math.atan2(ymin, xmin)))
madcatzinc@20 234 -- Close the main window for now
madcatzinc@20 235 CyborgMMO_Close()
madcatzinc@0 236 end
madcatzinc@0 237 end
madcatzinc@0 238
madcatzinc@4 239 function CyborgMMO_SetDefaultSettings()
madcatzinc@13 240 CyborgMMO_OpenButtonPageOpenMainForm:ClearAllPoints()
madcatzinc@13 241 CyborgMMO_MainPage:ClearAllPoints()
madcatzinc@13 242 CyborgMMO_OpenButtonPageOpenMainForm:SetPoint("LEFT", UIParent, "LEFT", 0, 0)
madcatzinc@13 243 CyborgMMO_MainPage:SetPoint("LEFT", UIParent, "LEFT", 0, 0)
madcatzinc@0 244
madcatzinc@13 245 CyborgMMO_SetOpenButtonSize(0.75)
madcatzinc@13 246 CyborgMMO_SetMainPageSize(0.75)
madcatzinc@13 247 CyborgMMO_SetMiniMapButton(true)
madcatzinc@13 248 CyborgMMO_SetCyborgHeadButton(true)
madcatzinc@0 249 end
madcatzinc@0 250
madcatzinc@0 251
madcatzinc@4 252 function CyborgMMO_SetupModeCallbacks(modeNum)
madcatzinc@23 253 local fn = function()
madcatzinc@13 254 CyborgMMO_MouseModeChange(modeNum)
madcatzinc@18 255 CyborgMMO_RatPageModel:SetMode(modeNum)
madcatzinc@0 256 end
madcatzinc@0 257
madcatzinc@23 258 local buttonFrame,parentFrame,name = CyborgMMO_CallbackFactory:AddCallback(fn)
madcatzinc@16 259 SetOverrideBindingClick(parentFrame, true, CyborgMMO_Mode[modeNum], name, "LeftButton")
madcatzinc@0 260 end
madcatzinc@0 261
madcatzinc@4 262 function CyborgMMO_Loaded()
madcatzinc@13 263 CyborgMMO_MainPage:RegisterEvent("VARIABLES_LOADED")
madcatzinc@13 264 CyborgMMO_MainPage:RegisterEvent("PLAYER_ENTERING_WORLD")
madcatzinc@19 265 CyborgMMO_MainPage:RegisterEvent("PLAYER_REGEN_DISABLED")
madcatzinc@0 266 end
madcatzinc@0 267
madcatzinc@4 268 function CyborgMMO_Close()
madcatzinc@13 269 CyborgMMO_MainPage:Hide()
madcatzinc@0 270 end
madcatzinc@0 271
madcatzinc@4 272 function CyborgMMO_Open()
madcatzinc@13 273 CyborgMMO_MainPage:Show()
madcatzinc@13 274 CyborgMMO_RatQuickPage:Hide()
madcatzinc@0 275 end
madcatzinc@0 276
madcatzinc@4 277 function CyborgMMO_IsOpen()
madcatzinc@13 278 if CyborgMMO_MainPage:IsVisible() == 1 then
madcatzinc@13 279 return true
madcatzinc@0 280 else
madcatzinc@13 281 return false
madcatzinc@0 282 end
madcatzinc@0 283 end
madcatzinc@0 284
madcatzinc@4 285 function CyborgMMO_Toggle()
madcatzinc@13 286 if CyborgMMO_IsOpen() then
madcatzinc@13 287 CyborgMMO_Close()
madcatzinc@0 288 else
madcatzinc@13 289 CyborgMMO_Open()
madcatzinc@0 290 end
madcatzinc@0 291 end
madcatzinc@0 292
madcatzinc@15 293 function CyborgMMO_GetDebugFrame()
madcatzinc@15 294 for i=1,NUM_CHAT_WINDOWS do
madcatzinc@15 295 local windowName = GetChatWindowInfo(i);
madcatzinc@15 296 if windowName == "Debug" then
madcatzinc@15 297 return getglobal("ChatFrame" .. i)
madcatzinc@15 298 end
madcatzinc@15 299 end
madcatzinc@15 300 end
madcatzinc@15 301
madcatzinc@15 302 local log_prefix = "|cffff6666".."CyborgMMO".."|r:"
madcatzinc@15 303
madcatzinc@15 304 function CyborgMMO_DPrint(...)
madcatzinc@15 305 local debugframe = CyborgMMO_GetDebugFrame()
madcatzinc@15 306 if debugframe then
madcatzinc@15 307 local t = {log_prefix, ...}
madcatzinc@15 308 for i=1,select('#', ...)+1 do
madcatzinc@15 309 t[i] = tostring(t[i])
madcatzinc@15 310 end
madcatzinc@15 311 debugframe:AddMessage(table.concat(t, ' '))
madcatzinc@15 312 end
madcatzinc@0 313 end
madcatzinc@0 314
madcatzinc@4 315 function CyborgMMO_SetMainPageSize(percent)
madcatzinc@21 316 CyborgMMO_MainPage:SetScale(percent)
madcatzinc@21 317 CyborgMMO_OptionPagePluginSizeSlider:SetValue(percent)
madcatzinc@21 318 if BindingsLoaded then
madcatzinc@21 319 Settings.Plugin = percent
madcatzinc@0 320 end
madcatzinc@0 321 end
madcatzinc@0 322
madcatzinc@4 323 function CyborgMMO_SetOpenButtonSize(percent)
madcatzinc@21 324 CyborgMMO_OpenButtonPage:SetScale(percent)
madcatzinc@21 325 CyborgMMO_OptionPageCyborgSizeSlider:SetValue(percent)
madcatzinc@21 326 if SettingsLoaded then
madcatzinc@21 327 Settings.Cyborg = percent
madcatzinc@0 328 end
madcatzinc@0 329 end
madcatzinc@0 330
madcatzinc@21 331 function CyborgMMO_SetCyborgHeadButton(visible)
madcatzinc@21 332 if visible then
madcatzinc@21 333 CyborgMMO_OpenButtonPage:Show()
madcatzinc@0 334 else
madcatzinc@13 335 CyborgMMO_OpenButtonPage:Hide()
madcatzinc@0 336 end
madcatzinc@21 337 CyborgMMO_OptionPageCyborgButton:SetChecked(visible)
madcatzinc@21 338 if SettingsLoaded then
madcatzinc@21 339 Settings.CyborgButton = visible
madcatzinc@21 340 end
madcatzinc@0 341 end
madcatzinc@0 342
madcatzinc@21 343 function CyborgMMO_SetMiniMapButton(visible)
madcatzinc@21 344 if visible then
madcatzinc@4 345 CyborgMMO_MiniMapFrameButton:Show()
madcatzinc@0 346 else
madcatzinc@4 347 CyborgMMO_MiniMapFrameButton:Hide()
madcatzinc@0 348 end
madcatzinc@21 349 CyborgMMO_OptionPageMiniMapButton:SetChecked(visible)
madcatzinc@21 350 if SettingsLoaded then
madcatzinc@21 351 Settings.MiniMapButton = visible
madcatzinc@21 352 end
madcatzinc@0 353 end
madcatzinc@0 354