Interface ILoadProgressIndicator

Namespace

MonkeyLoader.Resonite

Assembly

MonkeyLoader.Resonite.Integration.dll

Contains methods to update Resonite's loading progress indicator with custom phases.

public interface ILoadProgressIndicator

Properties

Available

Gets whether the progress indicator is available, determining the availability of these methods and properties.

bool Available { get; }

Property Value

bool

FixedPhaseIndex

Gets the index of the current fixed phase, if the progress indicator is available.

int? FixedPhaseIndex { get; }

Property Value

int?

TotalFixedPhaseCount

Gets or sets the number of fixed phases, if the progress indicator is available.

int? TotalFixedPhaseCount { get; }

Property Value

int?

Methods

AddFixedPhases(int)

Increments the TotalFixedPhaseCount by count to make space for additional phases, if the progress indicator is available.

bool AddFixedPhases(int count)

Parameters

count int

Returns

bool

true if the count was incremented successfully, otherwise false.

Remarks

Should be used as early as possible, to make sure the progress bar doesn't go backwards.

SetFixedPhase(string?)

Sets the fixed phase name, if the progress indicator is available.

bool SetFixedPhase(string? phase)

Parameters

phase string

The name of the phase.

Returns

bool

SetSubphase(string?)

Sets the subphase, if the progress indicator is available.

bool SetSubphase(string? subphase)

Parameters

subphase string

The name of the subphase.

Returns

bool