From c057a51ae1b430f3c3fb8bd58b81d661935df46c Mon Sep 17 00:00:00 2001 From: Zoinkwiz Date: Thu, 26 Sep 2024 13:04:16 +0100 Subject: [PATCH] fix: Update docs on VarComparisonRequirement --- .../requirements/var/VarComparisonRequirement.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/questhelper/requirements/var/VarComparisonRequirement.java b/src/main/java/com/questhelper/requirements/var/VarComparisonRequirement.java index 62b8782c49..a510799b82 100644 --- a/src/main/java/com/questhelper/requirements/var/VarComparisonRequirement.java +++ b/src/main/java/com/questhelper/requirements/var/VarComparisonRequirement.java @@ -60,12 +60,14 @@ public class VarComparisonRequirement extends AbstractRequirement private boolean hasFiredWarning = false; /** - * Check if the player's varbit value meets the required level using the given + * Compares the varbit/varp of a player to another varbit/varp of the player * {@link Operation}. * - * @param varbitID the {@link Varbits} id to use + * @param v1Type the {@link VarType} to use for the first id + * @param v1Id the {@link Varbits} or {@link net.runelite.api.annotations.Varp} id to use for the first id + * @param v2Type the {@link VarType} to use for the second id + * @param v2Id the {@link Varbits} or {@link net.runelite.api.annotations.Varp} id to use for the second id * @param operation the {@link Operation} to check with - * @param requiredValue the required varbit value to pass this requirement * @param displayText the display text */ public VarComparisonRequirement(VarType v1Type, int v1Id, VarType v2Type, int v2Id, Operation operation, String displayText)