Toggle sprint default off¶
Tap your Sprint key once to keep it held; tap again to release. This is one of the two modules that write something, and some servers forbid it.
- Identifier
toggle-sprint- Default
- Off
- HUD element
- Yes, the status text. Bottom left, offset 4, 4.
- Writes
- The pressed state of the vanilla Sprint key binding
- Sends anything
- No
Check the server's rules first
Some servers forbid toggle-sprint mods. The module is off by default for that reason. Xol does not claim that any server permits it.
What it does¶
While the toggle is on, the module keeps the vanilla Sprint key binding in its pressed state. It uses the same call the game itself makes for a real key-down event. That is the whole effect.
- It never calls the game's "set sprinting" function and never touches movement.
- Whether you actually sprint is still decided by vanilla, by every one of its rules: hunger, sneaking, blindness, using an item, collisions, and whether you are moving forward.
- No packet is added, delayed, reordered, cancelled or edited. The game then behaves as it does while the key is physically held.
The toggle¶
The toggle flips on the real key-down event of whichever key is bound to vanilla Sprint, so a quick tap is never missed. It is not a separate key. It flips only while the module is on, you are in a world, and no screen is open.
When it lets go¶
| Situation | Behaviour |
|---|---|
| Any screen is open (inventory, chat, menus) | The module leaves the key alone. Vanilla releases every key while a screen is open, and the module does not fight that. |
| You tap Sprint again | The toggle turns off. The key returns to its real physical state. |
| You switch the module off | The key is released and the toggle is cleared. |
| You leave the world | The key is released and the toggle is cleared. |
Status text¶
With Show status text on, a HUD element shows one of:
| Text | Meaning |
|---|---|
[Sprint: Toggled] |
The toggle is on |
[Sprint: Held] |
The toggle is off and you are physically holding the Sprint key |
[Sprinting] |
Neither, but the player is sprinting (for example after a double-tap forward) |
| nothing | None of the above |
The HUD editor shows [Sprint: Toggled] as its sample.
Settings¶
| Setting | Identifier | Type | Range or options | Default | Description |
|---|---|---|---|---|---|
| Show status text | status-text |
On or off | On | Show whether sprint is toggled, held or active. | |
| Background | background |
On or off | On | Draw a translucent box behind the element. | |
| Text shadow | shadow |
On or off | On | Draw text with the vanilla drop shadow. | |
| Text color | color |
Colour | AARRGGBB |
#FFFFFFFF |
Color of the element's text. |
The last three are the settings every HUD module has. With the status text off, the module still toggles; it just draws nothing.
What it reads¶
Key-down events of the key bound to vanilla Sprint; whether a screen is open; whether the Sprint key is physically down; whether the player is sprinting (for the status text).
What it writes¶
The pressed state of the vanilla Sprint key binding, locally. Nothing else.
Multiplayer¶
Holds the vanilla Sprint key state for you and nothing else: every vanilla sprint rule (hunger, sneaking, blindness, collisions, using items) still applies and no packet is added or changed. Some servers forbid toggle-sprint mods; check their rules.
See the module review table for every module side by side.