Map Gatherer.lua

--[=====[
[[SND Metadata]]
author: 'pot0to (https://ko-fi.com/pot0to) || Updated by: Minnu'
version: 2.0.0
description: Short script to enable GBR and gather a map. Allows for multi-character gathering but will have to be manually edited to support.
plugin_dependencies:
- Gatherbuddy Reborn (And its dependencies) 
configs:
  MapName:
    description: The name of the map to be gathered (MUST MATCH THE MAP SET IN GBR)
    type: list
    choices: ["Timeworn Leather Map", "Timeworn Goatskin Map", "Timeworn Toadskin Map", "Timeworn Boarskin Map", "Timeworn Peisteskin Map", "Timeworn Archaeoskin Map", "Timeworn Wyvernskin Map", "Timeworn Dragonskin Map", "Timeworn Gaganaskin Map", "Timeworn Gazelleskin Map", "Timeworn Gliderskin Map", "Timeworn Zonureskin Map", "Timeworn Saigaskin Map", "Timeworn Kumbhiraskin Map", "Timeworn Ophiotauroskin Map", "Timeworn Loboskin Map", "Timeworn Br'aaxskin Map", "Timeworn Gargantuaskin Map"]
    is_choice: true
    required: true

[[End Metadata]]
--]=====]

--[[

********************************************************************************
*                               Map Gathering                                  * 
********************************************************************************

Created by: pot0to (https://ko-fi.com/pot0to)

Gathers a map, relogs as the next character in the list, mails them all to your
"friend", rinse and repeat. You will need to install Gather Buddy Reborn and add
your desired map to the auto gather list. This plugin only kicks off the gather
list and waits for the map to drop in your inventory, then stops the gathering
and relogs as the next character.

********************************************************************************
*                                    Version                                   *
*                                     0.1.2                                    *
********************************************************************************

0.1.2   Fixed state change between character swap and ready
0.1.1   Added code to support Delivery Moogle at Radz-at-Han (/tp radz)
0.1.0   Added ability to mail
0.0.10  Moved command to close gathering menu
0.0.9   Added checks to stop pathing and close gathering menus when ready to
            switch characters
0.0.8   Added ability to search entire timers list for map allowances, added
            other maps

********************************************************************************
*                               Required Plugins                               *
********************************************************************************
1. Vnavmesh
2. Gather Buddy Reborn - Create an autogather list with your desired map
3. Autoretainer
]]

--#region Settings

--[[
********************************************************************************
*                                   Settings                                   *
********************************************************************************
]]
yield("/xlenableplugin Gatherbuddy Reborn")
yield("/wait 5")
MapName = GetConfig("MapName") -- must match the map on your GBR list

Multimode = false
Characters =
{
{ characterName="John Doe", worldName="Excalibur" },
{ characterName="Jane Doe", worldName="Excalibur" }
}

Mail = false
    RecipientName = "John Doe"
    MailboxName = "Moogle Letter Box"       -- options: Moogle Letter Box, Regal Letter Box, Delivery Moogle
    MailboxTeleportCommand = "/li auto"     -- if you don't have a private home or fc, then "/tp radz" + Delivery Moogle will work

--#endregion Settings

--[[
********************************************************************************
*           Code: Don't touch this unless you know what you're doing           *
********************************************************************************
]]

TimewornMapIds = {
    -- ARR Maps
    {itemId=6688, itemName="Timeworn Leather Map"},
    {itemId=6689, itemName="Timeworn Goatskin Map"},
    {itemId=6690, itemName="Timeworn Toadskin Map"},
    {itemId=6691, itemName="Timeworn Boarskin Map"},
    {itemId=6692, itemName="Timeworn Peisteskin Map"},

    -- Heavensward Maps
    {itemId=12241, itemName="Timeworn Archaeoskin Map"},
    {itemId=12242, itemName="Timeworn Wyvernskin Map"},
    {itemId=12243, itemName="Timeworn Dragonskin Map"},
    
    -- Stormblood Maps
    {itemId=17835, itemName="Timeworn Gaganaskin Map"},
    {itemId=17836, itemName="Timeworn Gazelleskin Map"},

    -- Shadowbringers Maps
    {itemId=26744, itemName="Timeworn Gliderskin Map"},
    {itemId=26745, itemName="Timeworn Zonureskin Map"},
    
    -- Endwalker Maps
    {itemId=36611, itemName="Timeworn Saigaskin Map"},
    {itemId=36612, itemName="Timeworn Kumbhiraskin Map"},
    {itemId=39591, itemName="Timeworn Ophiotauroskin Map"},

    -- Dawntrail Maps
    {itemId=43556, itemName="Timeworn Loboskin Map"},
    {itemId=43557, itemName="Timeworn Br'aaxskin Map"}
    {itemId=46185, itemName="Timeworn Gargantuaskin Map"}
}

function GetMapInfo()
    for _, mapInfo in ipairs(TimewornMapIds) do
        if mapInfo.itemName == MapName then
            return mapInfo
        end
    end
end

function HasMapAllowance()
    if not Addons.GetAddon("ContentsInfo").Ready then
        yield("/timers")
        yield ("/wait 1")
    end
    for i = 41000, 41015 do
      local timerName =  Addons.GetAddon("ContentsInfo"):GetNode(1, 4, i, 6, 7).Text
      if timerName == nil then
      else
        if timerName == "Next Map Allowance" then
            yield("/echo Map Allowance is available!")
            return Addons.GetAddon("ContentsInfo"):GetNode(1, 4, i, 6, 8).Text == "Available Now"
        end
	  end
    end
    yield("/echo No record found...")
    return false
end

function Gather()
    yield("/echo gathering")
    if IPC.Lifestream.IsBusy() then
        return
    end

    if Inventory.GetItemCount(MapInfo.itemId) > 0 then
        yield("/echo Acquired map.")
        State = CharacterState.ready
        return
    end

    yield("/echo gathering")
    if not GBRAutoOn then
        yield("/gbr auto on")
        GBRAutoOn = true
    end
    yield("/wait 10")
end

--[[
function MailMap()
    if IPC.Lifestream.IsBusy() then
        return
    end

    yield("/echo mailing")
    if Inventory.GetItemCount(MapInfo.itemId) == 0 then
        if Addons.GetAddon("LetterList").Ready then
            yield("/callback LetterList true -1")
        end
        State = CharacterState.ready
        return
    end

    if Addons.GetAddon("SelectYesno").Ready then
        yield("/callback SelectYesno true 0")
        return
    end

    if Addons.GetAddon("LetterEditor").Ready then
        if MapAttached then
            --local dateString = os.date("%B %d, %Y", os.time(os.date("*t")))
            yield('/callback LetterEditor true 0 0 "'..RecipientName..'" "sending you a map" 0 0')
            return
        end

        -- search through every inventory slot until you find the map
        for inventoryPage=0,4 do
            for inventorySlot=0,34 do
                if (GetItemIdInSlot(inventoryPage, inventorySlot) == MapInfo.itemId) then
                    yield("/callback LetterEditor true 3 0 "..inventoryPage.." "..inventorySlot.." 0 0")
                    MapAttached = true
                    return
                end
            end
        end

        yield("/echo Could not find "..MapInfo.itemName.." in inventory.")
        State = CharacterState.ready
        return
    end

    if IsAddonVisible("LetterList") then
        yield("/callback LetterList true 1 0 0 0") -- click "New"
        return
    end

    yield("/target "..MailboxName)

    if HasTarget() and GetTargetName() == MailboxName then
        if GetDistanceToTarget() > 5 then
            PathfindAndMoveTo(GetTargetRawXPos(), GetTargetRawYPos(), GetTargetRawZPos(), false)

            repeat
                yield("/wait 1")
            until GetDistanceToTarget() <= 5
            yield("/vnav stop")
        end
        yield("/interact")
        return
    else
        yield(MailboxTeleportCommand)
        return
    end
end
--]]

function SwapCharacters()
    yield("/echo swapping")
    if GBRAutoOn then
        yield("/gbr auto off")
        GBRAutoOn = false
    end

    yield("/echo swapping characters")
    yield("/ays multi d")
    yield("/ays disable")
for i=1, #Characters do
if Characters[i].visited == nil then
Characters[i].visited = true
local nextCharacterName = Characters[i].characterName.."@"..Characters[i].worldName
            yield("/echo "..nextCharacterName)
if Entity.Player.Name ~= nextCharacterName then
yield("/ays relog "..nextCharacterName)
-- yield("/wait 3")
                repeat
                    yield("/wait 1")
                until Entity.Player.Name == nextCharacterName
                -- yield("/waitaddon _ActionBar <maxwait.600><wait.5>")
                yield("/waitaddon _ActionBar")
                State = CharacterState.ready
end
return
end
end
Multimode = false
end

function Ready()
    yield("/echo ready")
    if Addons.GetAddon("Gathering").Ready then
        yield("/callback Gathering true -1")
        return
    end

    if Player.IsBusy then -- wait for player to be available
        return
    end

    if Inventory.GetItemCount(MapInfo.itemId) > 0 then
      yield("/echo You already have a map in Inventory...")
        --[[if Mail and RecipientName ~= GetCharacterName(false) then
            MapAttached = false
            State = CharacterState.mailing
        end
        --]]
    elseif not HasMapAllowance() then
        yield("Do I get here?")
        if Multimode then
            State = CharacterState.swapping
        end
    else
        yield("/echo Let's go gathering!")
        State = CharacterState.gathering
    end
end

CharacterState =
{
    ready = Ready,
    gathering = Gather,
    --mailing = MailMap,
    swapping = SwapCharacters
}

yield("/at y")
GBRAutoOn = false
MapInfo = GetMapInfo()
State = CharacterState.ready
if MapInfo == nil then
    yield("/echo Cannot find item # for "..MapName)
else
    repeat
        State()
        yield("/wait 1")
    until not Multimode and (not HasMapAllowance() or (Inventory.GetItemCount(MapInfo.itemId) > 0 and not Mail))
yield("/xldisableplugin Gatherbuddy Reborn")
end