Interface ILayoutPhase

Namespace

Uncreated.Warfare.Layouts.Phases

Assembly

Uncreated.Warfare.dll

Represents a phase of a Layout.

public interface ILayoutPhase

Properties

Configuration

The configuration section used to create this phase.

IConfiguration Configuration { get; }

Property Value

IConfiguration

IsActive

If this phase is currently activated.

bool IsActive { get; }

Property Value

bool

Name

Display name of the phase.

string Name { get; }

Property Value

string

Methods

BeginPhaseAsync(CancellationToken)

Activates the phase. This should happen just after the old phase ended if there was one.

UniTask BeginPhaseAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

UniTask

Remarks

Must set IsActive to true or the phase will be skipped.

EndPhaseAsync(CancellationToken)

Deactivates the phase.

UniTask EndPhaseAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

UniTask

InitializePhaseAsync(CancellationToken)

Invoked before the layout starts. Meant to be used for loading extra configuration information.

UniTask InitializePhaseAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

UniTask