CompilationJob
public struct CompilationJobInherits from System.ValueType
#Nested Types
- File classRepresents the contents of a file to compile.
- Raw classRepresents a
stringbeing passed in directly for the compiler to use. This is in constrast to loading it from a file. Mostly used internally for testing. - Type enumThe type of compilation that the compiler will do.
#Fields
#CompilationType
#Declarations
public IEnumerable<Declaration> Declarations;Type IEnumerable
#Inputs
public IEnumerable<ISourceInput> Inputs;Type IEnumerable
#Properties
#CancellationToken
public CancellationToken CancellationToken { get; set; }Type CancellationToken
#DiagnosticSeverities
public IDictionary<string, Diagnostic.DiagnosticSeverity>? DiagnosticSeverities { get; internal set; }Type IDictionary
#Files Obsolete
Use Inputs
public IEnumerable<File> Files { get; }Type IEnumerable
#LanguageVersion
public int LanguageVersion { get; set; }Type Int32
#TypeDeclarations
public IEnumerable<IType>? TypeDeclarations { get; set; }Type IEnumerable
#VariableDeclarations Obsolete
Use Declarations
public IEnumerable<Declaration> VariableDeclarations { readonly get; set; }Type IEnumerable
#Methods
#CreateFromFiles(IEnumerable<string>)
public static CompilationJob CreateFromFiles(IEnumerable<string> paths)Parameters
pathsSystem.Collections.Generic.IEnumerable<string>The paths to the files.
Returns CompilationJob: A new CompilationJob.
#CreateFromFiles(string[])
public static CompilationJob CreateFromFiles(params string[] paths)Parameters
pathsstring[]The paths to the files.
Returns CompilationJob: A new CompilationJob.
#CreateFromInputs(IEnumerable<ISourceInput>, IEnumerable<Declaration>?, int)
public static CompilationJob CreateFromInputs(IEnumerable<ISourceInput> inputs, IEnumerable<Declaration>? declarations = null, int languageVersion = Project.CurrentProjectFileVersion)Parameters
inputsSystem.Collections.Generic.IEnumerable<Yarn.Compiler.ISourceInput>The inputs to the compilation.declarationsSystem.Collections.Generic.IEnumerable<Yarn.Compiler.Declaration>Any external declarations necessary for the compilationlanguageVersionintThe version of the Yarn language and project
Returns CompilationJob: A new CompilationJob.
#CreateFromProject(Project)
public static CompilationJob CreateFromProject(Project project)Parameters
projectYarn.Compiler.ProjectThe project to use for compilation
Returns CompilationJob
#CreateFromProject(string)
public static CompilationJob CreateFromProject(string projectPath)Parameters
project(unknown)The project to use for compilationprojectPathstring
Returns CompilationJob
#CreateFromString(string, string, IEnumerable<Declaration>?, int)
public static CompilationJob CreateFromString(string inputName, string source, IEnumerable<Declaration>? declarations = null, int languageVersion = Project.CurrentProjectFileVersion)Parameters
inputNamestringThe name to assign to the compiled file.sourcestringThe text to compile.declarationsSystem.Collections.Generic.IEnumerable<Yarn.Compiler.Declaration>Any external declarations necessary for the compilationlanguageVersionintThe version of the Yarn language to use.
Returns CompilationJob: A new CompilationJob.
Generated from Yarn Spinner for Unity 3.3.