tookeyman/Tool-Assisted-RS
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cleaned up the docs around that callsite change

Browse Source
This commit is contained in:
dtookey 2023-08-06 20:44:51 -04:00
parent 430c9a34ac
commit ee0165f106
1 changed files with 18 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
src/main/kotlin/RSLogic.kt
View File

@ -154,26 +154,16 @@ private class RSAgent(override val automaton: Automaton = RobotController()) : R
interface implementation
==============================================================================================================*/
/**
* Performs actions at the bank chest.
* Handles the crafting process when standing at the bank.
*
* This method handles the workflow of:
* This method takes care of the workflow when standing at the bank:
* - Opens the bank interface by left-clicking near the provided bank point location.
* - Withdraws the desired inventory preset using the provided hotkey.
* - Opens the crafting interface using the provided crafting dialogue hotkey.
* - Clicks the default "Accept" hotkey to start crafting.
* - Waits for the specified crafting duration plus random variance.
*
* 1. Opening the bank interface by left-clicking near the provided bankPoint.
* 2. Withdrawing the desired inventory preset using the bankPresetHotkey.
* 3. Opening the crafting interface using the craftingDialogueHotkey.
* 4. Starting the crafting workflow by pressing the default "Accept" hotkey (space).
* 5. Waiting for the crafting duration with some random variance.
*
* Between steps, sleeps are added to match in-game server tick rate.
*
* The bank interface is opened by left-clicking near the bank point, using
* wiggle to introduce some variance.
*
* @param bankPoint The Point location of the bank chest.
* @param bankPresetHotkey The key code for the bank preset withdraw action.
* @param craftingDialogueHotkey The key code to open the crafting dialogue.
* @param waitDurationMillis The duration in ms to wait during crafting.
* @param waitDurationVariance Allowed variance in the wait duration.
* @param taskParams The [StandingTaskParams] configuring the task details like bank location, hotkeys, and durations.
*/
override fun processAtBank(
taskParams: StandingTaskParams
@ -195,33 +185,23 @@ private class RSAgent(override val automaton: Automaton = RobotController()) : R
}
/**
* Performs actions at a station near the bank.
* Handles the crafting process when at a station near the bank.
*
* This handles the workflow of:
* This method orchestrates the workflow when at the crafting station:
*
* 1. Moving to the bank and opening the interface
* 2. Withdrawing the desired inventory loadout
* 3. Moving to the station and opening the crafting interface
* 4. Starting the crafting task
* 5. Waiting for the crafting duration
* - Travels from the bank to the station by left-clicking near the bank point.
* - Waits for the randomized travel duration.
*
* Random variance is added to the travel and wait durations.
* - Withdraws the desired inventory preset using the provided hotkey.
*
* The bank interface is opened by left clicking the bank point.
* - Travels to the crafting station by left-clicking the station point.
* - Waits for the randomized travel duration.
*
* The preset hotkey withdraws the loadout.
* - Opens the crafting interface using the provided hotkey.
*
* The station interface is opened by left clicking the station point.
* - Waits for the randomized crafting duration.
*
* The crafting task is started by pressing the spacebar.
*
* @param bankPoint The Point location of the bank
* @param craftingStationPoint The Point location of the crafting station
* @param bankPresetHotkey The hotkey to withdraw bank preset loadout
* @param travelDurationMillis The base travel time between bank and station
* @param travelDurationVarianceMillis The allowed variance in travel time
* @param waitDurationMillis The base crafting duration
* @param waitDurationVarianceMillis The allowed variance in crafting duration
* @param taskParams The [TravelTaskParams] configuring the task details.
*/
override fun processAtStationNearBank(
taskParams: TravelTaskParams