Odin Inspector Version 3.3.1

May 16th 2024 - 2 months ago

Localization

While Unity's localization system offers a robust framework for creating multilingual projects its accompanying tools can sometimes fall short, making the experience less than optimal. Recognizing this gap, we have developed replacements for the most important and frequently used aspects of the localization system, aimed at enhancing the existing authoring workflow, from improving the performance to making Undo work properly.

We've tried to strike a balance between keeping the UX as familiar as possible while changing and improving the workflow where it made sense and where the old system was lacking.

Let's take a look at some of the awesome new features and improvements we've introduced.

Visual overhaul

We've developed a replacement editor for Unity's Localization Tables window that can operate alongside Unity's localization tables window but aims to completely replace its functionality. Unity's original Localization Tables window, which often felt cluttered and became increasingly challenging to navigate with the addition of more tables and entries, has been redesigned with a focus on clarity, usability, and performance. We've ensured that the interface remains intuitive and accessible, regardless of the scale of your localization data. This redesign introduces numerous helpful features, making it easier to concentrate on specific parts of your localization data.

Everything in one window

One of the key enhancements we've introduced is the consolidation of the core localization process into a single, centralized window. This allows you to manage all aspects of your localization data through one unified interface, significantly streamlining the workflow. Now, tasks such as creating, adding, and removing tables from your table collection can be accomplished directly within this window, eliminating the need to navigate through the project to locate the relevant asset.

Pinning tables

This feature enables you to pin tables to keep them always visible, ensuring they remain readily accessible while you add, modify, or compare other pieces of data. This functionality is crucial for maintaining a smooth workflow, as it simplifies referencing back to other locale entries while modifying a different one.

Isolating Tables

In addition to pinning, you now have the ability to hide specific tables, enabling a focused view on a subset of your data. This feature further declutters the interface and allows you to concentrate exclusively on the elements that are currently important, ensuring that none of the available screen real estate is occupied by irrelevant data.

Inline Access Buttons

To streamline the process further, we've integrated inline buttons that instantly open the assets within your table either in the inspector or the explorer. This eliminates the cumbersome process of manually navigating through the project to locate and modify assets, significantly speeding up the editing and updating process.

Syntax Highlighting

Syntax highlighting is now integrated into string editing by default, eliminating the need for activating a specific debug mode. Previously, the absence of syntax highlighting during editing rendered the process cumbersome and error-prone. This enhancement guarantees that you can edit your localization and identify syntax errors or inconsistencies at a glance.

Improved Metadata Inspector

We've overhauled the metadata inspector to more closely align with Unity's default component inspector, enhancing familiarity, ease of use, and legibility. Additionally, you are now able to use Odin's familiar attribute and drawer workflow to customize how your metadata is drawn. This overhaul also introduces several smaller quality-of-life features, enabling you to:

• Search through your metadata for specific items
• Copy and paste metadata easily
• Expand or collapse all instances of metadata, or instances of a specific type, with a single action

Performance

Our implementation is all about elevating the user experience, with a primary focus on speed and responsiveness. Whether you're opening a Collection containing thousands of Shared Entries, editing a String Table Entry among hundreds, or efficiently handling tasks like Resizing, Sorting, and Filtering thousands of Shared Entries, we've streamlined the processes to make them feel virtually instantaneous.

Revamped Type Selector and Polymorphic Fields

In this update, we're thrilled to announce a complete revamp of the Type Selector, accompanied by its very own custom window in the form of the Type Registry!

The revamped Type Selector offers enhanced responsiveness and customization. Via the type registry custom window, you now have fine control over each type's display, determining their appearance, priority, visibility, and validity. Additionally, we've introduced versatile customization options for the content displayed by the selector, as well as how it presents that content.

Alongside this, we're introducing support for more use-cases with polymorphic fields, coupled with a refined visual experience! This enhancement, for example, will streamline workflows that include interfaces that share both Unity and C# implementations.

The new editor window we have introduced provides a streamlined way to quickly handle how a plethora of types are displayed in the Type Selector.

Below is a demonstration showcasing the workflow of utilizing the new polymorphic fields for interfaces that have both C# and Unity implementers.

In addition to these updates, we're introducing three new attributes related to the new Type Selector and Polymorphic Fields:

• TypeRegistryItem: Enables customization of how the type is displayed in the Type Selector.
• TypeSelectorSettings: Allows users to tailor the Type Selector to their needs.
• PolymorphicDrawerSettings: Provides a way to handle how the Polymorphic Fields and their content gets drawn.

General Patch Notes

Odin Inspector

Additions

• Added an extension to UnityEngine.Color that retrieves the perceived luminosity: ColorExtensions.PerceivedLuminosity.
• Added a new SearchField: Sirenix.Utilities.Editor.SearchField.
• Added Frames-per-second timers for GUITimeHelper.
• Added extensions for GUIStyle.CalcSize in GUIHelper, these cover use-cases where a string would be measured instead of a GUIContent, and where a Width is intended to measured.
• Added BlackLabelCentered, MultiLineWhiteLabel and RichTextLabelCentered to SirenixGUIStyles.
• Added MenuBackgroundColor to OdinMenuEditorWindow to allow customization of the Menu background color.
• Added IsSelectable and IsEnabled to OdinMenuItem's.
• Added overloads for drawing sliced or repeating textures inside SirenixEditorGUI.
• Added overloads for drawing rounded rect's inside SirenixEditorGUI.
• Added an OdinObjectSelector static class for handling picking objects from a C# environment and Unity environment intertwined.
• Added extensions for OdinMenuTree's for quickly assigning Icons to items with NULL values or items without icons.
• Added overloads of UnitField and SmartUnitField to SirenixEditorFields for float, double and int types.
• Added GUIHelper.DrawLastControlId debugging method to draw a label of the last set control id.
• Added IsMouseOver extension for Event.current.
• Added SerializeReference support for the Serialization Debugger, and a SerializeReference validator.
• Added option for using the new object selector to GeneralDrawerConfig.
• Added BeginVerticalWithoutUsingControlID to SirenixEditorGui, to correspond to BeginHorizontalWithoutUsingControlID.
• Added 'TypeSettingsAttribute' to customize the contents of the Type Selector utilized in the TypeDrawer.
• Implemented 'Customize Type' context menu button for NullableReferenceDrawers (Polymorphic Fields) to quickly customize the specific assigned type.
• The ShowDrawerChainAttribute now also lets you toggle drawers on and off for debugging purposes.
• Added another overload for SirenixEditorGUI.Foldout.
• Added SirenixEditorGUI.DoButton and SirenixEditorGUI.PrefixRect.
• Added DragAndDropUtilities.DragAndDropZone overload that accepts a bool 'allowSceneObjects' as a final parameter.
• Added a new Unity Object Field drawer that improves on the old one; it can now handle copy-pasting by keyboard, displaying 'Missing' references, and finally the pen no longer overlaps the label.
• Added TypeExtensions.InstantiateDefault method to handle creating instances, even when no default constructor is present, and without using FormatterServices.GetUninitializedObject unless specified. It does this by ranking the available constructors and using the one it finds the most suitable to construct the instance.
• Added TypeExtensions.HasDefaultConstructor to determine if a given Type has a default public parameterless constructor.
• Added the TypeDrawerSettingsAttribute to enable straightforward customization of the content displayed in the Type Drawer.

Changes

• Cleaner string formatting for numbers displayed by Unit fields. Unit fields now have their own separate format strings in SirenixEditorFields, and can be modified as preferred.
• DisplayAsString now features a Format property that uses the IFormattable interface.

Fixes

• Fixed issue where Odin could not access the EditorGUI.s_RecycledEditor field in the newly released Unity 6, resulting in multiple errors and exceptions while drawing inspectors.
• Fixed case where integer number fields would break when sliding the value if the value of the field becomes long.MinValue, since the absolute value of long.MinValue cannot be calculated as it is out of range of a long.
• Fixed issue in the Addressables support module where drag and drop would not work on AssetReferences drawn in the inspector, so they could only be modified via the selector dropdown.
• Fixed an issue on Linux where HandleUtility.Repaint() was called at a moment when GUIHelper.CurrentWindow is null.
• Fixed case in ValidationDrawer causing disruption of ControlIds in subsequent drawers.
• Fixed regression bug where InfoBox attributes added to enums would no longer properly be displayed.
• OdinEditorWindow now correctly handles checking for changes in a target that is an IEnumerable.
• Fixed Odin causing a StackOverflow when drawing a UnityProperty-derived attribute which is handled by an IMGUI-based Unity DecoratorDrawer that does not use UIToolkit. This issue was introduced in Odin 3.2, and was caused by Odin's UnityDecoratorAttributeDrawer getting and iterating over the currently active drawer chain. This would reset the drawer chain, and cause it to start over drawing when CallNextDrawer is invoked, instead of advancing to the next drawer in the chain. Iterating over a BakedDrawerChain instance using GetEnumerator now uses a separate enumerator instance that does not mutate the current state of the drawer chain.
• Fixed an issue where the AssetReferenceValidator would throw invalid errors on addressable sprites.
• Drawers called after ValidationDrawer now have more consistent ControlId's.
• Fixed Odin not showing that prefab variant values have been modified.
• Made sure ObjectIsReferenced in PropertyTree handles the value itself being UnityEngine.Object.
• Added missing ODIN_INSPECTOR_3_2 script define.
• Fixed Odin's Localization module causing LocalizedReferences to not work properly in the inspector while in play mode.
• SerializationBackend.SupportsPolymorphism is now properly handled in the CollectionDrawer. This issue was causing the new type selector dropdown to be displayed when it shouldn't, when for example adding new values to a non-polymorphic Unity-serialized collection.
• Removing items on a searchable Dictionary and TableList now removes the correct item when filtered.
• Searchables dictionaries no longer update while being edited, to avoid values becoming null.
• Fixed SdfIconSelector drawers opening by keyboard events even if it's not currently focused.
• Fixed case where issue in Odin's build pipeline caused Odin to ship with non-portable .pdb files. The included .pdb files should now be portable and work correctly across a wider range of Unity versions.
• Fixed a field in AssetSelectorExamples causing the AssemblyUpgrader to run on the Sirenix.OdinInspector.Editor.dll file. As is often the case, Unity's AssemblyUpgrader touching anything in any capacity at all breaks the assembly's metadata and causes several import errors. With this fix, the AssemblyUpgrader should no longer run and break Odin's assemblies.
• Fixed issue where getting a GlobalConfig instance during InitializeOnLoad, DidReloadScripts or similar load events would throw an error when the GlobalConfig asset file does not yet exist and needs to be created in the AssetDatabase. GlobalConfigs which need to create their assets now instantiate and return the config instance immediately, then delays the asset creation to a later time where it is safe to use the AssetDatabase to create asset files. This would manifest primarily as a failure of Odin's CustomEditorLoader to create its inspector config asset and thus it would fail to initialize and inject Odin's editors into Unity.
• Changed obsolete usage of Expanded to ShowFoldout on ListDrawerSettingsAttribute in examples provided and configurations.
• Fixed bitbucket issue #324: TableMatrix SquareCells=true does not work with array of width 1.
• Fixed bitbucket issue #932: PersistentContextCache throws exception on save when Company Name in project settings contains a '.'
• Fixed bitbucket issue #971: PreviewField will change filterMode(Point) when value is a RenderTexture.
• Fixed bitbucket issue #611: The "Missing" state in object reference fields is never shown when using Odin Inspector.
• Fixed issue in the localization support module where the LocalizationFormatter type would be included in the runtime build and cause compiler errors when Odin's editor only mode was enabled.
• Introduced fix in Odin's property system value loading for the case where Unity creates invalidly typed, corrupt wrapper objects. IE, when Unity, for example, deserializes a GameObject reference as a Transform reference, so the Transform reference has a native pointer to a GameObject. In these cases, Odin now replaces the corrupt wrapper value with a null value before it is passed into the property system for drawing and validation.
• Prefer Namespace is now handled correctly in the TypeSelectorSettings.
• PropertyTrees now automatically create a SerializedObject when UnityObjects are provided without one. This fixes various edge-case issues when using PropertyTrees for Unity types manually, such as undo not working for some Unity object types like AnimationCurve.
• Very likely fixed Bitbucket issue #947 where the focused control would be changed when data is changed while an inspector is viewed, and the validation then causes issue error boxes to pop up or vanish from the inspector. As the issue is very difficult to reliable replicate, there is a chance something has slipped through somewhere. If anybody is still seeing this issue, please let us know.

Odin Validator

Additions

• Added a new validation rule that ensures that ScriptableObject and MonoBehaviour class names align with their corresponding script filenames.
• Added a validator for handling scene mismatches in UnityEngine.GameObjects and UnityEngine.Components that don't support cross-scene references.
• Added TypeRegistryIllegalInstanceValidator to validate if an illegal type is being used in polymorphic fields.
• Added a new button to the validator window under 'Asset Filters', allowing you to view a list of all assets scheduled for validation in the current profile.
• Added an asset load timing table to the Profiler tab of the validator, which displays the 50 most time consuming asset load operations the Validator has performed. This can be useful to determine which assets are causing stutter in the editor due to the Validator waiting for Unity to load them.
• Made toggling the validator on and off more user-friendly: The validator can now be easily toggled on or off by right-clicking the scene view widget. A "Stop" option has also been added to stop whatever it is doing. In the config window, the GUI elements for toggling which events should trigger validation are now disabled when the "Keep main background validation session alive in background" is off, clarifying that this option disables the Validator.
• Added the ability to change the severity of the Missing Script Validator rule.

Fixes

• Fixed an issue where PersistentValidationResults did not make use its PersistentValidationResultEqualityComparer for its equality operators, leading to numerous edge-case bugs in the validator window.
• Content displayed under headers should now be scrollable.
• Fixed a bug where an IMGUI layout error would sometimes get logged in the console when filtering results or entering and exiting bulk fixing.
• Fixed case where GlobalValidators would throw a NotImplementedException when getting their RevalidationCriteria property.
• Odin Validator now handles rare cases where Unity's asset database would give invalid asset guids. This should resolve all guid-related error logs people were seeing on full reimports and initial installation of Validator.
• Odin Validator now uses less memory for its internal processing and gathering of results by processing results intermittently during validation scans if too many results are building up. This should help those with truly enormous projects who were running out of memory during full project validation scans.
• Fixed an issue where background validation catch "on scene load" events from additively loaded scenes.
• Fixed an issue where background validation only worked on the main validation profile.
• Fixed an issue where Debug.Log events, during specific asset loads, were incorrectly treated as errors during validation.
• The left side bar of the validator window can now be dragged to a size larger than 900 pixels. It is now constrained to the size of the window instead.

Odin Serializer

Performance

• Incorporated pull request that improves JSON deserialization performance by using the Ordinal instead of Invariant culture when doing string equality comparisons.

Fixes

• Fixed issue #913, again, for iOS - this time for good (we hope!). This issue would cause some data serialized on iOS using xcode 15 and above to become corrupt; specifically, this issue affected binary serialization of 64 and 128 bit primitive values (long, ulong, double, guid, decimal). In the end, the method of how the data is written to the data buffer was changed entirely in a way that didn't trigger the new xcode compiler bug that caused faulty inlining that would corrupt the memory of stack variables.
• Fixed issue where the AOT support scan would not be able to scan addressables due to the PlayerDataGroupSchema type having been removed from the Unity.Addressables module.

Delta patch notes from beta patch 3.3.0.4 to 3.3.1.0

Odin Inspector

Additions

• Added option for using the new object selector to GeneralDrawerConfig.
• Added a TypeInclusionFilter to customize which types are displayed in the Type Selector. This can be utilized through attributes or manually through the constructors.
• Added BeginVerticalWithoutUsingControlID and BeginHorizontalWithoutUsingControlID to SirenixEditorGUI.
• Added 'Type(Drawer)SettingsAttribute' to customize the contents of the Type Selector.
• Implemented 'Customize Type' context menu button for NullableReferenceDrawers (Polymorphic Fields) to quickly customize the specific assigned type.
• The ShowDrawerChainAttribute now also lets you toggle drawers on and off for debugging purposes.
• Added another overload for SirenixEditorGUI.Foldout.
• Added SirenixEditorGUI.DoButton and SirenixEditorGUI.PrefixRect.
• Added DragAndDropUtilities.DragAndDropZone overload that accepts a bool 'allowSceneObjects' as a final parameter.
• Most buttons in the Odin Localization Editor now have tooltips, describing their behavior.
• Added custom (opt-out) undo handling for asset entries in the Odin Localization Editor.
• Asset entries in the Odin Localization Editor now support drag and drop.
• Added the TypeDrawerSettingsAttribute to enable straightforward customization of the content displayed in the Type Drawer.

Fixes

• Fixed issue where Odin could not access the EditorGUI.s_RecycledEditor field in the newly released Unity 6, resulting in multiple errors and exceptions while drawing inspectors.
• Fixed case where integer number fields would break when sliding the value if the value of the field becomes long.MinValue, since the absolute value of long.MinValue cannot be calculated as it is out of range of a long.
• Fixed issue in the Addressables support module where drag and drop would not work on AssetReferences drawn in the inspector, so they could only be modified via the selector dropdown.
• Fixed an issue on Linux where HandleUtility.Repaint() was called at a moment when GUIHelper.CurrentWindow is null.
• Fixed case in ValidationDrawer causing disruption of ControlIds in subsequent drawers.
• Fixed regression bug where InfoBox attributes added to enums would no longer properly be displayed.
• OdinEditorWindow now correctly handles checking for changes in a target that is an IEnumerable.
• OdinObjectSelector now properly handles string creation for System.Object base types.
• Resolved a bug in the ValidationDrawer that caused disruption of ControlIds in subsequent drawers within the chain, following modifications to the drawer sequence.
• Removed all the new beta code for positioning popups with pixel perfect precision. In the end, Unity's APIs provide insufficient screen and working area information to properly position popups manually in all edge cases with multiple monitors, so Odin's popup positioning code has been reverted to using Unity's default popup API, despite its occasional misbehaviour.
• HybridObjectPicker/OdinObjectSelector now correctly handles assigning Components.
• Updated HybridObjectPicker/OdinObjectSelector to accommodate custom sorting of displayed types.
• InstantiateDefault in TypeExtensions now prefers GetUninitializedObject over constructors with non default interface(s) or abtract(s) types present in the parameters.
• Fixed an issue where the TypeRegistry would mark a non-generated type as generated.

Changes

• Changed DisplayAsStringAttributeDrawer's drawer priorty to 999.9995 instead of 999.999 (the default priority for built-in Odin attribute drawers), so it is always drawn over other default-priority Odin attributes when applied.
• TypeExtensions.InstantiateDefault now handles typeof(string) manually.
• Renamed several new attributes introduced in the beta: TypeSelectorItemSettingsAttribute has been renamed to TypeRegistryItemAttribute, TypeSelectorDrawerSettingsAttribute has been renamed to TypeSelectorSettingsAttribute, and PolymorphicFieldSettingsAttribute has been renamed to PolymorphicDrawerSettingsAttribute.
• The HybridObjectPicker type has been renamed to OdinObjectSelector.
• The TypeRegistry now has multiple overloads for retrieving inheritors: GetValidTypesInCategory(AssemblyCategory), GetInheritors(Type), and GetInstantiableInheritors(Type, bool).
• TypeRegistry no longer marks certain types as hidden or illegal by default.
• TypeExtensions.HasDefaultConstructor now has a more accurate summary to account for what it does.
• OldTypeSelector renamed back to TypeSelector for backwards compatibility.
• The new Type Selector that was introduced in 3.3.0.0 has been renamed to TypeSelectorV2.

Odin Validator

Additions

• Added a new validation rule that ensures that ScriptableObject and MonoBehaviour class names align with their corresponding script filenames.
• Added a validator for handling scene mismatches in UnityEngine.GameObjects and UnityEngine.Components that don't support cross-scene references.
• Added TypeRegistryIllegalInstanceValidator to validate whether an illegal type is being used in non-UnityEngine.Object fields.

Fixes

• Fixed an issue where PersistentValidationResults did not make use its PersistentValidationResultEqualityComparer for its equality operators, leading to numerous edge-case bugs in the validator window.
• Content displayed under headers should now be scrollable.
• Fixed a bug where an IMGUI layout error would sometimes get logged in the console when filtering results or entering and exiting bulk fixing.
• Fixed case where GlobalValidators would throw a NotImplementedException when getting their RevalidationCriteria property.
• Fixed an issue where the TypeRegistry would mark a non-generated type as generated.

Odin Serializer

No changes were made to Odin Serializer in this version.

---