logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityModalSettingsDefinition

    Unity ScriptableObject implementation of modal settings definition.
    Defines comprehensive modal configuration including options, positioning, alignment, and UI layout settings.
    Provides Unity-specific Vector2 to System.Numerics.Vector2 conversion and implements foundation settings interface for modal management.

    Inheritance
    object
    UnityModalSettingsDefinition
    Implements
    IModalSettingsDefinition
    IFoundationSettings
    Namespace: Serenity.Modal.Installation.Settings
    Assembly: Serenity.UnityModal.Installation.dll
    Syntax
    public class UnityModalSettingsDefinition : ScriptableObject, IModalSettingsDefinition, IFoundationSettings

    Constructors

    UnityModalSettingsDefinition()

    Declaration
    public UnityModalSettingsDefinition()

    Fields

    Guid

    Declaration
    public string Guid
    Field Value
    Type Description
    string

    The globally unique identifier for this modal settings instance.

    Id

    Declaration
    public string Id
    Field Value
    Type Description
    string

    The unique identifier for this modal settings instance.

    ModalAlignment

    Declaration
    public UiAnchorType ModalAlignment
    Field Value
    Type Description
    UiAnchorType

    Alignment type for modal dialog placement on the screen.

    OptionAlignment

    Declaration
    public UiComponentAlignmentType OptionAlignment
    Field Value
    Type Description
    UiComponentAlignmentType

    Alignment type for arranging modal option buttons.

    Options

    Declaration
    public UiOption[] Options
    Field Value
    Type Description
    UiOption[]

    Array of option button configurations for the modal dialog.

    OptionsGap

    Declaration
    public float OptionsGap
    Field Value
    Type Description
    float

    Gap spacing between modal option buttons in Unity UI coordinates.

    Position

    Declaration
    public Vector2 Position
    Field Value
    Type Description
    Vector2

    Position offset for modal placement in Unity UI coordinates.

    Methods

    ToString()

    Returns a string representation of the modal settings definition.
    Includes all configuration properties: GUID, ID, options gap, position, alignments, and formatted options list.
    Useful for debugging and logging modal configuration details.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    Formatted string containing all modal settings properties.

    Implements

    IModalSettingsDefinition
    IFoundationSettings
    In this article
    © 2026 Serenity. All Rights Reserved