All pages
Powered by GitBook
1 of 7

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Option

Struct in OptionSet

Inherits from System.ValueType

Summary

An option to be presented to the user.

public struct 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.

DestinationNode

Property in

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

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

DestinationNode
ID
IsAvailable
Line
Line
public string DestinationNode { get; private set; }

Summary

Remarks

Option

ID

Property in

Gets the identifying number for this option.

When the user selects this option, this value should be used as the parameter for .

public int ID { get; private set; }

Summary

Remarks

Option
SetSelectedOption(int)

Options

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.

OptionSet

Struct in Yarn

Inherits from System.ValueType

Summary

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

public struct OptionSet

Remarks

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

Properties

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

Line

Property in

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

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

public Line Line { get; private set; }

Summary

Remarks

Option
Line
Line

Gets the s that should be presented to the user.

An option to be presented to the user.

Structs

See Also

Dialogue.OptionsHandler
OptionsHandler
Options
Option
Option

IsAvailable

Property in

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

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

Summary

Remarks

Option