Method in

Summary

Property in Declaration

Summary

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

public IConvertible? DefaultValue { get; internal set; }

Property in Declaration

Summary

Gets the collection of Declaration objects that this Declaration depends upon the value of.

public IEnumerable<Declaration> Dependencies { get; internal set; };

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

Class in Yarn.Compiler

Inherits from System.Object

Summary

Represents a variable declaration

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, IType type, IConvertible defaultValue, string? description = null)

Parameters

Returns

A new instance of the Declaration class.

Property in

Summary

Gets the collection of objects whose value depends upon this .

Property in

Summary

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

Property in

Summary

Gets or sets the parser context for the initial value provided in this variable's 'declare' statement, if any. This is only valid for variable declarations, not functions (because functions don't have a value.)

Property in

Summary

Gets a value indicating whether this Declaration represents a variable, and not a function.

Property in

Summary

Gets a value indicating that this Declaration does not refer to a stored variable, and instead represents an inline-expanded expression (a 'smart variable').

Property in

Summary

Gets a string describing the purpose of this .

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.

Property in

Summary

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

Remarks

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

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.

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 the type of the variable, as represented by an object that implements .

Property in

Summary

Gets the name of this Declaration.