add doc-block to GetUnifiedSpeed

spacek531 · Nov 5, 2024 · cb48423 · cb48423
1 parent b4928d9
commit cb48423
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/openrct2/ride/RideData.h b/src/openrct2/ride/RideData.h
@@ -524,6 +524,10 @@ struct RideTypeDescriptor
     bool SupportsTrackGroup(const TrackGroup trackGroup) const;
     ResearchCategory GetResearchCategory() const;
     bool SupportsRideMode(RideMode rideMode) const;
+    /**
+     * Converts booster speed from the ride type's speed regime (Junior, Default, Giga) to to the unified values used by the
+     * vehicle. See https://github.com/OpenRCT2/OpenRCT2/discussions/23119 for more information about unified speed.
+     */
     int32_t GetUnifiedBoosterSpeed(int32_t relativeSpeed) const;
 };