From 16e384ca764d42dc328cc1ced7d0c4f5070ae238 Mon Sep 17 00:00:00 2001
From: GenerelSchwerz <xXSG.KingXx@gmail.com>
Date: Mon, 15 Apr 2024 22:31:35 -0400
Subject: [PATCH] cancel on sneaking feature & update readme

---
 README.md      | 30 ++++++++++++++++++++++--------
 src/utils.ts   |  2 ++
 src/wrapper.ts |  8 ++++++++
 3 files changed, 32 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 12d8dd0..96cdc8f 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,11 @@ Returns if the bot should jump (if we do not jump right now, there will be an is
 
 Returns if the bot is allowed to jump (no jump *needed*, but no detriment to jumping right now).
 
+### `autoJump.strictBlockCollision: boolean`
+
+If true, only jump if the bot is colliding with a block ABOVE current walking level. 
+If false, the bot will jump if it is colliding with a block at all.
+
 ### `autoJump.jumpOnAllEdges: boolean`
 
 If the bot should jump on all edges. This is mainly used for descending slopes, combined with `maxBlockOffset`.
@@ -70,6 +75,10 @@ If the bot should minimize fall damage. Similar to maxBlockOffset set to 3 excep
 
 If the bot should debug the jump checker. Your console will be spammed. Just report the information to me.
 
+### `autoJump.cancelOnShift: boolean`
+
+If the bot should cancel the jump if the player is holding shift. Useful for sneaking.
+
 ## Events
 
 ### `autoJump.on('shouldJump', () => {})`
@@ -80,16 +89,10 @@ Emitted when the bot should jump.
 
 <!-- 
 
-export interface JumpCheckerOpts {
-  jumpOnAllEdges: boolean;
-  jumpIntoWater: boolean;
-  maxBlockOffset: number;
-  minimizeFallDmg: boolean;
-  debug: boolean;
-}
-
 export const DefaultHandlerKeys: JumpCheckerOpts = {
+  strictBlockCollision: true,
   jumpOnAllEdges: false,
+  jumpToClearSmallDip: false,
   jumpIntoWater: false,
   maxBlockOffset: 0,
   minimizeFallDmg: false,
@@ -98,10 +101,21 @@ export const DefaultHandlerKeys: JumpCheckerOpts = {
 
 export interface AutoJumperOpts {
   enabled: boolean;
+  cancelOnShift: boolean;
 }
 
 export const DefaultKeys: AutoJumperOpts = {
   enabled: false,
+  cancelOnShift: false
+};
+
+
+export const DefaultHandlerKeys: JumpCheckerOpts = {
+  jumpOnAllEdges: false,
+  jumpIntoWater: false,
+  maxBlockOffset: 0,
+  minimizeFallDmg: false,
+  debug: false
 };
 
 interface AutoJumperEvents {
diff --git a/src/utils.ts b/src/utils.ts
index 3442b74..f5609ce 100644
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -23,10 +23,12 @@ export const DefaultHandlerKeys: JumpCheckerOpts = {
 
 export interface AutoJumperOpts {
   enabled: boolean;
+  cancelOnShift: boolean;
 }
 
 export const DefaultKeys: AutoJumperOpts = {
   enabled: false,
+  cancelOnShift: false
 };
 
 interface AutoJumperEvents {
diff --git a/src/wrapper.ts b/src/wrapper.ts
index c00de6c..cea400f 100644
--- a/src/wrapper.ts
+++ b/src/wrapper.ts
@@ -9,6 +9,8 @@ export class AutoJumper extends (EventEmitter as { new (): AutoJumperEmitter })
   private lastJump: boolean = false;
   private _enabled: boolean = false;
 
+  public cancelOnShift: boolean = false;
+
   public get enabled() {
     return this._enabled;
   }
@@ -60,6 +62,12 @@ export class AutoJumper extends (EventEmitter as { new (): AutoJumperEmitter })
   }
 
   private jumpListener = () => {
+
+    if (this.cancelOnShift && this.bot.getControlState("sneak")) {
+      this.lastJump = false;
+      return;
+    }
+
     if (this.handler.shouldJump()) {
       if (!this.lastJump) {
         this.emit("shouldJump");