Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

CompilationJob.File

Represents the contents of a file to compile.
public class File : ISourceInput

Inherits from System.Object

Implements Yarn.Compiler.ISourceInput

#Constructors

#File(string)

Creates a new File from a path, either from an absolute or relative path.
public File(string path)

Parameters

  • pathstring
    The path to the file. Is mapped to Path property.

#Fields

#Source

The source code of this file.
public string Source = string.Empty;

Type String

#Properties

#Name

The name of the input. Must be unique across the entire list of all inputs.
public string Name { get }

Type String

#Path

The path of the file
public string Path { get; set; }

Type String

This can be a relative or absolute path provided other pieces of the pipeline can manage to process it for diagnostic and debug purposes

Generated from Yarn Spinner for Unity 3.3.