All pages
Powered by GitBook
1 of 13

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

baseLocalization

Field in YarnProject

Summary

public Localization baseLocalization;

YarnProject

Class in

Inherits from UnityEngine.ScriptableObject

Summary

lineMetadata

Field in YarnProject

Summary

public LineMetadata lineMetadata;
Fields
Name
Description

Methods

Name
Description

Gets the headers for the requested node.

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

Properties

Name
Description

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 .

Gets the Yarn Program stored in this project.

Yarn.Unity
public class YarnProject : ScriptableObject

searchAssembliesForActions

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

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

Program

Property in YarnProject

Summary

Gets the Yarn Program stored in this project.

public Program Program
{
            get; }

Remarks

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

InitialValues

Property in

Summary

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

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

localizations

Field in YarnProject

Summary

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

compiledYarnProgram

Field in YarnProject

Summary

public byte[] compiledYarnProgram;

GetLocalization(string)

Method in YarnProject

Summary

public Localization GetLocalization(string localeCode)

Parameters

Name
Description

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 and cached inside Yarn.Unity.YarnProject.nodeHeaders . Future calls will then return the cached values.

Parameters

Name
Description

searchAssembliesForActions

Field in

Summary

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

string localeCode

string nodeName

Program
public List<string> searchAssembliesForActions = new List<string>();
YarnProject
DialogueRunner

localizationType

Field in YarnProject

Summary

public LocalizationType localizationType;

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

Returns

The ids of all lines and options in the requested nodes

System.Collections.Generic.IEnumerable<string> nodes

the names of all nodes whos line IDs you covet

NodeNames

Property in YarnProject

Summary

The names of all nodes contained within the Program .

public string[] NodeNames
{
            get; }