Combat BlockHit Module

[coderabbitai[bot]]

### BlockHit Documentation

#### Overview
The `BlockHit` module allows users to [describe functionality here].

#### Settings

##### [Setting Name]
- **Description**: [Describe setting here].

<Callout type="default" emoji="️👾">
[Additional information or tips here].
</Callout>

#### Usage
1. **Enable the Module**: [Describe how to enable the module].
2. **Adjust Settings**: [Describe how to adjust settings].
3. **Play**: [Describe how to use the module during gameplay].

#### Example Configuration
- **[Setting Name]**: [Example value].

By customizing these settings, you can optimize the `BlockHit` module to best fit your gameplay style and requirements.

#### Sequence Diagram

```mermaid
sequenceDiagram
  participant User
  participant BlockHit
  participant Game
  User->>BlockHit: [Describe interaction here]
  BlockHit->>Game: [Describe interaction here]
  Game->>User: [Describe interaction here]

This documentation took approximately [time] to create.

[TejasLamba2006]

@coderabbitai make docs for these hack using the path

do include the sequenceDiagram

u can replicate docs style from here https://github.com/TejasLamba2006/Raven-bS-Docs/blob/main/pages/Modules/Combat/AimAssist.mdx

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

@TejasLamba2006, here's the documentation for the Combat BlockHit Module, following the style and structure of the AimAssist documentation. Please review and provide any additional details or corrections needed.

import { Callout, Steps, Cards, Card } from "nextra/components";

## BlockHit Documentation

### Overview
The BlockHit module enhances your combat abilities by automatically blocking and hitting in quick succession. It offers various settings to customize its behavior to suit different playstyles and preferences.

```mermaid
sequenceDiagram
    participant Player
    participant BlockHit
    participant CombatUtils
    participant RotationUtils

    Player->>BlockHit: onUpdate()
    BlockHit-->>BlockHit: checkConditions()
    alt conditions not met
        BlockHit-->>BlockHit: return
    else conditions met
        BlockHit->>CombatUtils: performBlockHit()
        CombatUtils-->>Player: executeBlockHit()
    end

Settings

Block Delay

• Description: Controls the delay between blocking and hitting.
• Range: 0.0 to 1.0
• Increment: 0.05

Lower Block Delay can help you block and hit more rapidly.

Hit Delay

• Description: Controls the delay between hits.
• Range: 0.0 to 1.0
• Increment: 0.05

Adjust Hit Delay to balance between blocking and hitting efficiently.

Auto Block

• Description: Automatically blocks when an enemy is detected.

Auto Block ensures you are always ready to block incoming attacks.

Block on Hit

• Description: Blocks immediately after hitting an enemy.

Ignore Teammates

• Description: Excludes teammates from being targeted for block hitting.

Use Ignore Teammates to avoid accidentally blocking or hitting your allies during team fights.

Usage

1. Enable the Module: Activate the BlockHit module from the mod's interface.
2. Adjust Settings: Customize the settings to your preference. For example, decrease the Block Delay for faster block-hitting or enable Auto Block to automatically block when an enemy is detected.
3. Play: The BlockHit module will enhance your combat abilities based on your configured settings.

Tips

Customize for Situations: Different scenarios (e.g., PvP combat vs. casual play) might benefit from different settings.

Example Configuration

• Block Delay: 0.2
• Hit Delay: 0.3
• Auto Block: Enabled
• Block on Hit: Enabled
• Ignore Teammates: Enabled

By customizing these settings, you can optimize the BlockHit module to best fit your gameplay style and requirements.

<details>
<summary>Analysis chain</summary>

<!-- [monologue]
[task 1/2] Generate documentation for the Combat BlockHit Module similar to the AimAssist documentation.
[observations] The user has provided a link to the AimAssist documentation as a reference. The new documentation should include a sequence diagram and follow the same style.
[analysis] To create the documentation, I need to:
1. Review the AimAssist documentation for structure and style.
2. Gather information about the BlockHit module.
3. Create a sequence diagram for the BlockHit module.
4. Write the new documentation in the same style as the AimAssist documentation.

I will start by examining the AimAssist documentation to understand its structure and style. Then, I will search for information about the BlockHit module in the codebase.
[actions] Use shell scripts to read the AimAssist documentation and gather information about the BlockHit module.
-->

</details>

<details>
<summary>Scripts executed</summary>

The following scripts were executed for the analysis:

Script:
```shell
#!/bin/bash
# Read the AimAssist documentation to understand its structure and style.
cat pages/Modules/Combat/AimAssist.mdx

# Search for the BlockHit module in the codebase.
fd -e mdx -e md -e js -e ts -e java -e py -e cpp -e cs -e rb -e go -e php -e rs -e kt -e swift "BlockHit"

Length of output: 6836

---

Learnings added

``` Learnt from: TejasLamba2006 URL: https://github.com/TejasLamba2006/Raven-bS-Docs/issues/42 Timestamp: 2024-07-07T20:22:34.382Z Learning: The documentation for new modules should follow the style and structure of existing module documentation, including an overview, sequence diagram, settings descriptions, usage instructions, tips, and an example configuration. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).