From bfb75438ed4a82a0c8f66cc8ecfc4ca0fabac4b7 Mon Sep 17 00:00:00 2001 From: hannibal2 <24389977+hannibal00212@users.noreply.github.com> Date: Tue, 26 Mar 2024 18:27:32 +0100 Subject: add comment to speed value (ty alexia) --- .../hannibal2/skyhanni/features/misc/MovementSpeedDisplay.kt | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src/main/java/at/hannibal2/skyhanni/features/misc') diff --git a/src/main/java/at/hannibal2/skyhanni/features/misc/MovementSpeedDisplay.kt b/src/main/java/at/hannibal2/skyhanni/features/misc/MovementSpeedDisplay.kt index 2a984aeed..7f412a0c6 100644 --- a/src/main/java/at/hannibal2/skyhanni/features/misc/MovementSpeedDisplay.kt +++ b/src/main/java/at/hannibal2/skyhanni/features/misc/MovementSpeedDisplay.kt @@ -22,6 +22,17 @@ class MovementSpeedDisplay { private val soulsandSpeeds = mutableListOf() companion object { + /** + * This speed value represents the walking speed, not the speed stat. + * + * It has an absolute speed cap of 500, and items that normally increase the cap do not apply here: + * (Black Cat pet, Cactus knife, Racing Helmet or Young Dragon Armor) + * + * If this information ever gets abstracted away and made available outside this class, + * and some features need the actual value of the Speed stat instead, + * we can always just have two separate variables, like walkSpeed and speedStat. + * But since this change is confined to Garden-specific code, it's fine the way it is for now. + */ var speed = 0.0 var usingSoulsandSpeed = false } -- cgit