For the complete documentation index, see llms.txt. This page is also available as Markdown.

Restore Player Shield Instantly

Use the Set Player Overshield node with a 0.00 Percent Shield value to immediately restore a player's shield to maximum.

Cover image

While standard shield regeneration typically occurs over time, it is possible to bypass this process through scripting. By manipulating overshield nodes or recharge traits, developers can trigger immediate shield restoration.

Implementation via Overshield Node

The most effective way to restore a shield instantly is to use the Set Player Overshield node. Although this node is primarily intended to add extra protection, its underlying logic can be leveraged to reset the standard shield bar.

Node Configuration

To achieve a full shield restoration without adding additional overshield protection, configure the node with the following setting:

  • Percent Shield: 0.00

Set Player Overshield node
The `Set Player Overshield` node configured with a 0.00 percent shield value.

Underlying Mechanics

The ability to use this node for instant regeneration is due to the specific execution order of the overshield logic. When the Set Player Overshield node is triggered, the system performs two distinct actions in sequence:

  1. The player's current shield is immediately set to its maximum value.

  2. The specified overshield amount is then applied on top of that maximum value.

By providing a Percent Shield value of 0.00, the second step adds no additional overshield protection, resulting in only an instant reset to the player's maximum standard shield.

Alternative Method via Shield Recharge Trait

For a near-instantaneous recharge (approximately 0.2 seconds) without using the overshield node, you can manipulate the Trait: Shield Recharge node. This method adjusts the timing and speed of the standard regeneration process.

Implementation

To use this method, you must declare, apply and remove a trait set:

Configuration

To maximize recharge speed, use the following scalar values (compared to the default 5.000s cooldown and 2.000s recharge):

  • Recharge Delay Scalar: -1.00 (results in 0.000 s cooldown)

  • Recharge Rate Scalar: 10.00 (results in 0.2000 s recharge time)

Ideal shield recharge settings
Comparison between default trait values and settings for instant shield recharge.

Conversely, extreme values can be used to effectively disable regeneration:

  • Recharge Delay Scalar: 7.00 or higher (results in 40.000 s cooldown)

  • Recharge Rate Scalar: -1.00 (results in infinite recharge time)

Extreme shield recharge settings
Comparison between default trait values and settings that result in near-infinite recharge times.

These settings also impact health regeneration, resulting in a 0.000s health cooldown and 0.100s health recharge time.


Source Data

Contributors

Okom

Last updated