From 9d01fa2e3afda871b0614216eba403ed4fb4b476 Mon Sep 17 00:00:00 2001 From: Vollmer Date: Thu, 28 Mar 2024 22:25:39 +0100 Subject: [PATCH] add suggested docblock for buffSoonPresent --- .../shared/metrics/apl/conditions/buffSoonPresent.tsx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/parser/shared/metrics/apl/conditions/buffSoonPresent.tsx b/src/parser/shared/metrics/apl/conditions/buffSoonPresent.tsx index 1eecbd6024c..7aec8617563 100644 --- a/src/parser/shared/metrics/apl/conditions/buffSoonPresent.tsx +++ b/src/parser/shared/metrics/apl/conditions/buffSoonPresent.tsx @@ -13,6 +13,12 @@ type BuffInformation = { type SourceOptions = 'player' | 'external' | 'any'; +/** + * Check if a buff will be present soon after the present time. + * + * This should ONLY be used for buffs that the player has complete control over, such as buffs tied to cooldown use. + * DO NOT use this to "look ahead" for random procs to implement impossibly optimal APLs. + */ export function buffSoonPresent( spell: Spell, range: Range,