Summary

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

Classes

Enums

Structs

Class in Yarn.Compiler.Upgrader

Inherits from System.Object

Summary

public class OrderedSet<T> : ICollection<T>

Constructors

Methods

Properties

Method in

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.

Parameters

Returns

An object containing the results of the upgrade operation.

Class in

Inherits from System.Object

Summary

Contains methods for upgrading the syntax of Yarn scripts.

Methods

Constructor in

Summary

Parameters

Constructor in

Summary

Method in OrderedSet

Summary

public IEnumerator<T> GetEnumerator()

Method in OrderedSet

Summary

public void Add(IEnumerable<T> items)

Parameters

Method in OrderedSet

Summary

public bool Add(T item)

Parameters

Method in OrderedSet

Summary

public bool Contains(T item)

Parameters

Method in OrderedSet

Summary

public void CopyTo(T[] array, int arrayIndex)

Parameters

Property in OrderedSet

Summary

public virtual bool IsReadOnly { get };

Struct in Yarn.Compiler.Upgrader

Inherits from System.ValueType

Summary

Contains information describing a replacement to make in a string.

public struct TextReplacement

Fields

Properties

Field in

Summary

A descriptive comment explaining why the substitution is necessary.

Property in

Summary

Field in TextReplacement

Summary

The string to expect at Start in the original string.

public string OriginalText;

Method in OrderedSet

Summary

public void Clear()

Field in TextReplacement

Summary

The string to replace OriginalText with at Start .

public string ReplacementText;

Method in

Summary

Parameters

Property in

Summary

Gets the length of .

Struct in

Inherits from System.ValueType

Summary

Constructors

Fields

Field in

Summary

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

Field in UpgradeJob

Summary

public List<Yarn.Compiler.CompilationJob.File> Files;

Field in TextReplacement

Summary

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

public int StartLine;

Field in

Summary

Struct in

Inherits from System.ValueType

Summary

Fields

Properties

Structs

Property in

Summary

Gets the length of .

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 OutputFile

Summary

public string OriginalSource;

Field in OutputFile

Summary

public string Path;

Property in OutputFile

Summary

public string UpgradedSource { get };

Struct in UpgradeResult

Inherits from System.ValueType

Summary

public struct OutputFile

Fields

Properties

Constructor in UpgradeJob

Summary

public UpgradeJob(UpgradeType upgradeType, IEnumerable<CompilationJob.File> files)

Parameters

Field in OutputFile

Summary

public IEnumerable<TextReplacement> Replacements;

Field in OutputFile

Summary

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

public bool IsNewFile;

Enumeration Member in UpgradeType

Summary

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

Version1to2

Enum in Yarn.Compiler.Upgrader

Inherits from System.Enum

Summary

Specifies what kind of language upgrading should be applied.

public enum UpgradeType
{
    Version1to2
}

Members

Field in

Summary