Class LoadProgressReporter
- Namespace
- MonkeyLoader.Resonite
- Assembly
- MonkeyLoader.Resonite.Integration.dll
Contains methods to update Resonite's loading progress indicator with custom phases.
public static class LoadProgressReporter
- Inheritance
-
LoadProgressReporter
- Inherited Members
Properties
Available
Gets whether the progress indicator is available, determining the availability of the methods and properties of this class.
public static bool Available { get; }
Property Value
FixedPhaseIndex
Gets the index of the current fixed phase, if the progress indicator is available.
public static int? FixedPhaseIndex { get; }
Property Value
- int?
LoadProgressIndicator
Gets or sets the concrete ILoadProgressIndicator implementation used to report the load progress of mods and their monkeys.
public static ILoadProgressIndicator? LoadProgressIndicator { get; set; }
Property Value
TotalFixedPhaseCount
Gets the number of fixed phases, if the progress indicator is available.
public static int? TotalFixedPhaseCount { get; }
Property Value
- int?
Methods
AddFixedPhase()
Increments the TotalFixedPhaseCount to make space for an additional phase, if the progress indicator is available..
public static bool AddFixedPhase()
Returns
- bool
true
if the count was incremented successfully, otherwisefalse
.
Remarks
Should be used as early as possible, to make sure the progress bar doesn't go backwards.
AddFixedPhases(int)
Increments the TotalFixedPhaseCount by count
to make space for additional phases,
if the progress indicator is available.
public static bool AddFixedPhases(int count)
Parameters
count
int
Returns
- bool
true
if the count was incremented successfully, otherwisefalse
.
Remarks
Should be used as early as possible, to make sure the progress bar doesn't go backwards.
AdvanceFixedPhase(string)
Increments the FixedPhaseIndex and sets the fixed phase to advance the progress bar, if the progress indicator is available.
public static bool AdvanceFixedPhase(string phase)
Parameters
phase
stringThe name of the phase to advance to.
Returns
- bool
true
if the phase was advanced successfully, otherwisefalse
.
ExitSubphase()
Unsets the subphase, if the progress indicator is available.
public static bool ExitSubphase()
Returns
- bool
true
if the subphase was changed successfully, otherwisefalse
.
SetSubphase(string)
Sets the subphase, if the progress indicator is available.
public static bool SetSubphase(string subphase)
Parameters
subphase
stringThe name of the subphase.
Returns
- bool
true
if the subphase was changed successfully, otherwisefalse
.