HEAL¶
health¶
- This condition returns the health percentage of the specified unit.
Parameters¶
UNIT: The unit to retrieve the health percentage from.
Returns NUMBER¶
- The health percentage of the unit.
Example:¶
health.actual¶
- This condition returns the actual health value of the specified unit.
Parameters¶
UNIT: The unit to retrieve the actual health value from.
Returns NUMBER¶
- The actual health value of the unit.
Example:¶
health.max¶
- This condition returns the maximum health value of the specified unit.
Parameters¶
UNIT: The unit to retrieve the maximum health value from.
Returns NUMBER¶
- The maximum health value of the unit.
Example:¶
health.predicted¶
health.predicted || healthp
- This condition returns the predicted health percentage of the specified unit.
Parameters¶
UNIT: The unit to calculate the predicted health percentage for.
Returns NUMBER¶
- The predicted health percentage of the target unit.
Example:¶
health.predicted.actual¶
- This condition returns the predicted actual health value of the specified unit.
Parameters¶
UNIT: The unit to retrieve the predicted actual health value from.
Returns NUMBER¶
- The predicted actual health value of the unit.
Example:¶
area.heal¶
- This condition counts the number of player units within a specified distance of a target unit that have health equal to or below a certain threshold.
Parameters¶
UNIT: The central unit to check around.ARGS: A string containing two arguments separated by a comma:distance(optional, default: 20): The maximum distance from the central unit.health(optional, default: 100): The health percentage threshold (units with health <= this value are counted).
Returns NUMBER¶
- The total count of player units within the specified distance and health threshold.
Example:¶
area.heal.infront¶
- This condition counts the number of player units within a specified distance of a target unit, have health below a certain threshold, and are located in front of the target unit.
Parameters¶
UNIT: The central unit to check around and whose 'front' is considered.ARGS: A string containing two arguments separated by a comma:distance(optional, default: 20): The maximum distance from the central unit.health(optional, default: 100): The health percentage threshold (units with health < this value are counted).
Returns NUMBER¶
- The total count of player units within the specified distance, below the health threshold, and in front of the central unit.
Example:¶
area.roster.avrHP¶
- This condition calculates the average health of player units within a specified range of a given unit, considering only those units whose health is at or below a certain threshold. It returns both the average health and the count of units considered.
Parameters¶
UNIT: The central unit.ARGS: A string containing two arguments separated by a comma:range: The maximum distance from the central unit.threshold(optional, default: 100): The maximum health percentage for a unit to be included in the calculation (e.g., if 50, only units with 50% health or less are considered).
Returns NUMBER, NUMBER¶
- The first return value is the average health percentage of the qualifying units. Returns
100if no units meet the criteria. - The second return value is the count of units that were included in the average calculation.
Example:¶
This action will trigger if the average health of units within 30 yards of
UNIT that have 60% health or less is below 50%.
Note: DSL typically uses the first return value for comparisons.
healAverage¶
- This condition calculates the average health percentage of all player units within a specified radius from the player.
Parameters¶
UNIT: This parameter is typically ignored in the function's logic, which always calculates around the player. It's usually the player unit itself.RADIUS: The radius around the player within which to calculate the average health.
Returns NUMBER¶
- The average health percentage of player units within the specified radius. Returns
101if no units are found.
Example:¶
healAverageOf¶
- This condition calculates the average health percentage of the 'N' closest player units within a specified radius from the player.
Parameters¶
UNIT: This parameter is typically ignored in the function's logic, which always calculates around the player. It's usually the player unit itself.ARGS: A string containing two arguments separated by a comma:num: The number of closest units to consider for the average.radius: The radius around the player to search for units.
Returns NUMBER¶
- The average health percentage of the 'N' closest player units within the specified radius. Returns
101if no units are found.