Class NullPhase

Namespace

Uncreated.Warfare.Layouts.Phases

Assembly

Uncreated.Warfare.dll

Instantly skipped phase.

public class NullPhase : ILayoutPhase

Inheritance

object

NullPhase

Implements

ILayoutPhase

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NullPhase(IConfiguration)

public NullPhase(IConfiguration config)

Parameters

config IConfiguration

Properties

Configuration

The configuration section used to create this phase.

public IConfiguration Configuration { get; }

Property Value

IConfiguration

IsActive

If this phase is currently activated.

public bool IsActive { get; }

Property Value

bool

Name

Display name of the phase.

public 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.

public 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.

public 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.

public UniTask InitializePhaseAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

UniTask