Renaming SimulatorPacket::MinAlertRPM, MaxAlertRPM, RevLimiterBlinkAlertActive
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 181
- Forks
- 29
- PR merge metrics
- No merged PRs in 30d
Description
While implementing a shift tone for GT7 I've double-checked some variables in the telemetry packet, and the naming on these is awkward compared to their function. It would avoid confusion to any developer trying to use these variables if they're named a little more appropriately.
The float MinAlertRPM at 0x88 appears to be a hidden variable set per car (and upgrades) that often matches the listed upshift RPM in the Transmission Settings, but not always. The 787B has it at 9000, while the settings put it at 9500. The automatic transmission shifts at the latter value.
It appears to be a multiple of 100 regardless of upgrades (ECU, transmission, RPM-affecting engine upgrades).
The revbar starts at 85% of this AlertRPM and starts blinking at 99%. For the 787B this is a range of 7650 - 8910 RPM.
At this point the boolean flag RevLimiterBlinkAlertActive goes to True. So that's not really a revlimiter thing, it's more of a blinky-get-attention thing.
MaxAlertRPM refers to the peak RPM on the (ingame) tach, rounded up to the nearest multiple of 2000 when above 6000. It has no relation to the revbar blinking at all.
So as far as renaming goes, maybe something like this?
MinAlertRPM -> AlertRPM
MaxAlertRPM -> TachMaxRPM
RevLimiterBlinkAlertActive -> (Upshift)BlinkAlertActive
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the telemetry packet definitions and references to MinAlertRPM, MaxAlertRPM, and RevLimiterBlinkAlertActive. Review the proposed names against their described behavior, then rename the fields consistently so the packet API no longer uses the misleading names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- game-dev, reverse-engineering
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100