def start(first_run: bool) -> int:
"""Starts the process to complete a run for Raid Farming Mode and returns the number of items detected.
Args:
first_run (bool): Flag that determines whether or not to run the navigation process again. Should be False if the Farming Mode supports the "Play Again" feature for repeated runs.
Returns:
(int): Number of items detected.
"""
from bot.game import Game
number_of_items_dropped: int = 0
# Start the navigation process.
if first_run:
Raid._navigate()
else:
# Check for Pending Battles and then perform navigation again.
Game.check_for_pending()
Raid._navigate()
# Check for EP.
Game.check_for_ep()
# Check if the bot is at the Summon Selection screen.
if ImageUtils.confirm_location("select_a_summon", tries=30):
summon_check = Game.select_summon(Settings.summon_list,
Settings.summon_element_list)
if summon_check:
# Select the Party.
if Game.find_party_and_start_mission(Settings.group_number,
Settings.party_number):
# Handle the rare case where joining the Raid after selecting the Summon and Party led the bot to the Quest Results screen with no loot to collect.
if ImageUtils.confirm_location("no_loot", tries=2):
MessageLog.print_message(
"\n[RAID] Seems that the Raid just ended. Moving back to the Home screen and joining another Raid..."
)
elif CombatMode.start_combat_mode():
number_of_items_dropped = Game.collect_loot(
is_completed=True)
else:
MessageLog.print_message(
"\n[RAID] Seems that the Raid ended before the bot was able to join. Now looking for another Raid to join..."
)
else:
raise RaidException(
"Failed to arrive at the Summon Selection screen.")
return number_of_items_dropped
def start(first_run: bool) -> int:
"""Starts the process to complete a run for Quest Farming Mode and returns the number of items detected.
Args:
first_run (bool): Flag that determines whether or not to run the navigation process again. Should be False if the Farming Mode supports the "Play Again" feature for repeated runs.
Returns:
(int): Number of items detected.
"""
from bot.game import Game
number_of_items_dropped: int = 0
# Start the navigation process.
if first_run:
Quest._navigate()
elif Game.find_and_click_button("play_again"):
Game.check_for_popups()
else:
# If the bot cannot find the "Play Again" button, check for Pending Battles and then perform navigation again.
Game.check_for_pending()
Quest._navigate()
# Check for AP.
Game.check_for_ap()
# Check if the bot is at the Summon Selection screen.
if ImageUtils.confirm_location("select_a_summon", tries=30):
summon_check = Game.select_summon(Settings.summon_list,
Settings.summon_element_list)
if summon_check:
# Select the Party.
Game.find_party_and_start_mission(Settings.group_number,
Settings.party_number)
# Close the "Item Picked Up" popup.
if ImageUtils.confirm_location("items_picked_up"):
Game.find_and_click_button("ok")
# Now start Combat Mode and detect any item drops.
if CombatMode.start_combat_mode():
number_of_items_dropped = Game.collect_loot(
is_completed=True)
else:
raise QuestException(
"Failed to arrive at the Summon Selection screen.")
return number_of_items_dropped
def _clear_joined_raids():
"""Begin process to wait out the joined raids if there are 3 or more currently active.
Returns:
None
"""
from bot.game import Game
# If the maximum number of raids has been joined, collect any pending rewards with a interval of 30 seconds in between until the number of joined raids is below 3.
while Raid._raids_joined >= 3:
MessageLog.print_message(
f"\n[RAID] Maximum raids of 3 has been joined. Waiting 30 seconds to see if any finish."
)
Game.wait(30)
Game.go_back_home(confirm_location_check=True)
Game.find_and_click_button("quest")
if Game.check_for_pending():
Game.find_and_click_button("quest")
Game.wait(1)
Game.find_and_click_button("raid")
Game.wait(1)
Raid._check_for_joined_raids()
return None
def _navigate():
"""Navigates to the specified Raid.
Returns:
None
"""
from bot.game import Game
MessageLog.print_message(
f"\n[RAID] Beginning process to navigate to the raid: {Settings.mission_name}..."
)
# Head to the Home screen.
Game.go_back_home(confirm_location_check=True)
# Then navigate to the Quest screen.
Game.find_and_click_button("quest")
Game.wait(1)
# Check for the "You retreated from the raid battle" popup.
if ImageUtils.confirm_location("you_retreated_from_the_raid_battle",
tries=1):
Game.find_and_click_button("ok")
# Check for any Pending Battles popup.
if Game.check_for_pending():
Game.find_and_click_button("quest")
# Now navigate to the Raid screen.
Game.find_and_click_button("raid")
if ImageUtils.confirm_location("raid"):
# Check for any joined raids and if the max number of raids joined was reached, clear them.
Raid._check_for_joined_raids()
Raid._clear_joined_raids()
# Click on the "Enter ID" button and then start the process to join a raid.
MessageLog.print_message(
f"\n[RAID] Now moving to the \"Enter ID\" screen.")
if Game.find_and_click_button("enter_id"):
Raid._join_raid()
else:
raise RaidException("Failed to reach the Backup Requests screen.")
def _join_raid() -> bool:
"""Start the process to fetch a valid room code and join it.
Returns:
(bool): True if the bot arrived at the Summon Selection screen.
"""
from bot.game import Game
recovery_time = 15
# Make preparations for farming raids by saving the location of the "Join Room" button and the "Room Code" textbox.
join_room_button = ImageUtils.find_button("join_a_room")
room_code_textbox = (join_room_button[0] - 185, join_room_button[1])
# Loop and try to join a raid. If none of the room codes worked, wait before trying again with a new set of room codes for a maximum of 10 tries.
tries = 10
while tries > 0:
room_code_tries = 5
while room_code_tries > 0:
# Attempt to find a room code.
room_code = TwitterRoomFinder.get_room_code()
if room_code != "":
# Select the "Room Code" textbox and then clear all text from it.
MouseUtils.move_and_click_point(
room_code_textbox[0],
room_code_textbox[1],
"template_room_code_textbox",
mouse_clicks=2)
MouseUtils.clear_textbox()
# Copy the room code to the clipboard and then paste it into the "Room Code" textbox.
MouseUtils.copy_to_clipboard(room_code)
MouseUtils.paste_from_clipboard()
# Now click on the "Join Room" button.
MouseUtils.move_and_click_point(join_room_button[0],
join_room_button[1],
"join_a_room")
# If the room code is valid and the raid is able to be joined, break out and head to the Summon Selection screen.
if Game.find_and_click_button(
"ok", suppress_error=True) is False:
# Check for EP.
Game.check_for_ep()
MessageLog.print_message(
f"[SUCCESS] Joining {room_code} was successful.")
Raid._raids_joined += 1
return ImageUtils.confirm_location("select_a_summon")
elif Game.check_for_pending() is False:
MessageLog.print_message(
f"[WARNING] {room_code} already ended or invalid.")
else:
# Move from the Home screen back to the Backup Requests screen after clearing out all the Pending Battles.
Game.find_and_click_button("quest")
Game.find_and_click_button("raid")
Game.find_and_click_button("enter_id")
if Settings.enable_no_timeout is False:
room_code_tries -= 1
Game.wait(1)
tries -= 1
MessageLog.print_message(
f"\n[WARNING] Could not find any valid room codes. \nWaiting {recovery_time} seconds and then trying again with {tries} tries left before exiting."
)
Game.wait(recovery_time)
raise RaidException(
"Failed to find any valid room codes for 10 total times.")
