logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Interface IHudArgumentOptionProvider

    Supplies the authored-text options a HUD argument field of a specific type should offer, so HudBindingInspectorGui can draw a dropdown (or an ordered picklist) instead of a bare text field.

    Namespace: Serenity.GameUi.Infrastructure.Editor.Builder
    Assembly: Serenity.UnityGameUi.Infrastructure.Editor.dll
    Syntax
    public interface IHudArgumentOptionProvider
    Remarks

    Discovered by reflection through HudArgumentOptionCatalog — an aggregate registers one by implementing this interface with a public parameterless constructor in an editor assembly; nothing in the GameUi editor assembly needs to reference it back.

    Properties

    IsOrderedMultiSelect

    Whether TargetType is authored as an ordered, comma-joined list of these options rather than a single pick — e.g. a field selection built from several rows and stored as their comma-join, as opposed to a plain single-choice popup.

    Declaration
    bool IsOrderedMultiSelect { get; }
    Property Value
    Type Description
    bool

    TargetType

    The parameter type this provider serves.

    Declaration
    Type TargetType { get; }
    Property Value
    Type Description
    Type

    Methods

    GetOptions()

    The authored-text values to offer. Each is exactly what gets stored in the binding step's argumentValues and later parsed at runtime by HudArgumentParser — an authoring value, not a display label.

    Declaration
    IReadOnlyList<string> GetOptions()
    Returns
    Type Description
    IReadOnlyList<string>
    In this article
    © 2026 Serenity. All Rights Reserved