logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class GameSettingsEntity

    Represents the game settings.

    Inheritance
    object
    GameSettingsEntity
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.GameSettings.Domain.Entities
    Assembly: Serenity.Global.Domain.dll
    Syntax
    public class GameSettingsEntity

    Constructors

    GameSettingsEntity(IGameSettingsDefinition, string)

    Initializes a new instance of the GameSettingsEntity class.

    Declaration
    public GameSettingsEntity(IGameSettingsDefinition definition, string value)
    Parameters
    Type Name Description
    IGameSettingsDefinition definition

    The game settings definition containing all configuration data.

    string value

    The current runtime value of the game setting.

    Fields

    AvoidResetToDefault

    Declaration
    public bool AvoidResetToDefault
    Field Value
    Type Description
    bool

    Indicates whether the game setting should be excluded from reset to default operations.

    CharacterLimit

    Declaration
    public int CharacterLimit
    Field Value
    Type Description
    int

    The character limit for the game setting (if applicable).

    DefaultValue

    Declaration
    public string DefaultValue
    Field Value
    Type Description
    string

    The default value of the game setting.

    Id

    Declaration
    public string Id
    Field Value
    Type Description
    string

    The unique identifier of the game setting.

    IsStoreable

    Declaration
    public bool IsStoreable
    Field Value
    Type Description
    bool

    Indicates whether the game setting is storeable.

    IsTranslatingValue

    Declaration
    public bool IsTranslatingValue
    Field Value
    Type Description
    bool

    Indicates whether the game setting's value is being translated.

    MaximumValue

    Declaration
    public string MaximumValue
    Field Value
    Type Description
    string

    The maximum value of the game setting (if applicable).

    MinimumValue

    Declaration
    public string MinimumValue
    Field Value
    Type Description
    string

    The minimum value of the game setting (if applicable).

    Options

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

    The options for the game setting (if applicable).

    Value

    Declaration
    public string Value
    Field Value
    Type Description
    string

    The current value of the game setting.

    ValueType

    Declaration
    public GameSettingsValueType ValueType
    Field Value
    Type Description
    GameSettingsValueType

    The type of the game setting value.

    Methods

    ToString()

    Returns a string representation of the game settings.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of the game settings.

    Overrides
    object.ToString()
    In this article
    © 2026 Serenity. All Rights Reserved