CHANGELOG.md

KittsMenuSystem Changelog

Version 0.5.1

• Fixed Keybinds - Fixed a bug where keybinds would be reset when reloading a menu.
• Fixed Dedicated Server - Fixed a bug where the dedicated server player would recieve menus.
• Updated SettingIds - If no SettingId is set one will be made based on the label and setting type, any duplicate ids will be incremented by 1.

Version 0.5.0

• Added ABButton.OptionA - Get or set the underlying SSTwoButtonsSetting.OptionA.
• Added ABButton.OptionB - Get or set the underlying SSTwoButtonsSetting.OptionB.
• Added BaseSetting.Label - Get or set the underlying ServerSpecificSettingBase.Label.
• Added BaseSetting.HintDescription - Get or set the underlying ServerSpecificSettingBase.HintDescription.
• Added Button.ButtonText - Get or set the underlying SSButton.ButtonText.
• Added Button.HoldTimeSeconds - Get or set the underlying SSButton.HoldTimeSeconds.
• Added Dropdown.Options - Get or set the underlying SSDropdownSetting.Options.
• Added Slider.MinValue - Get or set the underlying SSSliderSetting.MinValue.
• Added Slider.MaxValue - Get or set the underlying SSSliderSetting.MaxValue.
• Added Slider.Integer - Get or set the underlying SSSliderSetting.Integer.
• Added Slider.ValueToStringFormat - Get or set the underlying SSSliderSetting.ValueToStringFormat.
• Added Slider.FinalDisplayFormat - Get or set the underlying SSSliderSetting.FinalDisplayFormat.
• Added Slider.FinalDisplayFormat - Get or set the underlying SSSliderSetting.FinalDisplayFormat.
• Added TextArea.Content - Same as BaseSetting.Label but made to match naming.
• Added TextBox.Placeholder - Get or set the underlying SSPlaintextSetting.Placeholder.
• Added TextBox.CharacterLimit - Get or set the underlying SSPlaintextSetting.CharacterLimit.
• Added TextBox.ContentType - Get or set the underlying SSPlaintextSetting.ContentType.
• Added UpdateOptionA function - Updates the ABButton.OptionA.
• Added UpdateOptionB function - Updates the ABButton.OptionB.
• Added UpdateLabel function - Updates the BaseSetting.Label.
• Added UpdateHintDescription function - Updates the BaseSetting.HintDescription.
• Added UpdateButtonText function - Updates the Button.ButtonText.
• Added UpdateHoldTimeSeconds function - Updates the Button.HoldTimeSeconds.
• Added UpdateOptions function - Updates the Dropdown.Options.
• Added UpdateMinValue function - Updates the Slider.MinValue.
• Added UpdateMaxValue function - Updates the Slider.MaxValue.
• Added UpdateInteger function - Updates the Slider.Integer.
• Added UpdateValueToStringFormat function - Updates the Slider.ValueToStringFormat.
• Added UpdateFinalDisplayFormat function - Updates the Slider.FinalDisplayFormat.
• Added UpdatePlaceholder function - Updates the TextBox.Placeholder.
• Added UpdateCharacterLimit function - Updates the TextBox.CharacterLimit.
• Added UpdateContentType function - Updates the TextBox.ContentType.
• Added Menu.AddedSettings - Can now add settings to the end of Menus from outside the Menu.
• Updated .csproj - Updated some dependencies.
• Updated Keybind setting - Includes actions for OnUsed and OnPressed with OnPressed triggering only on press.
• Updated UtilityExmaple - Removed the use of _addedSettings, added versionOverride section, added an AddedSettings section.
• Updated LoadMenu function - Made public, will not open a player's settings, added versionOverride.
• Updated SendSettings function - Added versionOverride to override the version of the Menu.
• Updated ReloadCurrentMenu function - Added versionOverride to override the version of the Menu.
• Updated ReloadAll function - Added versionOverride to override the version of the Menu.
• Updated ReloadFor function - Added versionOverride to override the version of the Menu.
• Updated ReloadForAll function - Added versionOverride to override the version of the Menu.
• Updated GlobalMenu - Removed setting duplication and filtered to keybind settings only.
• Updated SettingIds - If no SettingId is set, a random integer will be used no matter that label and setting type.
• Removed SetValidId function - Removed function from all settings.

Version 0.4.5

• Updated Dependencies - Updated to the latest dependencies.

Version 0.4.4

• Added NuGet Package - Can now use the NuGet package.

Version 0.4.3

• Added TryGetSetting function - Works the same as the GetSetting but returns false instead of a dummy if no setting found.
• Updated XML Summaries - Updated a lot of the summaries.
• Updated Menu class - Name and Id can no longer be set, can only get them.

Version 0.4.2

• Fixed GetSettings function - Fixed a bug where function was not returning the rebuilt settings.
• Fixed RebuildSettings function - Fixed a bug where function was not rebuilding settings correctly.

Version 0.4.1

• Updated GetSetting function - Moved to MenuManager.cs, takes Menu type, returns ServerSpecificSettingBase or BaseSetting and defaults to dummy setting if null.
• Updated Button function - isPressed action set to null by default.

Version 0.4.0

• Added BuildSettings function - Used to build original settings.
• Added RebuildSettings function - Used to rebuild the settings.
• Added GenerateSettings function - Used to generate settings to be built.
• Added DefinitionCache - Used to store original definitions.
• Added OriginalDefinition patch - Used to get the GetOriginalDefinitio stored in the DefinitionCache.
• Added RestoreFromOriginal function - Used to store original definition when OnSettingReceived is called.
• Added GlobalMenu - Loaded when settings are closed and conatins all settings from all menus.
• Added PinnedTopSettings - List of BaseSetting pinned to the top of all menus.
• Added PinnedBottomSettings - List of BaseSetting pinned to the bottom of all menus.
• Added RegisterTopPinnedSettings function - Registers the PinnedTopSettings.
• Added UnregisterTopPinnedSettings function - Unregisters the PinnedTopSettings.
• Added RegisterBottomPinnedSettings function - Registers the PinnedBottomSettings.
• Added UnregisterBottomPinnedSettings function - Unregisters the PinnedBottomSettings.
• Updated GetSetting function - Moved to Menu.cs, is per menu and returns a dummy setting if null.
• Updated GetSettings function - Now returns BuiltSettings, populating if empty, with options to rebuild and call settings.
• Removed Pinned - Moved to PinnedTopSettings and PinnedBottomSettings.
• Removed RegisterPins - Moved to RegisterTopPinnedSettings and RegisterBottomPinnedSettings.
• Removed UnregisterAllPins - Moved to UnregisterTopPinnedSettings and UnregisterBottomPinnedSettings.
• Removed LockedAssembly - No longer needed.
• Removed Load function - No longer needed.
• Removed SyncMenu function - No longer needed.
• Removed SyncAllMenus function - No longer needed.
• Removed Wrap function - No longer needed.
• Removed KeybindMenu - No longer needed.
• Removed SyncCache - No longer needed.
• Removed SetDefinedSettings patch - No longer needed.
• Removed GetDefinedSettings patch - No longer needed.
• Removed SendToPlayer patch - No longer needed.
• Removed SendToPlayer patch - No longer needed.
• Removed PlaintextLimit patch function - No longer needed.

Version 0.3.4

• Fixed GetSetting function - Fixed a bug where function could not find setting while SSSetting was in the unhashed state.

Version 0.3.3

• Fixed SSSetings- Fixed a bug where the returns SSSetings from a BaseSetting would be the hashed id.

Version 0.3.2

• Fixed Versions - Forgot to update the version of the plugin, rookie mistake.
• Updated EventHandler.cs - Now named MenuEvents.cs.
• Updated Dependencies - Removed unnecessary dependencies.
• Removed ReloadMenu function - Don't see a use for it.

Version 0.3.1

• Fixed KeybindMenu - Fixed an issue where keybind menu was loading when in settings.
• Fixed Server-Specific - Fixed an issue where pressing the Server-Specific tab while in the Server-Sepcific tab would cause an error.
• Fixed Config - Fixed unused configurations in the config file.

Version 0.3.0

• Added KeybindMenu - Used to load all keybinds when player not in settings.
• Added OnStatusReceived function - Updates the settings to and from KeybindMenu when player not in settings tab.
• Updated KittsMenuSystem.Features.Wrappers namespace - Now named KittsMenuSystem.Features.Settings.
• Removed All Keybinds on all Menus - No longer needed due to KeybindMenu.

Version 0.2.0

• Added AccessExmaple.cs - Exmaple menu where you don't have access (literally pointless).
• Added BaseSetting - All Wrappers now use BaseSetting instead of ServerSpecificSettingBase and all functions have been updated to work with BaseSetting.
• Added CentralMainMenu.cs - Used when multple main menus.
• Added Patches.cs - Contains GetDefinedSettings, SetDefinedSettings SendToPlayer andPrevalidate and PlaintextLimit patches.
• Added Keybinds everywhere - Keybinds are always added at the bottom of all menus so they can be used everywhere .
• Updated Exmaples - Uses BaseSetting and updated Menu.
• Updated LICENSE - License is now AGPL v3.0.
• Updated README.md - Changed some information.
• Updated OnSettingReceived fucntion - Now works with BaseSetting and is more simple.
• Updated Wrappers - Updated all Wrappers to use BaseSetting.
• Updated SettingSync - Now named SyncedSettings, list of BaseSetting and set to internal.
• Updated MenuRelated - Now named ParentMenu.
• Updated SentSettings - Now named BuiltSettings and is a list of BaseSetting.
• Updated GetSettings fucntion - Now builds pins, buttons and settings as BaseSetting.
• Updated ProperlyEnable fucntion - Now named OnOpen
• Updated ProperlyDisable fucntion - Now named OnClose
• Updated GetParamter function - Now named GetSetting
• Updated MenuSync - Now named SyncedMenus and can no longer be mutated.
• Updated LoadedMenus - Now named RegisteredMenus and can no longer be mutated.
• Updated Pinned - Can no longer be mutated.
• Updated RegisterAll function - Now named RegisterAllMenus.
• Updated UnregisterAll function - Now named UnregisterAllMenus.
• Updated Register function - Now internal.
• Updated SendMenu function - Now named SendSettings and converts list of BaseSetting to ServerSpecificSettingBase before sending.
• Moved Log.cs - Now located in the Features folder.
• Moved MenuManager.cs - Now located in the Menus folder.
• Moved AssemblyMenu.cs - Now located in the Menus folder.
• Moved Menu.cs - Now located in the Menus folder.
• Moved Parameters.cs - Moved functions to MenuManager.cs.
• Moved Wrappers - Moved all wrappers to Settings folder.
• Removed OnInput fucntion - Don't see a use for it.
• Removed TryGetSubMenu function - Sub menu buttons now have an Action going straight to sub menu.
• Removed GetSettingFor function - Now uses the override Settings function.
• Removed Settings override - Now uses the override Settings function.
• Removed InternalSettingsSync - Now uses SyncedSettings.
• Removed QueueOrRegister function - Don't see a use for it.
• Removed ISetting interface.
• Removed AllowPinnedContent from config - Pinned content always allowed.
• Removed CompatibilityEnabled from config - Compatibility always enabled.
• Removed ForceMainMenuEvenIfOnlyOne from config - Central main menu only shows when multple menus.
• Removed ReturnToMenu from config - Use ReturnTo instead.
• Removed Compatibilizer.cs - No longer needed or moved.
• Removed CompatibilizerGetter.cs - No longer needed or moved.
• Removed SendToPlayerDSPatch.cs - No longer needed or moved.
• Removed SendToPlayer.cs - No longer needed or moved.
• Removed SetIdPatch.cs - No longer needed or moved.
• Removed OriginalDefinition.cs - No longer needed or moved.
• Removed PrevalidateResponsePatch.cs - No longer needed or moved.
• Removed TemporaryPatch.cs - No longer needed or moved.