CompilationResult
public class CompilationResult : ICodeDumpHelperInherits from System.Object
Implements Yarn.ICodeDumpHelper
#Properties
#ContainsErrors
public bool ContainsErrors { get }Type Boolean
#ContainsImplicitStringTags
#line: tags.public bool ContainsImplicitStringTags { get; internal set; }Type Boolean
Every line is required to have a line ID. If a line doesn't have a
line ID specified in the source code (via a #line: tag), the
compiler will create one.
Implicit line IDs are guaranteed to remain the same between
compilations when the source file does not change. If you want line
IDs to remain the same when the source code may be modified in the
future, add a #line: tag to the line. This may be done by
hand, or added using the TagLines(ISourceInput,HashSet<string>?,ILineTagGenerator?,ILineTagGenerator.TagAbortBehaviour) method.
#DebugInfo Obsolete
Use ProjectDebugInfo.Nodes
public IReadOnlyDictionary<string, NodeDebugInfo> DebugInfo { get }Type IReadOnlyDictionary
#Declarations
public IEnumerable<Declaration> Declarations { get; internal set; }Type IEnumerable
null if the CompilationJob object's CompilationType value was not TypeCheck or FullCompilation.#Diagnostics
public IEnumerable<Diagnostic> Diagnostics { get; internal set; }Type IEnumerable
null. To help figure out
what the error is, users should consult the contents of this
property.#FileTags
public Dictionary<string, IEnumerable<string>> FileTags { get; internal set; }Type Dictionary
#NodeMetadata
public IEnumerable<NodeMetadata> NodeMetadata { get; internal set; }Type IEnumerable
#ParseResults
public IEnumerable<FileParseResult> ParseResults { get; internal set; }Type IEnumerable
#Program
public Program? Program { get; internal set; }Type Program
This value will be null if there were errors
in the compilation. If this is the case, Diagnostics
will contain information describing the errors.
It will also be null if the CompilationJob object's CompilationType value was not FullCompilation.
#ProjectDebugInfo
public ProjectDebugInfo? ProjectDebugInfo { get; internal set; }Type ProjectDebugInfo
#StringTable
public IDictionary<string, StringInfo>? StringTable { get; internal set; }Type IDictionary
#line: tag, or implicitly-generated line IDs that the
compiler added during compilation.#UserDefinedTypes
public IReadOnlyCollection<IType> UserDefinedTypes { get; internal set; }Type IReadOnlyCollection
#Methods
#GetDescriptionForVariable(string)
public string? GetDescriptionForVariable(string variableName)Parameters
variableNamestringThe name of the variable.
Returns String: The description for the variable, or null
if none was found.
#GetLabelsForNode(string)
public IReadOnlyDictionary<int, string> GetLabelsForNode(string node)Parameters
nodestringThe name of the node.
Returns IReadOnlyDictionary: The instruction label mapping.
#GetStringForKey(string)
public string? GetStringForKey(string key)Parameters
keystringThe key to fetch a string for.
Returns String: The found string, or null if none was
found.
Generated from Yarn Spinner for Unity 3.3.