1 of 9

Utility

Class in

Inherits from System.Object

Summary

Utility methods for working with line tags.

Methods

Name

Description

AddTagsToLines(string,ICollection<string>)

Method in

This method is obsolete and may be removed from a future version of Yarn Spinner: This method doesn't return the new tags, just the modified text which can cause issues with multiple files. Please use TagLines instead.

Summary

Given Yarn source code, adds line tags to the ends of all lines that need one and do not already have one.

Remarks

This method ensures that it does not generate line tags that are already present in the file, or present in the existingLineTags collection.

Line tags are added to any line of source code that contains user-visible text: lines, options, and shortcut options.

Parameters

Name

Description

Returns

The modified source code, with line tags added.

DetermineNodeConnections(string[])

Method in Utility

Summary

Finds and collates every jump in every node.

public static List<List<GraphingNode>> DetermineNodeConnections(string[] YarnFileContents)

Parameters

Name

Description

string[] YarnFileContents

The collection of yarn file content to parse and walk

Returns

A list of lists of GraphingNode each containing a node, its jumps, and any positional info.

ExtractStringBlocks(IEnumerable<Node>,ProjectDebugInfo)

Method in Utility

Summary

Gets the collection of contiguous runs of lines in the provided nodes. Each run of lines is guaranteed to run to completion once entered.

public static List<List<string>> ExtractStringBlocks(IEnumerable<Node> nodes, ProjectDebugInfo projectDebugInfo)

Parameters

Name

Description

System.Collections.Generic.IEnumerable<Yarn.Node> nodes

The nodes to get string blocks for.

projectDebugInfo

Returns

A collection of runs of lines.

GenerateYarnFileWithDeclarations(IEnumerable<Yarn.Compiler.Declaration>,string,IEnumerable<string>?,IDictionary<string, string>?)

Method in Utility

Summary

Generates a Yarn script that contains a node that declares variables.

public static string GenerateYarnFileWithDeclarations(
    IEnumerable<Yarn.Compiler.Declaration> declarations,
    string title = "Program",
    IEnumerable<string>? tags = null,
    IDictionary<string, string>? headers = null)

Remarks

This method is intended to be called by tools that let the user manage variable declarations. Such tools can read the existing variable declarations in from a script (by compiling the script with the CompilationType value set to TypeCheck ), allow the user to make changes, and then write the changes to disk by calling this method and saving the results.

Parameters

Name

Description

System.Collections.Generic.IEnumerable<Yarn.Compiler.Declaration> declarations

string title

The title of the node that should be generated.

System.Collections.Generic.IEnumerable<string> tags

The collection of tags that should be generated for the node. If this is null , no tags will be generated.

System.Collections.Generic.IDictionary<string, string> headers

The collection of additional headers that should be generated for the node. If this is null , no additional headers will be generated.

Returns

A string containing a Yarn script that declares the specified variables.

GetCompiledCodeAsString(Program,Library?,CompilationResult?)

Method in Utility

Summary

Gets a string containing a representation of the compiled bytecode for a Program .

public static string GetCompiledCodeAsString(Program program, Library? l = null, CompilationResult? result = null)

Parameters

Name

Description

program

result

GetYarnValue(IConvertible)

Method in Utility

Summary

Returns an IYarnValue representation of the provided value.

public static IYarnValue? GetYarnValue(IConvertible clrValue)

Parameters

Name

Description

System.IConvertible clrValue

The value to get a Yarn representation of.

Returns

An IYarnValue representation of clrValue .

ParseSource(string)

Method in Utility

Summary

Parses a string of Yarn source code, and produces a FileParseResult and (if there were any problems) a collection of diagnostics.

public static (FileParseResult, IEnumerable<Diagnostic>) ParseSource(string source)

Parameters

Name

Description

string source

The source code to parse.

Returns

A tuple containing a FileParseResult that stores the parse tree and tokens, and a collection of Diagnostic objects that describe problems in the source code.

TagLines(string,ICollection<string>)

Method in Utility

Summary

Given Yarn source code, adds line tags to the ends of all lines that need one and do not already have one.

public static (string, IList<string>) TagLines(string contents, ICollection<string> existingLineTags = null)

Remarks

This method ensures that it does not generate line tags that are already present in the file, or present in the existingLineTags collection.

Line tags are added to any line of source code that contains user-visible text: lines, options, and shortcut options.

Parameters

Name

Description

string contents

The source code to add line tags to.

System.Collections.Generic.ICollection<string> existingLineTags

The collection of line tags already exist elsewhere in the source code; the newly added line tags will not be duplicates of any in this collection.

Returns

Tuple of the modified source code, with line tags added and the list of new line tags generated.

GenerateYarnFileWithDeclarations(IEnumerable<Yarn.Compiler.Declaration>,string,IEnumerable<string>?,IDictionary<string, string>?)

Method in Utility

Summary

Generates a Yarn script that contains a node that declares variables.

public static string GenerateYarnFileWithDeclarations(
    IEnumerable<Yarn.Compiler.Declaration> declarations,
    string title = "Program",
    IEnumerable<string>? tags = null,
    IDictionary<string, string>? headers = null)

Remarks

Parameters

Name

Description

System.Collections.Generic.IEnumerable<Yarn.Compiler.Declaration> declarations

The collection of objects to include in the output.

string title

The title of the node that should be generated.

System.Collections.Generic.IEnumerable<string> tags

The collection of tags that should be generated for the node. If this is null , no tags will be generated.

System.Collections.Generic.IDictionary<string, string> headers

The collection of additional headers that should be generated for the node. If this is null , no additional headers will be generated.

Returns

A string containing a Yarn script that declares the specified variables.