Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

TypeBase

Provides the base class for all concrete types.
public abstract class TypeBase : IType, IEquatable<TypeBase>

Inherits from System.Object

Implements Yarn.IType, System.IEquatable{Yarn.TypeBase}

#Properties

#ConvertibleToTypes

Gets the collection of types that this type may be converted to.
public IReadOnlyCollection<IType> ConvertibleToTypes { get }

Type IReadOnlyCollection

#Description

Gets a string describing this type.
public abstract string Description { get; }

Type String

#Methods

Gets the collection of methods that are defined on this type.
public virtual IReadOnlyDictionary<string, Delegate> Methods { get }

Type IReadOnlyDictionary

#Name

Gets the name of this type.
public abstract string Name { get; }

Type String

#Parent

Gets the parent of this type.
public abstract IType? Parent { get; }

Type IType

#TypeMembers

Gets a dictionary containing the members of this type.
public IReadOnlyDictionary<string, ITypeMember> TypeMembers { get }

Type IReadOnlyDictionary

#Methods

#Equals(object)

public override bool Equals(object obj)

Parameters

  • objobject

Returns Boolean

#Equals(TypeBase)

public bool Equals(TypeBase other)

Parameters

Returns Boolean

#GetHashCode()

public override int GetHashCode()

Returns Int32

#IsAncestorOf(TypeBase)

Gets whether this type is an ancestor of other.
public bool IsAncestorOf(TypeBase other)

Parameters

Returns Boolean: true if this type is an ancestor of other; false otherwise.

#IsConvertibleTo(TypeBase)

Checks if this type is convertible to the type represented by otherType.
public bool IsConvertibleTo(TypeBase otherType)

Parameters

Returns Boolean: true if this type is convertible to otherType.

A type is convertible to another type if:
  1. there is an explicit conversion available, or
  2. it is a descendant of that type, or
  3. the two types are identical.

#ToString()

public override string ToString();

Returns String

Generated from Yarn Spinner for Unity 3.3.