diff --git a/src/main/kotlin/RSLogic.kt b/src/main/kotlin/RSLogic.kt index c4fdfe6..19ecc25 100644 --- a/src/main/kotlin/RSLogic.kt +++ b/src/main/kotlin/RSLogic.kt @@ -69,36 +69,39 @@ interface RSOrchestrator : Orchestrator { /** * Handles the crafting process when standing at the bank. * - * This method takes care of 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. + * This method orchestrates the workflow when standing at the bank: * - * @param bankPoint The [Point] location of the bank on screen. - * @param bankPresetHotkey The hotkey used to open the bank interface. - * @param craftingDialogueHotkey The hotkey used to open the crafting dialogue. - * @param waitDurationMillis The base duration in milliseconds to wait while crafting. - * @param waitDurationVarianceMillis Random variance in milliseconds to add to the wait duration. + * - 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 "Make" hotkey to start crafting. + * - 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( 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: - * - Travels from the bank to the station. - * - Waits for the crafting duration. - * - Travels back to the bank when done. + * This orchestrates the steps to craft items at a station near the bank: * - * @param bankPoint The [Point] location of the bank. - * @param craftingStationPoint The [Point] location of the crafting station. - * @param bankPresetHotkey The hotkey to open the bank interface. - * @param travelDurationMillis The base travel time between bank and station. - * @param travelDurationVarianceMillis Random variance to add to the travel time. - * @param waitDurationMillis The base duration to wait while crafting. - * @param waitDurationVarianceMillis Random variance to add to the wait duration. + * - Travels from the bank to the station by left-clicking near the bank point. + * - Waits for the randomized travel duration. + * + * - Withdraws the preset inventory from the bank using the hotkey. + * - Waits for the randomized bank interaction 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( taskParams: TravelTaskParams