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

YarnOptionItem

single option button wrapping a Button with availability state handling.
class_name YarnOptionItem
extends Control

Inherits from Control

#Properties

#button

var button: Button

Type Button

#disabled_strike_through

var disabled_strike_through: bool = true

Type bool

#is_available

var is_available: bool = true

Type bool

#option

var option: YarnOption

Type YarnOption

#option_index

var option_index: int = -1

Type int

#show_when_unavailable

var show_when_unavailable: bool = true

Type bool

#text_label

optional; falls back to button text
var text_label: Control

Type Control

#unavailable_indicator

var unavailable_indicator: Control

Type Control

#Signals

#option_selected

signal option_selected(option_index: int)

Parameters

  • option_indexint

#Methods

#get_button()

func get_button() -> Button

Returns Button

#grab_focus_if_available()

func grab_focus_if_available() -> void

#invoke_option_selected()

func invoke_option_selected() -> void

#is_highlighted()

func is_highlighted() -> bool

Returns bool

#reset()

func reset() -> void

#set_available(bool)

func set_available(available: bool) -> void

Parameters

  • availablebool

#set_text(String)

func set_text(text: String) -> void

Parameters

  • textString

#setup(YarnOption, int)

func setup(yarn_option: YarnOption, index: int) -> void

Parameters

Generated from Yarn Spinner for Godot GDScript 3.3.