All pages
Powered by GitBook
1 of 13

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

lineMetadata

Field in

public LineMetadata lineMetadata;

Summary

YarnProject

InitialValues

Property in

The default values of all declared or inferred variables in the . Organised by their name as written in the yarn files.

public Dictionary<string, System.IConvertible> InitialValues
{
            get; }

Summary

YarnProject
Program

baseLocalization

Field in

public Localization baseLocalization;

Summary

YarnProject

compiledYarnProgram

Field in

public byte[] compiledYarnProgram;

Summary

YarnProject

NodeNames

Property in

The names of all nodes contained within the .

public string[] NodeNames
{
            get; }

Summary

YarnProject
Program

GetLocalization(string)

Method in

Name
Description
public Localization GetLocalization(string localeCode)

string localeCode

Summary

Parameters

YarnProject

GetHeaders(string)

Method in YarnProject

Summary

Gets the headers for the requested node.

public Dictionary<string, List<string>> GetHeaders(string nodeName)

Remarks

The first time this is called, the values are extracted from Program and cached inside Yarn.Unity.YarnProject.nodeHeaders . Future calls will then return the cached values.

Parameters

Name
Description

string nodeName

localizationType

Field in

public LocalizationType localizationType;

Summary

YarnProject

GetLineIDsForNodes(IEnumerable<string>)

Method in YarnProject

Summary

Returns a list of all line and option IDs within the requested nodes

public IEnumerable<string> GetLineIDsForNodes(IEnumerable<string> nodes)

Remarks

This is intended to be used either to precache multiple nodes worth of lines or for debugging

Parameters

Name
Description

System.Collections.Generic.IEnumerable<string> nodes

The ids of all lines and options in the requested nodes

the names of all nodes whos line IDs you covet

Returns

localizations

Field in

public List<Localization> localizations = new List<Localization>();

Summary

YarnProject

YarnProject

Class in Yarn.Unity

Inherits from UnityEngine.ScriptableObject

Summary

public class YarnProject : ScriptableObject

Fields

Name
Description

Name
Description
Name
Description

The names of assemblies that ActionManager should look for commands and functions in when this project is loaded into a .

Gets the headers for the requested node.

Returns a list of all line and option IDs within the requested nodes

The default values of all declared or inferred variables in the . Organised by their name as written in the yarn files.

The names of all nodes contained within the .

Methods

Properties

baseLocalization

Gets the Yarn Program stored in this project.

compiledYarnProgram
lineMetadata
localizations
localizationType
searchAssembliesForActions
DialogueRunner
GetHeaders(string)
GetLineIDsForNodes(IEnumerable)
InitialValues
Program
NodeNames
Program
GetLocalization(string)
Program

Program

Property in

Gets the Yarn Program stored in this project.

The first time this is called, the program stored in is deserialized and cached. Future calls to this method will return the cached value.

public Program Program
{
            get; }

Summary

Remarks

YarnProject
compiledYarnProgram

searchAssembliesForActions

Field in

The names of assemblies that ActionManager should look for commands and functions in when this project is loaded into a .

public List<string> searchAssembliesForActions = new List<string>();

Summary

YarnProject
DialogueRunner