Add bot.clickWindow mode disclaimer (PrismarineJS#2595)

* Update api.md * add simpleClick note Co-authored-by: u9g <[email protected]>
WhoTho · May 10, 2022 · 1847001 · 1847001
1 parent 40a5859
commit 1847001
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -1995,9 +1995,13 @@ These are lower level methods for the inventory, they can be useful sometimes bu
 #### bot.clickWindow(slot, mouseButton, mode)
 
 This function returns a `Promise`, with `void` as its argument upon completion.
+
+The only valid mode option at the moment is 0. Shift clicking or mouse draging is not implemented.
 
 Click on the current window. See details at https://wiki.vg/Protocol#Click_Window
 
+Prefer using bot.simpleClick.*
+
 #### bot.putSelectedItemRange(start, end, window, slot)
 
 This function returns a `Promise`, with `void` as its argument upon completion.