Method in Declaration

Summary

public override int GetHashCode()

Method in Declaration

Summary

public override bool Equals(object obj)

Parameters

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; }

Class in Yarn.Compiler

Inherits from System.Object

Summary

public class Declaration

Constructors

Fields

Methods

Properties

Property in

Summary

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

public bool IsImplicit { get; internal set; }

Property in

Summary

Gets the name of this Declaration.

public string Name { get; internal set; }

Property in

Summary

Gets a string describing the purpose of this .

public string Description { get; internal set; }

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.

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

Parameters

Returns

A new instance of the Declaration class.

Constructor in

Summary

public Declaration()

Property in

Summary

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

public int SourceNodeLine { get; internal set; }

Remarks

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

Method in

Summary

public override string ToString()

Field in

Summary

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

public const string ExternalDeclaration = "(External)";

Property in

Summary

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

public string SourceFileName { get; internal set; }

Remarks

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

Property in

Summary

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

public int SourceFileLine { get; internal set; }

Remarks

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

Property in

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 .

Property in

Summary

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