OptionButton

public OptionButton();

Creates an empty selector: Selected = -1, FitToLongestItem = true, AllowReselect = false, ToggleMode = true, ActionMode = Press. PopupMenu is created as a hidden internal child.

public bool AllowReselect { get; set; }

Allows repeated ItemSelected for the same menu row, default false. Does not make Select emit the signal.

public bool FitToLongestItem { get; set; }

Closed-button size accounts for all items and popup width, default true. Cache updates are deferred; false follows current label/icon and can change width on selection.

public int ItemCount { get; set; }

Count of all rows including separators. Setter creates empty rows or truncates the tail; count must be nonnegative. First change after runtime additions can reset current index: explicitly Select afterward.

public bool SearchBarEnabled { get; set; }

Enables popup search field, default false. Visibility also depends on SearchBarMinItemCount; does not select items or change IDs.

public bool SearchBarFuzzySearchEnabled { get; set; }

Matching with permitted misses, default true. Does not itself enable the search field; allowed misses are configured separately.

public int SearchBarFuzzySearchMaxMisses { get; set; }

Nonnegative maximum fuzzy-search misses, default 2. Not the visible result count.

public int SearchBarMinItemCount { get; set; }

Nonnegative search visibility threshold counting nonseparator rows, default 0. Applies when SearchBarEnabled is on.

public int Selected { get; set; }

Current row index, -1 for no selection. Setter/Select do not emit ItemSelected and can select disabled/separator rows. Explicitly restore selection by stable ID after structural changes.

public void AddIconItem(Texture2D texture, string label, int id = -1);

Adds an item with shared Texture2D, label and ID. Automatic ID depends on creation-time index; first available row is selected without a signal.

public void AddItem(string label, int id = -1);

Adds a labeled item with an ID. id = -1 uses creation-time index. The first available item is selected without ItemSelected; index and ID need not match.

public void AddSeparator(string text = "");

Adds a separator row with optional text. Increases ItemCount and affects following row indices; not an ordinary selectable item.

public void Clear();

Removes all rows, clears label/icon and sets Selected = -1. Does not emit ItemSelected.

public bool GetAllowReselect();

Allows repeated ItemSelected for the same menu row, default false. Does not make Select emit the signal.

public Entity.AutoTranslateModeEnum GetItemAutoTranslateMode(int idx);

Item-label translation mode: Inherit, Always or Disabled. Setting the selected row refreshes its display. Does not translate IDs/metadata.

public int GetItemCount();

Count of all rows including separators. Setter creates empty rows or truncates the tail; count must be nonnegative. First change after runtime additions can reset current index: explicitly Select afterward.

public Texture2D GetItemIcon(int idx);

Shared row Texture2D, or null; setting the selected row updates the closed-button icon.

public int GetItemId(int idx);

Returns assigned row ID. idx = -1 returns -1 for no selection rather than the last row ID.

public int GetItemIndex(int id);

Finds the first row with the ID; returns index or -1. IDs are not enforced unique, so assign unique application keys yourself.

public Variant GetItemMetadata(int idx);

Application Variant data independent of label and ID. Mutable resources/containers can remain shared.

public string GetItemText(int idx);

Source row label; setting the selected row updates the closed button. Item translation mode controls translation.

public string GetItemTooltip(int idx);

Row tooltip in the popup. Not the selected-button label or selection data.

public PopupMenu GetPopup();

Returns shared internal PopupMenu. Do not free/reparent it. Edit rows through OptionButton methods to keep label, selection and cache consistent.

public int GetSearchBarFuzzySearchMaxMisses();

Nonnegative maximum fuzzy-search misses, default 2. Not the visible result count.

public int GetSearchBarMinItemCount();

Nonnegative search visibility threshold counting nonseparator rows, default 0. Applies when SearchBarEnabled is on.

public int GetSelectableItem(bool fromLast = false);

Finds first/last index excluding disabled/separator rows. Returns -1 if none exists. Does not select the row or return its ID.

public int GetSelected();

Current row index, -1 for no selection. Setter/Select do not emit ItemSelected and can select disabled/separator rows. Explicitly restore selection by stable ID after structural changes.

public int GetSelectedId();

Returns current row ID, or -1 for no selection. Restore a valid index after removing an earlier row; do not use stale Selected.

public Variant GetSelectedMetadata();

Returns current row data, or Variant Nil with no selection. Explicitly restore selection first if list mutation may have left Selected stale.

public bool HasSelectableItems();

Whether at least one row is neither disabled nor separator. Does not validate current Selected.

public bool IsFitToLongestItem();

Closed-button size accounts for all items and popup width, default true. Cache updates are deferred; false follows current label/icon and can change width on selection.

public bool IsItemDisabled(int idx);

Disables user selection of a row. Does not clear existing selection or block programmatic Select of that index.

public bool IsItemSeparator(int idx);

Tests whether a row is a separator. Separators count toward ItemCount/indices but are skipped by GetSelectableItem.

public bool IsSearchBarEnabled();

Enables popup search field, default false. Visibility also depends on SearchBarMinItemCount; does not select items or change IDs.

public bool IsSearchBarFuzzySearchEnabled();

Matching with permitted misses, default true. Does not itself enable the search field; allowed misses are configured separately.

public void RemoveItem(int idx);

Removes a row by index. Removing the selected row clears selection. Current removal before the selected row does not decrement stored index; save its ID first and restore Select(GetItemIndex(id)) after checking the result.

public void Select(int idx);

Selects an existing row index without ItemSelected; -1 clears selection. Do not pass an ID. Does not exclude disabled/separator rows or automatically update application state.

public void SetAllowReselect(bool allow);

Allows repeated ItemSelected for the same menu row, default false. Does not make Select emit the signal.

public void SetDisableShortcuts(bool disabled);

Disables local list/base-button shortcut handling. Does not change application InputMap or disable ordinary Select/list methods.

public void SetFitToLongestItem(bool fit);

Closed-button size accounts for all items and popup width, default true. Cache updates are deferred; false follows current label/icon and can change width on selection.

public void SetItemAutoTranslateMode(int idx, Entity.AutoTranslateModeEnum mode);

Item-label translation mode: Inherit, Always or Disabled. Setting the selected row refreshes its display. Does not translate IDs/metadata.

public void SetItemCount(int count);

Count of all rows including separators. Setter creates empty rows or truncates the tail; count must be nonnegative. First change after runtime additions can reset current index: explicitly Select afterward.

public void SetItemDisabled(int idx, bool disabled);

Disables user selection of a row. Does not clear existing selection or block programmatic Select of that index.

public void SetItemIcon(int idx, Texture2D texture);

Shared row Texture2D, or null; setting the selected row updates the closed-button icon.

public void SetItemId(int idx, int id);

Sets an existing row ID without changing index. Uniqueness is not enforced; avoid duplicate IDs.

public void SetItemMetadata(int idx, Variant metadata);

Application Variant data independent of label and ID. Mutable resources/containers can remain shared.

public void SetItemText(int idx, string text);

Source row label; setting the selected row updates the closed button. Item translation mode controls translation.

public void SetItemTooltip(int idx, string tooltip);

Row tooltip in the popup. Not the selected-button label or selection data.

public void SetSearchBarEnabled(bool enabled);

Enables popup search field, default false. Visibility also depends on SearchBarMinItemCount; does not select items or change IDs.

public void SetSearchBarFuzzySearchEnabled(bool enabled);

Matching with permitted misses, default true. Does not itself enable the search field; allowed misses are configured separately.

public void SetSearchBarFuzzySearchMaxMisses(int maxMisses);

Nonnegative maximum fuzzy-search misses, default 2. Not the visible result count.

public void SetSearchBarMinItemCount(int count);

Nonnegative search visibility threshold counting nonseparator rows, default 0. Applies when SearchBarEnabled is on.

public void ShowPopup();

Opens the list when a Viewport exists. Neither Select nor item confirmation. Direct calls bypass Press’s Disabled check; call for an active in-tree button.

public event OptionButton.ItemFocusedEventHandler ItemFocused;

Highlighted row index, long in C#. Not confirmation and need not equal Selected.

public event OptionButton.ItemSelectedEventHandler ItemSelected;

Menu-selected row index, long in C#. Not an ID. Select and automatic selection during addition do not emit it; AllowReselect controls same-row reselection.