Method in Utility
Parses a string of Yarn source code, and produces a FileParseResult and (if there were any problems) a collection of diagnostics.
string
source
The source code to parse.
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.
Method in Utility
Generates a Yarn script that contains a node that declares variables.
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 DeclarationsOnly ), allow the user to make changes, and then write the changes to disk by calling this method and saving the results.
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.
A string containing a Yarn script that declares the specified variables.
The collection of objects to include in the output.
Method in Utility
Given Yarn source code, adds line tags to the ends of all lines that need one and do not already have one.
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.
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.
The modified source code, with line tags added.
Class in Yarn.Compiler
Inherits from System.Object
Utility methods for working with line tags.
Given Yarn source code, adds line tags to the ends of all lines that need one and do not already have one.
Finds and collates every jump in every node.
Generates a Yarn script that contains a node that declares variables.
Parses a string of Yarn source code, and produces a FileParseResult and (if there were any problems) a collection of diagnostics.
Method in Utility
System.Collections.Generic.IEnumerable<Yarn.Node>
nodes
Method in Utility
Finds and collates every jump in every node.
string[]
YarnFileContents
The collection of yarn file content to parse and walk
A list of lists of GraphingNode each containing a node, its jumps, and any positional info.