logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Interface IGameSettingsDefinition

    Interface defining the structure and properties of game settings definitions.

    Inherited Members
    IFoundationSettings.Id
    IFoundationSettings.Guid
    Namespace: Serenity.GameSettings.Domain.Interfaces
    Assembly: Serenity.Global.Domain.dll
    Syntax
    public interface IGameSettingsDefinition : IFoundationSettings

    Properties

    AvoidResetToDefault

    Gets a value indicating whether the game setting should be excluded from reset to default operations.

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

    true if the game setting should not be reset to default; otherwise, false.

    CharacterLimit

    Gets the character limit for the game setting.

    Declaration
    int CharacterLimit { get; }
    Property Value
    Type Description
    int

    The character limit for the game setting.

    DefaultValue

    Gets the default value of the game setting.

    Declaration
    string DefaultValue { get; }
    Property Value
    Type Description
    string

    The default value of the game setting.

    IsStoreable

    Gets a value indicating whether the game setting is storeable.

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

    true if the game setting is storeable; otherwise, false.

    IsTranslatingValue

    Gets a value indicating whether the game setting is being translated.

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

    true if the game setting is being translated; otherwise, false.

    MaximumValue

    Gets the maximum value of the game setting.

    Declaration
    string MaximumValue { get; }
    Property Value
    Type Description
    string

    The maximum value of the game setting.

    MinimumValue

    Gets the minimum value of the game setting.

    Declaration
    string MinimumValue { get; }
    Property Value
    Type Description
    string

    The minimum value of the game setting.

    Options

    Gets the options available for the game setting.

    Declaration
    ConfigurationEntry[] Options { get; }
    Property Value
    Type Description
    ConfigurationEntry[]

    An array of key-value pairs representing the options for the game setting.

    ValueType

    Gets the ValueType of the game setting.

    Declaration
    GameSettingsValueType ValueType { get; }
    Property Value
    Type Description
    GameSettingsValueType

    The ValueType of the game setting.

    In this article
    © 2026 Serenity. All Rights Reserved