Module livesplit_core::analysis::possible_time_save
source · Expand description
Provides functions for calculating how much time save there is for either single segments or the remainder of an active attempt. This information is based on the best segments. Considering the best segments don’t represent theoretically perfect segment times, this information is only an approximation of how much time can actually be saved.
Functions
Calculates how much time could be saved on the given segment with the given
comparison. This information is based on the best segments. Considering the
best segments don’t represent theoretically perfect segment times, this
information is only an approximation of how much time can actually be saved.
If the parameter
live is set to true, then the segment time of the
current attempt is used if it gets longer than the segment time of the
segment the possible time save is calculated for. So the possible time save
shrinks towards zero as time goes on. The time returned by this function can
never be below zero. Additionally a boolean is returned that indicates if
the value is currently actively changing as time is being lost.Calculates how much time could be saved on the remainder of the run with the
given comparison. This information is based on the best segments.
Considering the best segments don’t represent theoretically perfect segment
times, this information is only an approximation of how much time can
actually be saved. This information is always live, so the total possible
time save will shrink towards zero throughout the run and when time is lost
on a segment. The time returned by this function can never be below zero.
Additionally a boolean is returned that indicates if the value is currently
actively changing as time is being lost.