logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class RecipeUiOptionDto

    Recipe description of a single UI option shared by menus and modals. Maps to a UiOption. Covers the flat fields (label, value/interaction type, a simple string default, translation flags) and the option's submit signals (submitSignals), wired through the serialized-property codec.

    Inheritance
    object
    RecipeUiOptionDto
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.ProjectRecipe.Infrastructure.Editor.Model
    Assembly: Serenity.UnityProjectRecipe.Infrastructure.Editor.dll
    Syntax
    public class RecipeUiOptionDto

    Constructors

    RecipeUiOptionDto()

    Declaration
    public RecipeUiOptionDto()

    Fields

    defaultValue

    Declaration
    public string defaultValue
    Field Value
    Type Description
    string

    Simple string default value seeded into both the option's value and default value.

    id

    Declaration
    public string id
    Field Value
    Type Description
    string

    Stable logical identifier of the option. Required.

    interactionType

    Declaration
    public string interactionType
    Field Value
    Type Description
    string

    Interaction type, as a UiComponentInteractionType name (STRING, TOGGLE, SELECTOR, SLIDER, DROPDOWN, INPUT, SUBMIT). Empty defaults to STRING.

    isTranslatingLabel

    Declaration
    public bool isTranslatingLabel
    Field Value
    Type Description
    bool

    Whether the label is treated as a localization key at runtime.

    isTranslatingValue

    Declaration
    public bool isTranslatingValue
    Field Value
    Type Description
    bool

    Whether the value is treated as a localization key at runtime.

    label

    Declaration
    public string label
    Field Value
    Type Description
    string

    Display label of the option.

    submitSignals

    Declaration
    public RecipeSignalDto[] submitSignals
    Field Value
    Type Description
    RecipeSignalDto[]

    Signals dispatched when the option is submitted, in order (maps to UiOption.OnSubmitSignals). null leaves the option's signals untouched; a non-null array (including empty) replaces them.

    valueType

    Declaration
    public string valueType
    Field Value
    Type Description
    string

    Value type, as a UiComponentValueType name (INT, FLOAT, STRING, BOOL, SELECTABLE, TRANSITION, ACTION). Empty defaults to STRING.

    In this article
    © 2026 Serenity. All Rights Reserved