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

doc tweaks. i think i'm done

Browse Source
This commit is contained in:
dtookey 2023-08-06 22:16:35 -04:00
parent 2d1f372d94
commit 8414358708
1 changed files with 8 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -14,7 +14,7 @@ import java.awt.event.KeyEvent
* ```
* val orch = RSOrchestrator.getInstance()
* val params = StandingTaskParams(...)
* orch.doStandingTask(orch, params)
* RSOrchestrator.doStandingTask(orch, params)
* ```
*/
interface RSOrchestrator : Orchestrator {
@ -32,7 +32,7 @@ interface RSOrchestrator : Orchestrator {
* ```
* val orch = RSOrchestrator.getInstance()
* val params = StandingTaskParams(...)
* orch.doStandingTask(orch, params)
* RSOrchestrator.doStandingTask(orch, params)
* ```
*
* @param orchestrator The [RSOrchestrator] that will execute the actions.
@ -61,7 +61,7 @@ interface RSOrchestrator : Orchestrator {
* ```
* val orch = RSOrchestrator.getInstance()
* val params = TravelTaskParams(...)
* orch.doTravelTask(orch, params)
* RSOrchestrator.doTravelTask(orch, params)
* ```
*
* @param orchestrator The [RSOrchestrator] instance that will execute the actual actions.
@ -107,9 +107,7 @@ interface RSOrchestrator : Orchestrator {
*
* @param taskParams The StandingTaskParams configuring the task details like bank location, hotkeys, durations etc.
*/
fun processAtBank(
taskParams: StandingTaskParams
)
fun processAtBank(taskParams: StandingTaskParams)
/**
* Handles the crafting workflow when at a station near the bank.
@ -131,21 +129,13 @@ interface RSOrchestrator : Orchestrator {
*
* Usage example:
* ```
* val params = TravelTaskParams(
* bankLocation = Point(100, 200),
* stationLocation = Point(300, 400),
* withdrawHotkey = KeyEvent.VK_F1,
* craftHotkey = KeyEvent.VK_2,
* // ...other params
* )
* val params = TravelTaskParams(...)
* orchestrator.processAtStationNearBank(params)
* ```
*
* @param taskParams The TravelTaskParams configuring the task details like locations, durations, hotkeys etc.
*/
fun processAtStationNearBank(
taskParams: TravelTaskParams
)
fun processAtStationNearBank(taskParams: TravelTaskParams)
/**
* Gets the screen point location of the bank.
@ -161,7 +151,7 @@ interface RSOrchestrator : Orchestrator {
* orchestrator.moveMouseLeftClickAndSleep(bankPoint, 100)
*
* // Withdraw preset inventory at bank
* orchestrator.keyPress(KeyEvent.VK_F1)
* orchestrator.automaton.keyPress(KeyEvent.VK_F1)
* ```
*
* @return The Point representing the x,y screen coordinates of the bank location.
@ -185,7 +175,7 @@ interface RSOrchestrator : Orchestrator {
* Craft while standing at bank:
* ```
* val standingParams = StandingTaskParams(...)
* agent.doStandingTask(agent, standingParams)
* orchestrator.doStandingTask(agent, standingParams)
* ```
*
*