Class in Yarn.Compiler.Upgrader

Inherits from System.Object

Summary

Contains methods for upgrading the syntax of Yarn scripts.

public static class LanguageUpgrader

Methods

Method in LanguageUpgrader

Summary

Upgrades a Yarn script from one version of the language to another, producing both the fully upgraded text as well as a collection of replacements.

public static UpgradeResult Upgrade(UpgradeJob upgradeJob)

Parameters

Returns

An object containing the results of the upgrade operation.

Summary

Contains classes for upgrading Yarn code to more recent versions of the language.

Classes

Method in

Constructor in

Method in

Property in

Method in

Field in

A descriptive comment explaining why the substitution is necessary.

Method in OrderedSet

Summary

public IEnumerator<T> GetEnumerator()

Constructor in OrderedSet

Summary

public OrderedSet()

Property in OrderedSet

Summary

public int Count { get };

Field in UpgradeJob

Summary

public UpgradeType UpgradeType;

Field in TextReplacement

Summary

The line in the original string where the substitution should be made.

public int StartLine;

Field in TextReplacement

Summary

The string to expect at Start in the original string.

public string OriginalText;

Property in TextReplacement

Summary

Gets the length of OriginalText .

public int OriginalLength { get };

Field in OutputFile

Summary

public IEnumerable<TextReplacement> Replacements;

Field in OutputFile

Summary

public IEnumerable<Diagnostic> Diagnostics;

Property in UpgradeResult

Summary

Gets a collection containing all Diagnostic objects across all of the files in Files .

public IEnumerable<Diagnostic> Diagnostics { get };

Field in TextReplacement

Summary

The position in the original string where the substitution should be made.

public int Start;

Method in OrderedSet

Summary

public bool Add(T item)

Parameters

Struct in Yarn.Compiler.Upgrader

Inherits from System.ValueType

Summary

public struct UpgradeJob

Constructors

Struct in

Inherits from System.ValueType

Enum in

Inherits from System.Enum

Specifies what kind of language upgrading should be applied.

Method in

Constructor in

Field in

The string to replace with at .

Field in

Enumeration Member in

Indicates an upgrade from Yarn Spinner 1.0 syntax to Yarn Spinner 2.0 syntax.

Property in

Gets the length of .

Field in

Field in

Field in UpgradeResult

Summary

public List<OutputFile> Files;

Property in OutputFile

Summary

public string UpgradedSource { get };

Struct in UpgradeResult

Inherits from System.ValueType

Summary

public struct OutputFile

Fields

Class in

Inherits from System.Object

Field in

Indicates whether this represents a new file to be created. If this is true , will be the empty string, and will be empty.

Struct in Yarn.Compiler.Upgrader

Inherits from System.ValueType

Summary

Contains information describing a replacement to make in a string.

public struct TextReplacement

Fields

Method in