Interface ILoader

A ILoader is used to load content over time. This content is broken up into a collection of ILoadPhase objects. These get queued and loaded in the foreground or background.

Inherited Members

ISequencer<ILoadPhase>.OnSequenceableStarted

ISequencer<ILoadPhase>.OnSequenceableCanceled

ISequencer<ILoadPhase>.OnSequenceableReverted

ISequencer<ILoadPhase>.OnSequenceableCompleted

ISequencer<ILoadPhase>.OnSequenceableException

ISequencer<ILoadPhase>.Sequenceables

ISequencer<ILoadPhase>.IsRunning

ISequencer<ILoadPhase>.Enqueue(SequenceFlow, ILoadPhase[])

ISequencer<ILoadPhase>.InsertAfter(ILoadPhase, SequenceFlow, ILoadPhase[])

ISequencer<ILoadPhase>.InsertBefore(ILoadPhase, SequenceFlow, ILoadPhase[])

ISequencer<ILoadPhase>.CreateParallelSequenceableCollection(ILoadPhase[])

ISequencer<ILoadPhase>.Remove(ILoadPhase)

ISequencer<ILoadPhase>.Start()

ISequencer<ILoadPhase>.Cancel(ILoadPhase)

ISequencer<ILoadPhase>.CancelAll()

ISequencer<ILoadPhase>.RevertTo(ILoadPhase, Boolean)

ISequencer<ILoadPhase>.Reset()

ISequencer<ILoadPhase>.Cleanup()

ISequencer<ILoadPhase>.GenerateReport()

IProgressable.OnProgress

IProgressable.NormalizedProgress

IInjectable.Inject(IResolver)

Namespace: IdleKit.Core

Assembly: cs.temp.dll.dll

Syntax

public interface ILoader : ISequencer<ILoadPhase>, IProgressable, IInjectable

Methods

GetAllLoadPhases()

Returns all ILoadPhase objects in the ILoader.

Declaration

List<ILoadPhase> GetAllLoadPhases()

Returns

Type	Description
List<ILoadPhase>

GetAllLoadPhases(Type)

Returns all ILoadPhase objects of a specific Type. The Type of ILoadPhase objects to find.

Declaration

List<ILoadPhase> GetAllLoadPhases(Type loadPhaseType)

Parameters

Type	Name	Description
Type	loadPhaseType

Returns

Type	Description
List<ILoadPhase>

GetAllLoadPhases<TLoadPhase>()

Returns all ILoadPhase objects of a specific Type defined by TLoadPhase.

Declaration

List<TLoadPhase> GetAllLoadPhases<TLoadPhase>()
    where TLoadPhase : ILoadPhase

Returns

Type	Description
List<TLoadPhase>

Type Parameters

Name	Description
TLoadPhase	The Type of the ILoadPhase objects to find.

GetLoadPhase(Type, Func<ILoadPhase, Boolean>)

Returns a specific ILoadPhase based on the supplied Type and an optional predicate.

Declaration

ILoadPhase GetLoadPhase(Type loadPhaseType, Func<ILoadPhase, bool> predicate = null)

Parameters

Type	Name	Description
Type	loadPhaseType	The Type of ILoadPhase to find.
Func<ILoadPhase, Boolean>	predicate	Thee criteria the ILoadPhase must meet before being returned.

Returns

Type	Description
ILoadPhase

GetLoadPhase<TLoadPhase>(Func<TLoadPhase, Boolean>)

Returns a specific ILoadPhase based on the TLoadPhase and an optional predicate.

Declaration

TLoadPhase GetLoadPhase<TLoadPhase>(Func<TLoadPhase, bool> predicate = null)
    where TLoadPhase : ILoadPhase

Parameters

Type	Name	Description
Func<TLoadPhase, Boolean>	predicate	Thee criteria the ILoadPhase must meet before being returned.

Returns

Type	Description
TLoadPhase

Type Parameters

Name	Description
TLoadPhase	The Type of the ILoadPhase to find.

SetStartOfBackgroundPhases(ILoadPhase)

Sets the first background ILoadPhase object in the queue. All objects after and including this one will be loaded in the background.

Declaration

void SetStartOfBackgroundPhases(ILoadPhase firstBackgroundPhase)

Parameters

Type	Name	Description
ILoadPhase	firstBackgroundPhase	The first ILoadPhase object to load in the background.

Events

OnBackgroundLoadCompleted

Broadcast when the background ILoadPhase objects have finished running.

Declaration

event Action OnBackgroundLoadCompleted

Event Type

Type	Description
Action

OnForegroundLoadCompleted

Broadcast when the foreground ILoadPhase objects have finished running.

Declaration

event Action OnForegroundLoadCompleted

Event Type

Type	Description
Action