Struct in Yarn

Inherits from System.ValueType

Summary

A set of Option s, sent from the Dialogue to the game.

Remarks

You typically do not create instances of this struct yourself. They are created by the Dialogue during program execution.

Properties

Structs

See Also

• Dialogue.OptionsHandler: Gets or sets the OptionsHandler that is called when a set of options are ready to be shown to the user.

Property in OptionSet

Summary

Gets the Option s that should be presented to the user.

public Option[] Options { get; private set; }

See Also

• Option: An option to be presented to the user.

Struct in OptionSet

Inherits from System.ValueType

Summary

An option to be presented to the user.

Properties

Property in Option

Summary

Gets the identifying number for this option.

public int ID { get; private set; }

Remarks

When the user selects this option, this value should be used as the parameter for SetSelectedOption(int) .

Property in Option

Summary

Gets a value indicating whether the player should be permitted to select this option.

public bool IsAvailable { get; private set; }

Remarks

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

Property in Option

Summary

Gets the Line that should be presented to the user for this option.

public Line Line { get; private set; }

Remarks

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