Add CombatModule#DISABLE_BLOCK_MISS_PENALTY

Author: ItsNature

api/src/main/java/com/lunarclient/apollo/module/combat/CombatModule.java

@@ -45,10 +45,29 @@ public final class CombatModule extends ApolloModule {
      * @since 1.0.4
      */
     public static final SimpleOption<Boolean> DISABLE_MISS_PENALTY = Option.<Boolean>builder()
-        .comment("Set to 'true' to remove the miss penalty on all versions 1.8 and above, otherwise 'false'. Enabling this option may cause compatibility issues with anti-cheats.")
+        .comment(
+            "Set to 'true' to remove the miss penalty on all versions 1.8 and above, otherwise 'false'.",
+            "Enabling this option may cause compatibility issues with anti-cheats."
+        )
         .node("disable-miss-penalty").type(TypeToken.get(Boolean.class))
         .defaultValue(false).notifyClient().build();
 
+    /**
+     * Whether the player gets a hit delay for a missed hit while
+     * targeting a block. Applies to all versions 1.8 and above.
+     *
+     * <p>Enabling this option may cause compatibility issues with anti-cheats.</p>
+     *
+     * @since 1.2.8
+     */
+    public static final SimpleOption<Boolean> DISABLE_BLOCK_MISS_PENALTY = Option.<Boolean>builder()
+        .comment(
+            "Set to 'true' to remove the miss penalty when targeting a block on all versions 1.8 and above, otherwise 'false'.",
+            "Enabling this option may cause compatibility issues with anti-cheats."
+        )
+        .node("disable-block-miss-penalty").type(TypeToken.get(Boolean.class))
+        .defaultValue(false).notifyClient().build();
+
     /**
      * Whether the player can dig and use an item at the same time,
      * like in 1.7. Applies to all versions 1.8 and above.
@@ -58,13 +77,17 @@ public final class CombatModule extends ApolloModule {
      * @since 1.2.8
      */
     public static final SimpleOption<Boolean> ALLOW_DIG_AND_USE = Option.<Boolean>builder()
-        .comment("Set to 'true' to allow digging and using an item at the same time on all versions 1.8 and above, otherwise 'false'. Enabling this option may cause compatibility issues with anti-cheats.")
+        .comment(
+            "Set to 'true' to allow digging and using an item at the same time on all versions 1.8 and above, otherwise 'false'.",
+            "Enabling this option may cause compatibility issues with anti-cheats."
+        )
         .node("allow-dig-and-use").type(TypeToken.get(Boolean.class))
         .defaultValue(false).notifyClient().build();
 
     CombatModule() {
         this.registerOptions(
             CombatModule.DISABLE_MISS_PENALTY,
+            CombatModule.DISABLE_BLOCK_MISS_PENALTY,
             CombatModule.ALLOW_DIG_AND_USE
         );
     }

api/src/main/java/com/lunarclient/apollo/option/OptionBuilder.java

@@ -86,6 +86,22 @@ public M comment(@Nullable String comment) {
         return (M) this;
     }
 
+    /**
+     * Sets the option comment to the provided lines, joined with a newline, and
+     * returns this builder.
+     *
+     * <p>Each provided line is rendered as its own comment line in the
+     * configuration.</p>
+     *
+     * @param lines the comment lines
+     * @return this builder
+     * @since 1.2.8
+     */
+    public M comment(@NonNull String... lines) {
+        this.comment = String.join("\n", lines);
+        return (M) this;
+    }
+
     /**
      * Sets the option default value to the provided {@code T} value and
      * returns this builder.

docs/developers/lightweight/json/packet-util.mdx

@@ -35,6 +35,7 @@ static {
     // While using the Apollo plugin this would be equivalent to modifying the config.yml
     CONFIG_MODULE_PROPERTIES.put("colored_fire", "persist-colors-on-unload", false);
     CONFIG_MODULE_PROPERTIES.put("combat", "disable-miss-penalty", false);
+    CONFIG_MODULE_PROPERTIES.put("combat", "disable-block-miss-penalty", false);
     CONFIG_MODULE_PROPERTIES.put("combat", "allow-dig-and-use", false);
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-attack.send-packet", false);
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-open.send-packet", false);

docs/developers/lightweight/protobuf/packet-util.mdx

@@ -35,6 +35,7 @@ static {
     // While using the Apollo plugin this would be equivalent to modifying the config.yml
     CONFIG_MODULE_PROPERTIES.put("colored_fire", "persist-colors-on-unload", Value.newBuilder().setBoolValue(false).build());
     CONFIG_MODULE_PROPERTIES.put("combat", "disable-miss-penalty", Value.newBuilder().setBoolValue(false).build());
+    CONFIG_MODULE_PROPERTIES.put("combat", "disable-block-miss-penalty", Value.newBuilder().setBoolValue(false).build());
     CONFIG_MODULE_PROPERTIES.put("combat", "allow-dig-and-use", Value.newBuilder().setBoolValue(false).build());
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-attack.send-packet", Value.newBuilder().setBoolValue(false).build());
     CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-open.send-packet", Value.newBuilder().setBoolValue(false).build());

docs/developers/modules/combat.mdx

@@ -7,6 +7,7 @@ import { Callout, Tab, Tabs } from 'nextra-theme-docs'
 The combat module allows you to modify certain aspects of combat that are usually handled client-sided.
 
 - Adds the ability to disable the miss penalty, on all versions 1.8 and above.
+- Adds the ability to disable the miss penalty when targeting a block, on all versions 1.8 and above.
 - Adds the ability to dig and use an item at the same time, like in 1.7, on all versions 1.8 and above.
 
 ### Sample Code
@@ -28,6 +29,14 @@ public void setDisableMissPenalty(boolean value) {
 }
 ```
 
+### Toggle Block Miss Penalty
+
+```java
+public void setDisableBlockMissPenalty(boolean value) {
+    this.combatModule.getOptions().set(CombatModule.DISABLE_BLOCK_MISS_PENALTY, value);
+}
+```
+
 ### Toggle Dig and Use
 
 ```java
@@ -56,6 +65,18 @@ public void setDisableMissPenalty(boolean value) {
 }
 ```
 
+### Toggle Block Miss Penalty
+
+```java
+public void setDisableBlockMissPenalty(boolean value) {
+    Map<String, Value> properties = new HashMap<>();
+    properties.put("disable-block-miss-penalty", Value.newBuilder().setBoolValue(value).build());
+
+    ConfigurableSettings settings = ProtobufPacketUtil.createModuleMessage("combat", properties);
+    ProtobufPacketUtil.broadcastPacket(settings);
+}
+```
+
 ### Toggle Dig and Use
 
 ```java
@@ -88,6 +109,18 @@ public void setDisableMissPenalty(boolean value) {
 }
 ```
 
+### Toggle Block Miss Penalty
+
+```java
+public void setDisableBlockMissPenalty(boolean value) {
+    Map<String, Object> properties = new HashMap<>();
+    properties.put("disable-block-miss-penalty", value);
+
+    JsonObject message = JsonUtil.createEnableModuleObjectWithType("combat", properties);
+    JsonPacketUtil.broadcastPacket(message);
+}
+```
+
 ### Toggle Dig and Use
 
 ```java
@@ -111,6 +144,11 @@ public void setAllowDigAndUse(boolean value) {
     - Values
         - Type: `Boolean`
         - Default: `false`
+- __`DISABLE_BLOCK_MISS_PENALTY`__
+    - Whether the player gets a hit delay for a missed hit while targeting a block. Applies to all versions 1.8 and above. Enabling this option may cause compatibility issues with anti-cheats.
+    - Values
+        - Type: `Boolean`
+        - Default: `false`
 - __`ALLOW_DIG_AND_USE`__
     - Whether the player can dig and use an item at the same time, like in 1.7. Applies to all versions 1.8 and above. Enabling this option may cause compatibility issues with anti-cheats.
     - Values

example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/util/JsonPacketUtil.java

@@ -53,6 +53,7 @@ public final class JsonPacketUtil {
         // While using the Apollo plugin this would be equivalent to modifying the config.yml
         CONFIG_MODULE_PROPERTIES.put("colored_fire", "persist-colors-on-unload", false);
         CONFIG_MODULE_PROPERTIES.put("combat", "disable-miss-penalty", false);
+        CONFIG_MODULE_PROPERTIES.put("combat", "disable-block-miss-penalty", false);
         CONFIG_MODULE_PROPERTIES.put("combat", "allow-dig-and-use", false);
         CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-attack.send-packet", false);
         CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-open.send-packet", false);

example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/util/ProtobufPacketUtil.java

@@ -54,6 +54,7 @@ public final class ProtobufPacketUtil {
         // While using the Apollo plugin this would be equivalent to modifying the config.yml
         CONFIG_MODULE_PROPERTIES.put("colored_fire", "persist-colors-on-unload", Value.newBuilder().setBoolValue(false).build());
         CONFIG_MODULE_PROPERTIES.put("combat", "disable-miss-penalty", Value.newBuilder().setBoolValue(false).build());
+        CONFIG_MODULE_PROPERTIES.put("combat", "disable-block-miss-penalty", Value.newBuilder().setBoolValue(false).build());
         CONFIG_MODULE_PROPERTIES.put("combat", "allow-dig-and-use", Value.newBuilder().setBoolValue(false).build());
         CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-attack.send-packet", Value.newBuilder().setBoolValue(false).build());
         CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-open.send-packet", Value.newBuilder().setBoolValue(false).build());