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)";

Property in Declaration

Summary

Gets a string describing the purpose of this Declaration .

public string Description { get; internal set; }

Class in Yarn.Compiler

Inherits from System.Object

Summary

public class Declaration

Fields

Methods

Properties

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

Returns

A new instance of the Declaration class.

Method in Declaration

Summary

public override bool Equals(object obj)

Parameters

Property in

Summary

Gets the name of this Declaration.

Property in

Summary

Gets the range of text at which this declaration occurs.

Remarks

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.

Method in

Summary

Property in

Summary

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

Remarks

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

Property in

Summary

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

Property in

Summary

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

Remarks

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

Method in

Summary

Property in

Summary

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

Property in Declaration

Summary

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

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

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 Declaration was not found in a Yarn source file, this will be null .