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

hopefully final round of documentation

Browse Source
This commit is contained in:
dtookey 2023-08-06 20:46:23 -04:00
parent ee0165f106
commit d66a35bcdb
1 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -69,36 +69,39 @@ interface RSOrchestrator : Orchestrator {
/** /**
* Handles the crafting process when standing at the bank. * Handles the crafting process when standing at the bank.
* *
* This method takes care of the workflow when standing at the bank: * This method orchestrates the workflow when standing at the bank:
* - Opens the bank interface using the bank preset hotkey.
* - Waits for the crafting duration.
* - Closes the bank interface.
* *
* @param bankPoint The [Point] location of the bank on screen. * - Opens the bank interface by left-clicking near the provided bank point location.
* @param bankPresetHotkey The hotkey used to open the bank interface. * - Withdraws the desired inventory preset using the provided hotkey.
* @param craftingDialogueHotkey The hotkey used to open the crafting dialogue. * - Opens the crafting interface using the provided crafting dialogue hotkey.
* @param waitDurationMillis The base duration in milliseconds to wait while crafting. * - Clicks the default "Make" hotkey to start crafting.
* @param waitDurationVarianceMillis Random variance in milliseconds to add to the wait duration. * - Waits for the specified crafting duration plus random variance.
*
* @param taskParams The StandingTaskParams configuring the task details like bank location, hotkeys, durations etc.
*/ */
fun processAtBank( fun processAtBank(
taskParams: StandingTaskParams taskParams: StandingTaskParams
) )
/** /**
* Handles the crafting process when at a station near the bank. * Handles the crafting workflow when at a station near the bank.
* *
* This method takes care of the workflow when at the crafting station: * This orchestrates the steps to craft items at a station near the bank:
* - Travels from the bank to the station.
* - Waits for the crafting duration.
* - Travels back to the bank when done.
* *
* @param bankPoint The [Point] location of the bank. * - Travels from the bank to the station by left-clicking near the bank point.
* @param craftingStationPoint The [Point] location of the crafting station. * - Waits for the randomized travel duration.
* @param bankPresetHotkey The hotkey to open the bank interface. *
* @param travelDurationMillis The base travel time between bank and station. * - Withdraws the preset inventory from the bank using the hotkey.
* @param travelDurationVarianceMillis Random variance to add to the travel time. * - Waits for the randomized bank interaction duration.
* @param waitDurationMillis The base duration to wait while crafting. *
* @param waitDurationVarianceMillis Random variance to add to the wait duration. * - Travels to the crafting station by left-clicking the station point.
* - Waits for the randomized travel duration.
*
* - Opens the crafting interface using the provided hotkey.
* - Clicks the "Make" button using the hotkey to craft items.
* - Waits for the randomized crafting duration.
*
* @param taskParams The TravelTaskParams configuring the task details like locations, durations, hotkeys etc.
*/ */
fun processAtStationNearBank( fun processAtStationNearBank(
taskParams: TravelTaskParams taskParams: TravelTaskParams