All pages
Powered by GitBook
1 of 16

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Declaration()

Constructor in Declaration

Summary

public Declaration()

ExternalDeclaration

Field in Declaration

Summary

The string used for SourceFileName if the Declaration was found outside of a Yarn source file.

public const string ExternalDeclaration = "(External)";

ToString()

Method in Declaration

Summary

public override string ToString()

Equals(object)

Method in Declaration

Summary

public override bool Equals(object obj)

Parameters

Name
Description

CreateVariable(string,Yarn.IType,IConvertible,string)

Method in Declaration

Summary

Creates a new instance of the Declaration class, using the given name and default value. The ReturnType of the new instance will be configured based on the type of defaultValue , and the DeclarationType will be Type.Variable . All other properties will be their default values.

Parameters

Name
Description

Returns

A new instance of the class.

DefaultValue

Property in

Summary

Gets the default value of this , if no value has been specified in code or is available from a 's .

GetHashCode()

Method in

Summary

object obj

string name

The name of the new declaration.

System.IConvertible defaultValue

The default value of the declaration. This must be a string, a number (integer or floating-point), or boolean value.

string description

The description of the new declaration.

Yarn.IType type

Declaration
public IConvertible DefaultValue { get; internal set; }
Declaration
Declaration
Dialogue
IVariableStorage
public override int GetHashCode()
Declaration
public static Declaration CreateVariable(string name, Yarn.IType type, IConvertible defaultValue, string description = null)

Declaration

Class in Yarn.Compiler

Inherits from System.Object

Summary

Constructors

Name
Description

Fields

Name
Description

Methods

Name
Description

Properties

Name
Description

SourceNodeName

Property in Declaration

Summary

Gets the name of the node in which this Declaration was found.

public string SourceNodeName { get; internal set; }

Remarks

If this was not found in a Yarn source file, this will be null .

Type

Property in

Summary

public class Declaration
Declaration
public Yarn.IType Type { get; internal set; }
Declaration

Gets the name of the file in which this Declaration was found.

Gets the line number at which this Declaration was found in the node indicated by .

Gets the name of the node in which this Declaration was found.

Declaration()

ExternalDeclaration

The string used for SourceFileName if the Declaration was found outside of a Yarn source file.

CreateVariable(string,Yarn.IType,IConvertible,string)

Creates a new instance of the Declaration class, using the given name and default value. The ReturnType of the new instance will be configured based on the type of defaultValue , and the DeclarationType will be Type.Variable . All other properties will be their default values.

Equals(object)

GetHashCode()

ToString()

DefaultValue

Gets the default value of this Declaration , if no value has been specified in code or is available from a Dialogue 's IVariableStorage .

Description

Gets a string describing the purpose of this Declaration .

IsImplicit

Get or sets a value indicating whether this Declaration was implicitly inferred from usage.

Name

Gets the name of this Declaration.

SourceFileLine

The line number at which this Declaration was found in the source file.

SourceFileLine

Property in

Summary

The line number at which this Declaration was found in the source file.

Description

Property in

Summary

Gets a string describing the purpose of this .

IsImplicit

Property in

Summary

Get or sets a value indicating whether this Declaration was implicitly inferred from usage.

SourceFileName
SourceNodeLine
SourceNodeName
SourceNodeName
Type
Remarks

If this Declaration was not found in a Yarn source file, this will be -1.

public int SourceFileLine { get; internal set; }
Declaration
public string Description { get; internal set; }
Declaration
Declaration
public bool IsImplicit { get; internal set; }
Declaration

SourceFileName

Property in

Summary

Gets the name of the file in which this Declaration was found.

SourceNodeLine

Property in

Summary

Gets the line number at which this Declaration was found in the node indicated by .

Remarks

If this Declaration was not found in a Yarn source file, this will be ExternalDeclaration .

public string SourceFileName { get; internal set; }
Declaration
Remarks

If this Declaration was not found in a Yarn source file, this will be -1.

public int SourceNodeLine { get; internal set; }
Declaration
SourceNodeName

Name

Property in Declaration

Summary

Gets the name of this Declaration.

public string Name { get; internal set; }