Module livesplit_core::analysis::pb_chance

Provides functionality to calculate the chance to beat the Personal Best for either a Run or a Timer. For a Run it calculates the general chance to beat the Personal Best. For a Timer the chance is calculated in terms of the current attempt. If there is no attempt in progress it yields the same result as the PB chance for the run. The value is being reported as a floating point number in the range from 0 (0%) to 1 (100%).

The PB chance is currently calculated with the skill curve. The PB chance is the percentile at which the PB is located on the skill curve. This is also where the BalancedPB would source its split times.

Functions

for_run

Calculates the PB chance for a Run. No information about an active attempt is used. Instead the general chance to beat the Personal Best is calculated. The value is being reported as a floating point number in the range from 0 (0%) to 1 (100%).

for_timer

Calculates the PB chance for a Timer. The chance is calculated in terms of the current attempt. If there is no attempt in progress it yields the same result as the PB chance for the run. The value is being reported as a floating point number in the range from 0 (0%) to 1 (100%). Additionally a boolean is returned that indicates if the value is currently actively changing as time is being lost.