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).

OptionSet.Option

An option to be presented to the user.
public struct Option

Inherits from System.ValueType

#Properties

#ID

Gets the identifying number for this option.
public int ID { get; private set; }

Type Int32

You should not rely on this value being the same as the index of the option inside the OptionSet

#IsAvailable

Gets a value indicating whether the player should be permitted to select this option.
public bool IsAvailable { get; private set; }

Type Boolean

If this value is false, this option had a line condition on it that failed. The option will still be delivered to the game, but, depending on the needs of the game, the game may decide to not allow the player to select it, or not offer it to the player at all.

This is intended for situations where games wish to show options that the player _could_ have taken, if some other condition had been met (e.g. having enough "charisma" points).

#Line

Gets the Line that should be presented to the user for this option.
public Line Line { get; private set; }

Type Line

See the documentation for the Line class for information on how to prepare a line before presenting it to the user.

Generated from Yarn Spinner for Unity 3.3.