petcharges.lua

--[[
Copyright © 2017, Sammeh of Quetzalcoatl
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of PetCharges nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL Sammeh BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
]]


_addon.name = 'PetCharges'
_addon.author = 'Sammeh, rjt'
_addon.version = '1.9'
_addon.command = 'petcharges'

config = require('config')
texts = require('texts')
res = require('resources')
packets = require('packets')

require('mob_families')


defaults = {}
defaults.options = {}
defaults.options.show_killer_effect = true
defaults.options.show_timer = true
defaults.options.show_bstpet_number = true
defaults.abilitytxt = {}
defaults.abilitytxt.bg = { alpha = 50 }
defaults.abilitytxt.pos = {}
defaults.abilitytxt.pos.x = -80
defaults.abilitytxt.pos.y = 45
defaults.abilitytxt.text = {}
defaults.abilitytxt.text.font = 'arial'
defaults.abilitytxt.text.size = 10
defaults.abilitytxt.text.stroke = { width = 1, alpha = 155, red = 0, green = 0, blue = 0 }
defaults.abilitytxt.padding = 4
defaults.abilitytxt.flags = {}
defaults.abilitytxt.flags.bold = false
defaults.abilitytxt.flags.right = true


settings = config.load(defaults)
abilities_list = texts.new('${value}', settings.abilitytxt)
pet_abilities = ""
equip_reduction = 0


function display_abilities()
    if pet then
        local list = "Charges: " .. charges
        -- add recharge timer if charges is not full
        if settings.options.show_timer and next_ready_recast > 0 and charges < 3 then
            list = list .. " [" .. string.format("%2.1f", next_ready_recast) .. "s]"
        end
        list = list .. ' \n'

        if settings.options.show_killer_effect then
            local killer_trait = get_pet_killer_trait(pet.name)
            if killer_trait then
                list = list .. killer_trait .. "\n"
            end
        end

        list = list .. pet_abilities

        abilities_list.value = list
        abilities_list:visible(true)
    else
        abilities_list:visible(false)
    end
end

-- can probably be removed
function move_textbox()
    -- check for existing mouse event.
    if mouse_evt then
        abilities_list:pos(settings.pos.x, settings.pos.y)
        windower.unregister_event(mouse_evt)
        mouse_evt = nil
    else
        windower.add_to_chat(144,
            "PetCharges: Move the mouse to change the location of PetCharges, click to set the position.")
        -- register a new mouse event
        -- this will take over the mouse until mouse1 is clicked down
        mouse_evt = windower.register_event('mouse', function(type, x, y, delta, blocked)
            -- on mousemove and mouse 1 not down, move the textbox with the mouse
            if type == 0 then
                if settings.flags.right then
                    abilities_list:pos(x - windower.get_windower_settings().ui_x_res, y)
                else
                    abilities_list:pos(x, y)
                end
            elseif type == 1 then
                windower.add_to_chat(144, 'PetCharges: New textbox position set.')
                -- on mouse1 down, end movement and save the location. kill this event
                if settings.flags.right then
                    settings.pos.x = x - windower.get_windower_settings().ui_x_res
                    settings.pos.y = y
                else
                    settings.pos.x = x
                    settings.pos.y = y
                end

                config.save(settings)

                windower.unregister_event(mouse_evt)
                mouse_evt = nil
            end
        end)
    end
end

function update_job_data()
    self = windower.ffxi.get_player()
    if self then
        if self.job_points.bst.jp_spent >= 100 then
            jobpoints = 5
        else
            jobpoints = 0
        end
        merits = self.merits.sic_recast
        pet = windower.ffxi.get_mob_by_target('pet') or nil
        abilitylist = windower.ffxi.get_abilities().job_abilities
        build_pet_string()
        display_abilities()
    end
end

function delay_update_job_data()
    coroutine.sleep(2)
    update_job_data()
end

function build_pet_string()
    pet_abilities = ""
    update_duration()
    if pet then
        local bstpet_number = 1
        for key, ability in pairs(abilitylist) do
            ability_en = res.job_abilities[ability].en
            ability_type = res.job_abilities[ability].type
            ability_targets = res.job_abilities[ability].targets
            ability_charges = res.job_abilities[ability].mp_cost
            local bstpet_prefix = settings.options.show_bstpet_number and string.format("[%d]", bstpet_number) or ""
            if ability_targets.Self == true and ability_type == 'Monster' then
                if charges >= ability_charges then
                    pet_abilities = pet_abilities ..
                        bstpet_prefix .. ' \\cs(0,255,0)' .. ability_en .. '\\cs(255,255,255)' .. ' \n'
                else
                    pet_abilities = pet_abilities .. bstpet_prefix .. ' \\cs(255,255,255)' .. ability_en .. ' \n'
                end
                bstpet_number = bstpet_number + 1
            end
        end
    end
end

function update_duration()
    duration = windower.ffxi.get_ability_recasts()[102]
    if duration then
        chargebase = (30 - ((merits or 0) * 2) - jobpoints - equip_reduction)
        charges = math.floor(((chargebase * 3) - duration) / chargebase)
        next_ready_recast = math.fmod(duration, chargebase)
    else
        chargebase = 0
        charges = 0
        next_ready_recast = 0
    end
end

windower.register_event('prerender', function()
    if self and self.main_job == 'BST' then
        update_duration()
        if duration then
            display_abilities()
        end
    end
end)


windower.register_event('outgoing chunk', function(id, data)
    if id == 0x01A then
        local packet = packets.parse('outgoing', data)
        local ability_used = packet.Param
        local category = packet.Category
        if res.job_abilities[ability_used] then
            if res.job_abilities[ability_used].type == 'Monster' and category == 9 then
                expect_ready_move = true
            end
        end
    end
end)

windower.register_event('incoming chunk', function(id, data)
    if id == 0x119 and expect_ready_move then
        local gear = windower.ffxi.get_items()
        local mainweapon = res.items[windower.ffxi.get_items(gear.equipment.main_bag, gear.equipment.main).id].en
        local subweapon = res.items[windower.ffxi.get_items(gear.equipment.sub_bag, gear.equipment.sub).id].en
        local legs = res.items[windower.ffxi.get_items(gear.equipment.legs_bag, gear.equipment.legs).id].en

        equip_reduction = 0
        if mainweapon == "Charmer's Merlin" or subweapon == "Charmer's Merlin" then
            equip_reduction = equip_reduction + 5
        end
        if legs == "Desultor Tassets" or legs == "Gleti's Breeches" then
            equip_reduction = equip_reduction + 5
        end
        expect_ready_move = false
    elseif id == 0x67 or id == 0x68 then
        update_job_data()
    elseif id == 0x44 then
        update_job_data()
    end
end)

windower.register_event('addon command', function(command)
    if command == 'save' then
        config.save(settings, 'all')
    elseif command == 'move' then
        move_textbox()
    elseif command == 'killer' then
        settings.options.show_killer_effect = not settings.options.show_killer_effect
        config.save(settings, 'all')
    elseif command == 'timer' then
        settings.options.show_timer = not settings.options.show_timer
        config.save(settings, 'all')
    elseif command == 'bstpet' then
        settings.options.show_bstpet_number = not settings.options.show_bstpet_number
        config.save(settings, 'all')
    end
end)

windower.register_event('load', delay_update_job_data)
windower.register_event('login', delay_update_job_data)
windower.register_event('zone change', delay_update_job_data)
windower.register_event('job change', update_job_data)