All pages
Powered by GitBook
1 of 16

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Equals(object)

Method in

Name
Description
public override bool Equals(object obj)

object obj

Summary

Parameters

Declaration

ToString()

Method in

public override string ToString()

Summary

Declaration

Declaration

Class in Yarn.Compiler

Inherits from System.Object

Summary

Represents a variable declaration

public class Declaration

Fields

Name
Description

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

Methods

Name
Description
Name
Description

Creates a new instance of the class, using the given name, type and default value.

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

Gets a string describing the purpose of this .

Properties

ExternalDeclaration
SourceFileName

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

Gets a value indicating whether this Declaration represents a variable.

Gets the name of this Declaration.

Gets the range of text at which this declaration occurs.

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

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

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

Gets the type of the variable, as represented by an object that implements .

CreateVariable(string,Yarn.IType,IConvertible,string)
Declaration
Equals(object)
GetHashCode()
DefaultValue
Declaration
Dialogue
IVariableStorage
Description
Declaration
IsImplicit
ToString()
IsVariable
Name
Range
SourceFileLine
SourceFileName
SourceNodeName
Type
IType

Name

Property in

Gets the name of this Declaration.

public string Name { get; internal set; }

Summary

Declaration

IsImplicit

Property in

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

public bool IsImplicit { get; internal set; }

Summary

Declaration

GetHashCode()

Method in

public override int GetHashCode()

Summary

Declaration

Range

Property in

Gets the range of text at which this declaration occurs.

This range refers to the declaration of the symbol itself, and not any syntax surrounding it. For example, the declaration <<declare $x = 1>> would have a Range referring to the $x symbol.

public Range Range { get; internal set; };

Summary

Remarks

Declaration

ExternalDeclaration

Field in

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

public const string ExternalDeclaration = "(External)";

Summary

Declaration
SourceFileName

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

Method in Declaration

Summary

Creates a new instance of the Declaration class, using the given name, type and default value.

public static Declaration CreateVariable(string name, Yarn.IType type, IConvertible defaultValue, string description = null)

Parameters

Name
Description

string name

The name of the new declaration.

A new instance of the class.

type

The type of the 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.

Returns

Declaration
Yarn.IType

SourceFileName

Property in

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

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

public string SourceFileName { get; internal set; }

Summary

Remarks

Declaration
Declaration
ExternalDeclaration

Type

Property in

Gets the type of the variable, as represented by an object that implements .

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

Summary

Declaration
IType

Description

Property in

Gets a string describing the purpose of this .

public string Description { get; internal set; }

Summary

Declaration
Declaration

SourceFileLine

Property in

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

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

public int SourceFileLine { get };

Summary

Remarks

Declaration
Declaration

IsVariable

Property in

Gets a value indicating whether this Declaration represents a variable.

public bool IsVariable { get };

Summary

Declaration

SourceNodeName

Property in

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

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

public string SourceNodeName { get; internal set; }

Summary

Remarks

Declaration
Declaration

DefaultValue

Property in

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

public IConvertible DefaultValue { get; internal set; }

Summary

Declaration
Declaration
Dialogue
IVariableStorage