All pages
Powered by GitBook
1 of 7

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

DestinationNode

Property in Option

Summary

Gets the name of the node that will be run if this option is selected.

public string DestinationNode { get; private set; }

Remarks

The value of this property not be valid if this is a shortcut option.

OptionSet

Struct in Yarn

Inherits from System.ValueType

Summary

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

Remarks

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

Properties

Name
Description

Structs

Name
Description

See Also

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

ID

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 .

Option

Struct in

Inherits from System.ValueType

Summary

An option to be presented to the user.

IsAvailable

Property in

Summary

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

public struct OptionSet

Options

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

Option

An option to be presented to the user.

Dialogue
Dialogue.OptionsHandler
OptionsHandler
SetSelectedOption(int)
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).

public bool IsAvailable { get; private set; }
Option
Properties
Name
Description

Gets the name of the node that will be run if this option is selected.

Gets the identifying number for this option.

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

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

public struct Option
OptionSet

Options

Property in OptionSet

Summary

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

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

See Also

  • : An option to be presented to the user.

Line

Property in

Summary

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

Option
DestinationNode
ID
IsAvailable
Line
Line
Remarks

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

public Line Line { get; private set; }
Option
Line