Mercurial > wow > cyborg-mmo7
view WowObjects.lua @ 34:6ce173840e68
Reworked the whole "wow object" system:
- Only save what is strictly necessary.
- Save appropriate persistent information for all objects (like spellIDs instead of spellBook+spellIndex).
- Fixed Battle Pets objects (non-combat pets in pre-MoP).
- Fixed item objects.
- Cleaned and simplified most objects implementation.
- Moved the settings and button profile to the root of the saved data, rather than in a per-character sub-table (that data is already tagged as saved per character).
This should fix most issues with objects changing without user interaction on diverse occasions.
Old profiles are not converted to the new system. This will come soon.
Some issues persist due to the asynchronous loading of some informations:
- Pet icons are never properly loaded from saved data.
- Items are not properly loaded the first time the UI is started (a "/reload ui" or disconnect/connect cycle fixes this problem).
author | madcatzinc@35b17cf1-18cd-47ff-9ca3-31d6b526ef09 |
---|---|
date | Thu, 25 Apr 2013 01:31:31 +0000 |
parents | 1c0af1810e06 |
children | d12a5a7d2be5 |
line wrap: on
line source
--~ Warcraft Plugin for Cyborg MMO7 --~ Filename: WowObjects.lua --~ Description: Warcraft in game object models --~ Copyright (C) 2012 Mad Catz Inc. --~ Author: Christopher Hooks --~ This program is free software; you can redistribute it and/or --~ modify it under the terms of the GNU General Public License --~ as published by the Free Software Foundation; either version 2 --~ of the License, or (at your option) any later version. --~ This program is distributed in the hope that it will be useful, --~ but WITHOUT ANY WARRANTY; without even the implied warranty of --~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the --~ GNU General Public License for more details. --~ You should have received a copy of the GNU General Public License --~ along with this program; if not, write to the Free Software --~ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. ------------------------------------------------------------------------------ local WowObject_methods = {} local WowObject_mt = {__index=WowObject_methods} local function WowObject(type, detail, subdetail) local self = {} self.type = type self.detail = detail self.subdetail = subdetail setmetatable(self, WowObject_mt) return self end function WowObject_methods:SaveData() return { type = self.type, detail = self.detail, subdetail = self.subdetail, } end function WowObject_methods:DoAction() CyborgMMO_DPrint("Nothing To Do") end function WowObject_methods:Pickup() CyborgMMO_DPrint("Pick up Item") end function WowObject_methods:SetBinding(key) end ------------------------------------------------------------------------------ local WowCallback_methods = setmetatable({}, {__index=WowObject_methods}) local WowCallback_mt = {__index=WowCallback_methods} local function WowCallback(callbackName) local self = WowObject("callback", callbackName, "") self.callbackName = callbackName self.texture = "Interface\\AddOns\\CyborgMMO7\\Graphics\\"..self.callbackName.."Unselected.tga" setmetatable(self, WowCallback_mt) return self end function WowCallback_methods:SetTextures(buttonFrame) buttonFrame:SetNormalTexture("Interface\\AddOns\\CyborgMMO7\\Graphics\\"..self.callbackName.."Unselected.tga") buttonFrame:SetPushedTexture("Interface\\AddOns\\CyborgMMO7\\Graphics\\"..self.callbackName.."Down.tga") buttonFrame:SetHighlightTexture("Interface\\AddOns\\CyborgMMO7\\Graphics\\"..self.callbackName.."Over.tga") end function WowCallback_methods:DoAction() local action = CyborgMMO_CallbackFactory:GetCallback(self.callbackName) action() end function WowCallback_methods:PickupCallback() local slot = nil local observers = CyborgMMO_RatPageModel:GetAllObservers() for i=1,#observers do if MouseIsOver(observers[i]) then slot = observers[i] break end end slot:SetNormalTexture(slot.UnCheckedTexture) end function WowCallback_methods:Pickup() PlaySound("igAbilityIconDrop") ClearCursor() self:PickupCallback() end function WowCallback_methods:SetBinding(key) local buttonFrame,parentFrame,name = CyborgMMO_CallbackFactory:AddCallback(function(...) return self:DoAction(...) end) SetOverrideBindingClick(CyborgMMO_CallbackFactory.Frame, true, key, name, "LeftButton") end ------------------------------------------------------------------------------ local WowItem_methods = setmetatable({}, {__index=WowObject_methods}) local WowItem_mt = {__index=WowItem_methods} local function WowItem(itemID) local self = WowObject("item", itemID) self.itemID = itemID self.texture = select(10, GetItemInfo(itemID)) -- :FIXME: this may fail too early in the session (like when loading saved data) setmetatable(self, WowItem_mt) return self end function WowItem_methods:Pickup() -- PlaySound("igAbilityIconDrop") ClearCursor() -- SetCursor(self.texture) return PickupItem(self.itemID) end function WowItem_methods:SetBinding(key) local name = GetItemInfo(self.itemID) SetOverrideBindingItem(CyborgMMO_CallbackFactory.Frame, true, key, name) end ------------------------------------------------------------------------------ local WowSpell_methods = setmetatable({}, {__index=WowObject_methods}) local WowSpell_mt = {__index=WowSpell_methods} local function WowSpell(spellID) local self = WowObject("spell", spellID) self.spellID = spellID self.texture = GetSpellTexture(spellID) setmetatable(self, WowSpell_mt) return self end function WowSpell_methods:DoAction() CyborgMMO_DPrint("Cast Spell") end function WowSpell_methods:Pickup() -- PlaySound("igAbilityIconDrop") ClearCursor() -- SetCursor(self.texture) -- return PickupSpellBookItem(self.SpellbookID, self.Spellbook) return PickupSpell(self.spellID) end function WowSpell_methods:SetBinding(key) -- CyborgMMO_DPrint("Binding to key "..key) local name = GetSpellInfo(self.spellID) CyborgMMO_DPrint("binding spell:", self.spellID, name) SetOverrideBindingSpell(CyborgMMO_CallbackFactory.Frame, true, key, name) end ------------------------------------------------------------------------------ local WowMacro_methods = setmetatable({}, {__index=WowObject_methods}) local WowMacro_mt = {__index=WowMacro_methods} local function WowMacro(name) local self = WowObject("macro", name) self.name = name self.texture = select(2, GetMacroInfo(name)) setmetatable(self, WowMacro_mt) return self end function WowMacro_methods:DoAction() CyborgMMO_DPrint("Use Item") end function WowMacro_methods:Pickup() -- PlaySound("igAbilityIconDrop") ClearCursor() -- SetCursor(self.texture) return PickupMacro(self.name) end function WowMacro_methods:SetBinding(key) SetOverrideBindingMacro(CyborgMMO_CallbackFactory.Frame, true, key, self.name) end ------------------------------------------------------------------------------ local WowCompanion_methods = setmetatable({}, {__index=WowObject_methods}) local WowCompanion_mt = {__index=WowCompanion_methods} local function WowCompanion(spellID) local self = WowObject("companion", spellID) CyborgMMO_DPrint("creating companion binding:", type, spellID) self.spellID = spellID self.texture = select(3, GetSpellInfo(spellID)) setmetatable(self, WowCompanion_mt) return self end local function IdentifyCompanion(spellID) for _,subtype in ipairs{'MOUNT', 'CRITTER'} do for index=1,GetNumCompanions(subtype) do local spellID2,_,active = select(3, GetCompanionInfo(subtype, index)) if spellID2 == spellID then return subtype,index,active end end end end function WowCompanion_methods:DoAction() local subtype,index,active = IdentifyCompanion(self.spellID) -- if subtype == "MOUNT" and IsMounted() then if subtype == "MOUNT" and active then Dismount() elseif subtype and index then CallCompanion(subtype, index) end end function WowCompanion_methods:Pickup() -- PlaySound("igAbilityIconDrop") local subtype,index = IdentifyCompanion(self.spellID) if subtype and index then return PickupCompanion(subtype, index) end end function WowCompanion_methods:SetBinding(key) local buttonFrame,parentFrame,name = CyborgMMO_CallbackFactory:AddCallback(function() self:DoAction() end) SetOverrideBindingClick(parentFrame, true, key, name, "LeftButton") end ------------------------------------------------------------------------------ local WowEquipmentSet_methods = setmetatable({}, {__index=WowObject_methods}) local WowEquipmentSet_mt = {__index=WowEquipmentSet_methods} local function WowEquipmentSet(name) local self = WowObject("equipmentset", name) self.name = name local texture = GetEquipmentSetInfoByName(name) self.texture = "Interface\\Icons\\"..texture setmetatable(self, WowEquipmentSet_mt) return self end function WowEquipmentSet_methods:DoAction() UseEquipmentSet(self.name) end function WowEquipmentSet_methods:Pickup() -- PlaySound("igAbilityIconDrop") ClearCursor() -- SetCursor(self.texture) return PickupEquipmentSetByName(self.Name) end function WowEquipmentSet_methods:SetBinding(key) local buttonFrame,parentFrame,name = CyborgMMO_CallbackFactory:AddCallback(function() self:DoAction() end) SetOverrideBindingClick(parentFrame, true, key, name, "LeftButton") end ------------------------------------------------------------------------------ local WowBattlePet_methods = setmetatable({}, {__index=WowObject_methods}) local WowBattlePet_mt = {__index=WowBattlePet_methods} local function WowBattlePet(petID) local self = WowObject("battlepet", petID) CyborgMMO_DPrint("creating battle pet binding:", petID) self.petID = petID self.texture = select(9, C_PetJournal.GetPetInfoByPetID(petID)) -- :FIXME: this may fail too early in the session (like when loading saved data) setmetatable(self, WowBattlePet_mt) return self end --[[ local function IdentifyPet(petID) local creatureID = select(11, C_PetJournal.GetPetInfoByPetID(petID)) for index=1,GetNumCompanions('CRITTER') do local creatureID2,_,spellID = GetCompanionInfo('CRITTER', index) if creatureID2 == creatureID then return spellID end end end --]] function WowBattlePet_methods:DoAction() -- PlaySound("igMainMenuOptionCheckBoxOn") C_PetJournal.SummonPetByGUID(self.petID) end function WowBattlePet_methods:Pickup() -- PlaySound("igAbilityIconDrop") return C_PetJournal.PickupPet(self.petID) end function WowBattlePet_methods:SetBinding(key) local buttonFrame,parentFrame,name = CyborgMMO_CallbackFactory:AddCallback(function() self:DoAction() end) SetOverrideBindingClick(parentFrame, true, key, name, "LeftButton") end ------------------------------------------------------------------------------ -- this class is used by pre-defined icons in the corner of the Rat page CyborgMMO_CallbackIcons = { new = function(self) self.point, self.relativeTo, self.relativePoint, self.xOfs, self.yOfs = self:GetPoint() -- self:SetPoint(self.point, self.relativeTo, self.relativePoint, self.xOfs, self.yOfs) self.strata = self:GetFrameStrata() self.wowObject = WowCallback(string.gsub(self:GetName(), self:GetParent():GetName(), "",1)) self.wowObject:SetTextures(self) self:RegisterForDrag("LeftButton","RightButton") self:SetResizable(false) self.OnClick = function() self.wowObject:DoAction() end self.DragStart = function() self:SetMovable(true) self:StartMoving() self.isMoving = true self:SetFrameStrata("TOOLTIP") end self.DragStop = function() self:SetFrameStrata(self.strata) self.isMoving = false self:SetMovable(false) self:StopMovingOrSizing() self:ClearAllPoints() self:SetPoint(self.point, self.relativeTo, self.relativePoint, self.xOfs, self.yOfs) local x,y = GetCursorPosition() CyborgMMO_RatPageController:CallbackDropped(self) end return self end, } ------------------------------------------------------------------------------ function CyborgMMO_CreateWowObject(type, ...) local object if type == "item" then -- :KLUDGE: if the item is not in the cache, return an empty WowObject local id = ... if not GetItemInfo(id) then object = WowObject() else object = WowItem(...) end elseif type == "macro" then object = WowMacro(...) elseif type == "spell" then object = WowSpell(...) elseif type == "companion" then object = WowCompanion(...) elseif type == "equipmentset" then object = WowEquipmentSet(...) elseif type == "battlepet" then object = WowBattlePet(...) elseif type == "callback" then object = WowCallback(...) else object = WowObject(type, ...) end return object end function CyborgMMO_ClearBinding(key) SetOverrideBinding(CyborgMMO_CallbackFactory.Frame, true, key, nil) end