logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class OnGameSettingsValueUpdatedInput

    Data transfer object for the OnGameSettingsValueUpdated event.

    Inheritance
    object
    OnGameSettingsValueUpdatedInput
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.GameSettings.Application.DTO
    Assembly: Serenity.Global.Application.dll
    Syntax
    public class OnGameSettingsValueUpdatedInput

    Constructors

    OnGameSettingsValueUpdatedInput(Dictionary<string, GameSettingsEntity>, string)

    Initializes a new instance of the OnGameSettingsValueUpdatedInput class.

    Declaration
    public OnGameSettingsValueUpdatedInput(Dictionary<string, GameSettingsEntity> gameSettingsDictionary, string changedSettingId = null)
    Parameters
    Type Name Description
    Dictionary<string, GameSettingsEntity> gameSettingsDictionary

    The dictionary of game settings.

    string changedSettingId

    The ID of the specific setting that changed, or null if multiple settings changed.

    Fields

    ChangedSettingId

    Declaration
    public readonly string ChangedSettingId
    Field Value
    Type Description
    string

    The ID of the specific setting that was changed.
    If null, indicates that multiple settings were updated (e.g., during reset or load).
    Listeners should use this to filter and process only the relevant setting, avoiding expensive iteration over all settings when only one changed.

    GameSettingsDictionary

    Declaration
    public readonly Dictionary<string, GameSettingsEntity> GameSettingsDictionary
    Field Value
    Type Description
    Dictionary<string, GameSettingsEntity>

    The dictionary of game settings.

    Properties

    IsSingleSettingChange

    Checks if the event is for a specific single setting change.
    Returns true if only one setting was changed, false if multiple settings changed (bulk update).

    Declaration
    public bool IsSingleSettingChange { get; }
    Property Value
    Type Description
    bool

    Methods

    GetChangedSetting()

    Gets the changed setting entity, if this is a single setting change.
    Returns null if this is a bulk update or if the setting ID is not found.

    Declaration
    public GameSettingsEntity GetChangedSetting()
    Returns
    Type Description
    GameSettingsEntity

    ToString()

    Returns a string representation of the game settings.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()
    In this article
    © 2026 Serenity. All Rights Reserved