Class Sequence

Namespace

nadena.dev.ndmf.fluent

Represents a sequence of passes that will execute in order (but not necessarily directly after one another), and allows this sequence to be built up.

public sealed class Sequence

Inheritance

object

Sequence

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AfterPass(string, string, int)

public Sequence AfterPass(string qualifiedName, string sourceFile = "", int sourceLine = 0)

Parameters

qualifiedName string

sourceFile string

sourceLine int

Returns

Sequence

AfterPass<T>(T, string, int)

public Sequence AfterPass<T>(T pass, string sourceFile = "", int sourceLine = 0) where T : Pass<T>, new()

Parameters

pass T

sourceFile string

sourceLine int

Returns

Sequence

Type Parameters

T

AfterPlugin(string, string, int)

public Sequence AfterPlugin(string qualifiedName, string sourceFile = "", int sourceLine = 0)

Parameters

qualifiedName string

sourceFile string

sourceLine int

Returns

Sequence

AfterPlugin<T>(string, int)

public Sequence AfterPlugin<T>(string sourceFile = "", int sourceLine = 0) where T : Plugin<T>, new()

Parameters

sourceFile string

sourceLine int

Returns

Sequence

Type Parameters

T

AfterPlugin<T>(T, string, int)

public Sequence AfterPlugin<T>(T plugin, string sourceFile = "", int sourceLine = 0) where T : Plugin<T>, new()

Parameters

plugin T

sourceFile string

sourceLine int

Returns

Sequence

Type Parameters

T

BeforePlugin(string, string, int)

public Sequence BeforePlugin(string QualifiedName, string sourceFile = "", int sourceLine = 0)

Parameters

QualifiedName string

sourceFile string

sourceLine int

Returns

Sequence

BeforePlugin<T>(string, int)

public Sequence BeforePlugin<T>(string sourceFile = "", int sourceLine = 0) where T : Plugin<T>, new()

Parameters

sourceFile string

sourceLine int

Returns

Sequence

Type Parameters

T

BeforePlugin<T>(T, string, int)

public Sequence BeforePlugin<T>(T plugin, string sourceFile = "", int sourceLine = 0) where T : Plugin<T>, new()

Parameters

plugin T

sourceFile string

sourceLine int

Returns

Sequence

Type Parameters

T

Run(string, InlinePass, string, int)

Declares a pass using an inline callback. This pass cannot be referenced by other plugins for the purpose of setting BeforePass/AfterPass constraints.

public DeclaringPass Run(string displayName, InlinePass inlinePass, string sourceFile = "", int sourceLine = 0)

Parameters

displayName string

The name of the pass to show in debug output

inlinePass InlinePass

A callback to invoke when the pass is executed

sourceFile string

sourceLine int

Returns

DeclaringPass

Run<T>(T, string, int)

Registers a pass to run in this sequence.

public DeclaringPass Run<T>(T pass, string sourceFile = "", int sourceLine = 0) where T : Pass<T>, new()

Parameters

pass T

The pass to run

sourceFile string

sourceLine int

Returns

DeclaringPass

A DeclaringPass object that can be used to set BeforePass/BeforePlugin constraints

Type Parameters

T

WaitFor<T>(T, string, int)

public Sequence WaitFor<T>(T pass, string sourceFile = "", int sourceLine = 0) where T : Pass<T>, new()

Parameters

pass T

sourceFile string

sourceLine int

Returns

Sequence

Type Parameters

T

WithCompatibleExtension(string, Action<Sequence>)

Declares that a group of passes are compatible with a given extension - that is, they will not deactivate the extension if it is already active.

sequence.WithCompatibleExtension("foo.bar.MyExtension", s => {
  s.Run(typeof(MyPass));
});

public void WithCompatibleExtension(string extension, Action<Sequence> action)

Parameters

extension string

The extension to permit

action Action<Sequence>

An action that will be invoked with the extensions marked compatible

WithCompatibleExtension(Type, Action<Sequence>)

Declares that a group of passes are compatible with a given extension - that is, they will not deactivate the extension if it is already active.

sequence.WithCompatibleExtension(typeof(MyExtension), s => {
  s.Run(typeof(MyPass));
});

public void WithCompatibleExtension(Type extension, Action<Sequence> action)

Parameters

extension Type

The extension to permit

action Action<Sequence>

An action that will be invoked with the extensions marked compatible

WithCompatibleExtensions(IEnumerable<string>, Action<Sequence>)

Declares that a group of passes are compatible with a given set of extensions - that is, they will not deactivate the extensions if already active.

sequence.WithCompatibleExtensions(new[] {"foo.bar.MyExtension"}, s => {
  s.Run(typeof(MyPass));
});

public void WithCompatibleExtensions(IEnumerable<string> extensions, Action<Sequence> action)

Parameters

extensions IEnumerable<string>

The extensions to permit

action Action<Sequence>

An action that will be invoked with the extensions marked compatible

WithCompatibleExtensions(IEnumerable<Type>, Action<Sequence>)

Declares that a group of passes are compatible with given extensions - that is, they will not deactivate the extensions if already active.

sequence.WithCompatibleExtensions(new[] {typeof(MyExtension)}, s => {
  s.Run(typeof(MyPass));
});

public void WithCompatibleExtensions(IEnumerable<Type> extensions, Action<Sequence> action)

Parameters

extensions IEnumerable<Type>

The extensions to permit

action Action<Sequence>

An action that will be invoked with the extensions marked compatible

WithRequiredExtension(Type, Action<Sequence>)

Declares that a group of passes require a given extension - that is, they will activate the extension before executing.

sequence.WithRequiredExtension(typeof(foo.bar.MyExtension), s => {
  s.Run(typeof(MyPass));
});

public void WithRequiredExtension(Type extension, Action<Sequence> action)

Parameters

extension Type

The extension to request

action Action<Sequence>

An action that will be invoked with the extensions marked required

WithRequiredExtensions(IEnumerable<Type>, Action<Sequence>)

Declares that a group of passes require a given set of extensions - that is, they will activate the extensions before executing.

sequence.WithRequiredExtensions(new[] {typeof(foo.bar.MyExtension)}, s => {
  s.Run(typeof(MyPass));
});

public void WithRequiredExtensions(IEnumerable<Type> extensions, Action<Sequence> action)

Parameters

extensions IEnumerable<Type>

action Action<Sequence>

An action that will be invoked with the extensions marked required