Ranger Gearswap 1/19/2014

-- Last Modified: 1/18/2014 5:00PM EST
-- Cleaned File up, Check https://github.com/Kinematics/GearSwap-Jobs/blob/master/Template.lua
-- Get the latest Mote-* files and examples from:
-- https://github.com/Kinematics/GearSwap-Jobs
-- for list of other functions that can be used.

-- === Some Notes On Sets ===
-- I don't have a PDT/MDT set configured in this file, but the stuff is there to be filled in as needed
-- Engaged does have a TP set, but nothing different is filled in. I only TP off ranged attacks.
--
-- I only use the Augmented (Trial 5004) Scout's Beret +2 for TP Build.
-- It's not much use for recycle since 90% is capped with Base + Merits + Manibozho gloves
-- Getting an extra 5TP/shot with fully Merited Recycle is more useful for the head
-- Thus why that's in the TP set.
--
-- WeaponSkill set automatically checks for a matching elemental belt or gorget in your inventory
-- You can adjust UserGlobals.lua to change the default belt/gorget used when no match can be equipped
-- If you leave default to blank "", It'll just keep whatever belt/neck you were using.
--
-- While there is a function to check for "Unlimited Shot" before using one of the special ammo
-- it does not protect from loss against multi-hit weaponskills (ie: Jishnu's Radiance being a 3-hit WS)

-- === In Precast ===
-- 1) Checks to make sure you're in an engaged state and have 100+ TP before firing a weaponskill
-- 2) Checks the distance to target to prevent WS from being fired when target is too far (prevents TP loss)
-- 3) Does not allow gear-swapping on weaponskills when Defense mode is enabled
-- 4) Checks to see of "Unlimited Shot" buff is on, if there's any special ammo defined in sets equipped
-- 5) Checks for empty ammo (or special without buff) and fills in the default ammunition for that weapon
--    ^ keeps empty if that ammo cannot be found, or there is no match to the weapon equipped
-- 6) Provides a low ammunition warning if current ammo in slot (counts all in inventory) is less than 15
--    ^ If you have 5 Tulfaire arrows in slot, but 20 also in inventory it see's it as 25 total

-- === In Post-Precast ===
-- If Sneak is active, sends the cancel command before Spectral Jig finish casting

-- === In Post-Midcast ===
-- If Barrage Buff is active, equips sets.BarrageMid

-- === In Buff Change ===
-- If Camouflage is active, disable body swaping
-- This is done to preserve the +100 Camouflage Duration given by Orion Jerkin

function get_sets()
    include('Mote-Include.lua')
    init_include()

    if define_global_sets then
        define_global_sets()
    end

    self_initialize()

    -- Default macro set/book
    set_macro_page(1, 20)

    binds_on_load()

    send_command('bind f9 gs c cycle RangedMode')
    send_command('bind ^f9 gs c cycle OffenseMode')
    send_command('bind !f9 gs c cycle WeaponskillMode')
end

function file_unload()
    binds_on_unload()
end

function self_initialize()
    -- Options: Override default values
    options.OffenseModes = {'Normal', 'Acc', 'TP'}
    options.RangedModes = {'Normal', 'Acc', 'TP'}
    options.DefenseModes = {'Normal', 'PDT'}
    options.WeaponskillModes = {'Normal', 'Acc'}
    options.PhysicalDefenseModes = {'PDT'}
    options.MagicalDefenseModes = {'MDT'}
    state.Defense.PhysicalMode = 'PDT'

    -- Misc. Job Ability precasts
    sets.precast.Step = {ear2="Choreia Earring"}
    sets.precast.JA['Bounty Shot'] = {hands="Sylvan Glovelettes +2"}
    sets.precast.JA['Scavenge'] = {feet="Orion Socks"}

    -- Idle Set (My 'base')
    sets.idle = {
        head="Orion Beret",neck="Twilight Torque",ear1="Volley Earring",ear2="Moonshade Earring",
        body="Orion Jerkin +1",hands="Manibozho Gloves",ring1="Dark Ring",ring2="Dark Ring",
        back="Shadow Mantle",waist="Scout's Belt",legs="Nahtirah Trousers",feet="Orion Socks"}

    -- Engaged sets
    sets.engaged = set_combine(sets.idle, {
        neck="Asperity Necklace",ear1="Steelflash Earring",ear2="Bladeborn Earring",
        ring1="K'ayres Ring",ring2="Rajas Ring",
        back="Sylvan Chlamys",waist="Hurch'lan Sash"})

    sets.engaged.Acc = set_combine(sets.engaged, {
        neck="Ej Necklace",
        hands="Buremte Gloves"})

    sets.engaged.TP = set_combine(sets.engaged, {
        })

    -- Ranged Attack
    sets.precast.Ranged = set_combine(sets.idle, {
        head="Sylvan Gapette +2",
        body="Sylvan Caban +2",hands="Iuitl Wristbands",
        waist="Impulse Belt",pants="Nahtirah Trousers",feet="Wurrukatte Boots"})

    sets.midcast.Ranged = set_combine(sets.idle, {
        neck="Ocachi Gorget",
        ring1="K'ayres Ring",ring2="Rajas Ring",
        back="Moondoe Mantle",waist="Scout's Belt"})

    sets.midcast.Ranged.Acc = set_combine(sets.midcast.Ranged, {
        neck="Ej Necklace",
        hands="Buremte Gloves",ring1="Paqichikaji Ring"})

    sets.midcast.Ranged.TP = set_combine(sets.midcast.Ranged, {
        head="Scout's Beret +2",back="Sylvan Chlamys"})

    -- Weaponskill sets

    sets.precast.WS = set_combine(sets.midcast.Ranged, {
        ear1="Clearview Earring",
        back="Sylvan Chlamys", waist=gear.ElementalBelt, neck=gear.ElementalGorget})

    sets.precast.WS.Acc = set_combine(sets.precast.WS, {
        neck="Ej Necklace",
        hands="Buremte Gloves",ring1="Paqichikaji Ring",
        back="Moondoe Mantle"})

    -- Resting sets
    sets.resting = {}

    -- Defense sets
    sets.defense.PDT = set_combine(sets.idle, {})
    sets.defense.MDT = set_combine(sets.idle, {})
    sets.Kiting = {feet="Fajin Boots"}

    -- Barrage Set
    sets.BarrageMid = set_combine(sets.midcast.Ranged.Acc, {
        hands="Orion Bracers"})

    -- List of ammunition that should only be used under unlimited shot
    U_Shot_Ammo = S{'Aeolus Arrow','Animikii Bullet','Crossbow Bolt'}

    -- Simply add a line of DefaultAmmo["Weapon"] = "Ammo Name"
    DefaultAmmo = {}
    DefaultAmmo["Eminent Gun"] = "Titanium Bullet"
    DefaultAmmo["Echidna's Bow"] = "Tulfaire Arrow"
    DefaultAmmo["Eminent Bow"] = "Tulfaire Arrow"
    DefaultAmmo["Eminent Crossbow"] = "Bloody Bolt"
    DefaultAmmo["Gandiva"] = "Tulfaire Arrow"

    -- List of all ranged WS that can be fired up to 21 yalms from target
    -- It excludes Cor-only WS, as well as the few short-ranged WS (blast arrow, etc)
    ranged_ws = S{"Flaming Arrow", "Piercing Arrow", "Dulling Arrow", "Sidewinder", "Arching Arrow",
    "Empyreal Arrow", "Refulgent Arrow", "Apex Arrow", "Namas Arrow", "Jishnu's Radiance", "Hot Shot",
    "Split Shot", "Sniper Shot", "Slug Shot", "Heavy Shot", "Detonator", "Last Stand",
    "Coronach", "Trueflight", "Wildfire"}
end

-- Set eventArgs.handled to true if we don't want any automatic gear equipping to be done.
-- Set eventArgs.useMidcastGear to true if we want midcast gear equipped on precast.

function job_precast(spell, action, spellMap, eventArgs)
    if spell.type:lower() == 'weaponskill' then
        if player.status ~= "Engaged" or player.tp < 100 then
            eventArgs.cancel = true
            return
        end
        if (spell.target.distance >8 and not ranged_ws[spell.name]) or (spell.target.distance >21) then
            -- Cancel Action if distance is too great, saving TP
            add_to_chat(122,"Distance too great for WeaponSkill /Canceling")
            eventArgs.cancel = true
            return
        elseif state.Defense.Active then
            -- Don't gearswap for weaponskills when Defense is on.
            eventArgs.handled = true
        end
    end

    if spell.name == "Ranged" or spell.type:lower() == 'weaponskill' then
        -- If ammo is empty, or special ammo being used without buff, replace with default ammo
        if U_Shot_Ammo[player.equipment.ammo] and not buffactive['unlimited shot'] or player.equipment.ammo == 'empty' then
            if DefaultAmmo[player.equipment.range] and player.inventory[DefaultAmmo[player.equipment.range]] then
                add_to_chat(122,"Unlimited Shot not Active or Ammo Empty, Using Default Ammo")
                equip({ammo=DefaultAmmo[player.equipment.range]})
            else
                add_to_chat(122,"Either Defaul Ammo is Unavailable or Unknown Weapon. Staying empty")
                equip({ammo=empty})
            end
        end
        if not buffactive['unlimited shot'] then
            -- If not empty, and if unlimited shot is not active
            -- Not doing it for unlimited shot to avoid excessive log
            if player.equipment.ammo ~= 'empty' then
                if player.inventory[player.equipment.ammo].count < 15 then
                    add_to_chat(122,"Ammo '"..player.inventory[player.equipment.ammo].shortname.."' running low ("..player.inventory[player.equipment.ammo].count..")")
                end
            end
        end
    end
end

-- Run after the default precast() is done.
-- eventArgs is the same one used in job_precast, in case information needs to be persisted.
-- This is where you place gear swaps you want in precast but applied on top of the precast sets
function job_post_precast(spell, action, spellMap, eventArgs)

    if spell.name == 'Spectral Jig' and buffactive.sneak then
        -- If sneak is active when using, cancel before completion
        send_command('cancel 71')
    end

end

-- Set eventArgs.handled to true if we don't want any automatic gear equipping to be done.
function job_midcast(spell, action, spellMap, eventArgs)

end

-- Run after the default midcast() is done.
-- eventArgs is the same one used in job_midcast, in case information needs to be persisted.
function job_post_midcast(spell, action, spellMap, eventArgs)
    if buffactive["Barrage"] then
        equip(sets.BarrageMid)
    end
end

-- Set eventArgs.handled to true if we don't want any automatic gear equipping to be done.
function job_aftercast(spell, action, spellMap, eventArgs)

end

-- Run after the default aftercast() is done.
-- eventArgs is the same one used in job_aftercast, in case information needs to be persisted.
function job_post_aftercast(spell, action, spellMap, eventArgs)

end

-- Called before the Include starts constructing melee/idle/resting sets.
-- Can customize state or custom melee class values at this point.
-- Set eventArgs.handled to true if we don't want any automatic gear equipping to be done.
function job_handle_equipping_gear(status, eventArgs)

end

function customize_idle_set(idleSet)
    return idleSet
end

function customize_melee_set(meleeSet)
    return meleeSet
end

function job_status_change(newStatus, oldStatus, eventArgs)

end

-- Called when a player gains or loses a buff.
-- buff == buff gained or lost
-- gain == true if the buff was gained, false if it was lost.
function job_buff_change(buff, gain)
    if status == "Camouflage" then
        if gain_or_loss == "gain" then
            send_command('@wait .5;gs disable body')
        else
            enable('body')
        end
    end
end

-- Called for custom player commands.
function job_self_command(cmdParams, eventArgs)

end

-- Set eventArgs.handled to true if we don't want automatic equipping of gear.
function job_update(cmdParams, eventArgs)

end

-- Handle notifications of user state values being changed.
function job_state_change(stateField, newValue)

end

-- Set eventArgs.handled to true if we don't want the automatic display to be run.
function display_current_job_state(eventArgs)

end