doc tweak

This commit is contained in:
dtookey 2023-08-06 20:55:45 -04:00
parent d66a35bcdb
commit 4e6b6679d3

View File

@ -16,14 +16,12 @@ import java.awt.event.KeyEvent
*/
object Routines {
/**
* The duration in milliseconds of one "tick". The duration of 600ms matches the tick duration of game servers.
* The duration in milliseconds of one game tick.
*
* This defines the concept of a "tick" as a unit of time used for pacing actions.
* This defines the amount of time that passes during one server game tick.
*
* It is used in methods like [sleepForNTicks] to calculate sleep durations
* based on multiplying a number of ticks by this value.
*
* For example, 5 ticks with this value would be 5 * 600 = 3000ms sleep duration.
* All timing and delays should be multiples of this tick duration to align with the
* server ticks and avoid timing issues.
*/
const val TICK_DURATION_MS = 600L
@ -265,39 +263,6 @@ object Routines {
RSOrchestrator.doTravelTask(agent, params)
}
/**
* Handles the workflow to grind supreme overloads near a bank.
*
* @param params The parameters defining the grind details.
*
* This method handles the full process of:
*
* 1. Withdrawing overload supplies from the bank.
* 2. Going to the well location to make overloads.
* 3. Using the F6 hotkey to make overloads.
* 4. Sleeping between cycles to pace the actions.
* 5. Repeating for the total volume in steps of size volumePerStep.
*
* The well location is prompted from the user by moving the mouse over it.
*
* The agent handles the banking and inventory management.
*
* @param params TaskParams defining totalVolume, volumePerStep, and other details.
*
* @deprecated This method needs validation before use in production.
*/
@Deprecated("Needs validation before you use it for realsies")
fun supremeOverloadGrind(params: TaskParams) {
val agent = RSOrchestrator.getInstance()
val chest = agent.getBankPoint()
val well = agent.promptUserForPoint("Put your mouse over the well...")
agent.doLoop(params.totalVolume, params.volumePerStep) {
agent.processAtStationNearBank(chest, well, KeyEvent.VK_F6, 0, 0, 6500, 1000)
}
}
/**
* Processes a volume of inventory at a furnace near the bank.
*
@ -341,36 +306,4 @@ object Routines {
RSOrchestrator.doTravelTask(agent, params)
}
/**
* Processes refined planks into frames at the sawmill near the bank.
*
* This handles the full workflow of:
* - Withdrawing planks preset from bank
* - Walking to the sawmill
* - Using planks on saw to make frames
* - Walking back to bank
* - Depositing frames
*
* The function loops through processing a total volume of planks based on the provided
* RoutineParams.
*
* @param params RoutineParams config including total volume, volume per trip, agent, and chest point.
* @return Nothing.
*/
@Deprecated("Needs validation before you use it for realsies")
fun processRefinedPlanksIntoFrames(params: TaskParams) {
println("You must zoom in all the way and have the compass pointing straight N with a completely top-down view\n you must also be standing at the touch point on the saw")
val agent = RSOrchestrator.getInstance()
agent.scrollOutToHeight(8)
//the following 2 points are magic numbers from *my* setup and resolution
val sawFromChest = Point(1079, 907)
val chestFromSaw = Point(1226, 180)
agent.doLoop(params.totalVolume, params.volumePerStep) {
agent.processAtStationNearBank(chestFromSaw, sawFromChest, KeyEvent.VK_F6, 2700, 500, 64000, 1000)
}
}
}