[RELEASED] Odin Inspector & Serializer - The Ultimate Workflow Tool ★★★★★

Would something like this work?


You could in the same way also change the button to accept a string paramater, and manually parse the string

 

Thanks a lot for this example ! I was actually able to do it by adding a menuItem and then use CreateAsset on each own of my game assets via a custom editor window that I made. But i got to say, Odin parses the results really really nice

 

Feature request:

In the Inspector, for testing/troubleshooting, sometimes I need to temporarily remove an added element from a Collection. It's a bit of a hassle to remove and re-add elements as needed, so an additional per-element button or right-click option to temporary disable it (i.e. it still shows up in the Collection in the Inspector, maybe visually greyed out to make it apparent, but is not actually added as an element in the C# Collection at runtime), that would be pretty nifty.

A related request would be a similar button or right-click option, but for making an element the only enabled one in the Collection. Basically like Mute / Solo buttons on the tracks in most audio production packages.

 

Hi.

I use [TableList(DefaultMinColumnWidth = 100)] and i get list which show not all columns and i don't see horizontal scroll bar, how get i scroll bar?

Thanks.

 

Hi all!

I was wondering if someone can help me a bit, i have a SerializedMonoBehaviour script with a 2d array of MonoBehaviour scripts. I managed to show the 2d array in the editor however i cannot seam to show the public field of scripts held in the array. I only get the c# icon as shown in the picture.

//This is the script with the 2d array
public class GrndCmbt_Garrison : SerializedMonoBehaviour
{
[SerializeField] private GrndCmbt_Garrison_Slot[,] garrisonSlots;
}

//This is the script that is held in the 2d array and the field i want to see
public class GrndCmbt_Garrison_Slot : MonoBehaviour
{
public GrndCmbt_Unit_Combat_GroupMember_Garrisonable garrisonedUnitInSlot;
}

I want to see that garrisonedUnitInSlot field of the scripts held in the array, i am interested to know when the field becomes empty.



Any help would be greatly appreciated, i admit i am a complete noob when it comes to Serialization.

 

How can I hide a property defined in a base class?

 

You can do that with Odins AttributeProcessors There more examples of OdinAttributeProcessors available from "tools > Odin Inspector > Getting Started"

Code (CSharp):

1. public class MyCustomClassAttributeProcessor<T> : OdinAttributeProcessor<T>
2.     where T : MyCustomClass
3. {
4.     public override void ProcessChildMemberAttributes(InspectorProperty parentProperty, MemberInfo member, List<Attribute> attributes)
5.     {
6.         if (member.Name == "SomeMember")
7.         {
8.             attributes.Add(new HideInInspector());
9.         }
10.     }
11. }

 

Cells inside matrecies are handles a bit special in Odin as it's rarly ideal to render entire objects in each cell. But you can use the DrawElementMethod to do custom cell drawing.

Code (CSharp):

1.  
2.         [TableMatrix(DrawElementMethod = "DrawGarrisonSlot")]
3.         public GrndCmbt_Garrison_Slot[,] garrisonSlots;
4.  
5.         private static bool DrawGarrisonSlot(Rect rect, GrndCmbt_Garrison_Slot value)
6.         {
7.             // Use GUILayout, GUI etc.. to draw the cell for the given value.
8.             return value;
9.         }

 

Awesome! Thanks!

 

Hi @SergeyGorbunov,

Yes, this is an issue with the TableList drawer currently. Basically, the TableList drawer constrains itself to the available width in the current IMGUI layout and ignores the minimum width property.

Currently, the easiest way to solve the issue is by using the HorizontalGroup.Width property. Something like this:

Code (CSharp):

1. [HorizontalGroup(Width = 2000), TableList(DefaultMinColumnWidth = 100)]

Alternatively, I also have a new Attribute + drawer that creates a new horizontal space with a horizontal scroll view. It is not perfect, but it does work.

Code (CSharp):

1. [HorizontalScrollArea(2000), TableList(DefaultMinColumnWidth = 100)]

Spoiler: Attribute + drawer implementation

Code (CSharp):

1. // HorizontalScrollAreaAttribute.cs
2. public class ServiceAsset : ScriptableObject
3. {
4.     [HorizontalScrollArea(2000)]
5.     [TableList(DefaultMinColumnWidth = byte.MaxValue)]
6.     public List<Storage> Storage;
7. }
8.  
9. // HorizontalScrollAreaAttributeDrawer.cs
10. public class HorizontalScrollAreaAttributeDrawer : OdinAttributeDrawer<HorizontalScrollAreaAttribute>
11. {
12.     private Rect prevRect;
13.     private Vector2 scrollPosition;
14.  
15.     protected override void Initialize()
16.     {
17.         this.prevRect.width = 100;
18.         this.prevRect.height = EditorGUIUtility.singleLineHeight;
19.         GUIHelper.RequestRepaint();
20.     }
21.  
22.     protected override void DrawPropertyLayout(GUIContent label)
23.     {
24.         var rect = EditorGUILayout.GetControlRect(false, this.prevRect.height + 16);
25.  
26.         GUILayout.BeginArea(this.prevRect.AddYMax(16));
27.         this.scrollPosition = GUILayout.BeginScrollView(this.scrollPosition);
28.         GUILayout.BeginVertical(GUILayoutOptions.Width(this.Attribute.Width));
29.  
30.         GUIHelper.BeginLayoutMeasuring();
31.         this.CallNextDrawer(label);
32.         var height = GUIHelper.EndLayoutMeasuring().height;
33.  
34.         GUILayout.EndVertical();
35.         GUILayout.EndScrollView();
36.         GUILayout.EndArea();
37.  
38.         if (Event.current.type == EventType.Repaint)
39.         {
40.             this.prevRect.position = rect.position;
41.             this.prevRect.width = rect.width;
42.             this.prevRect.height = height;
43.         }
44.     }
45. }

I hope that helps

 

So, I am extending a MaskableGraphic which has an "onCullStateChanged" property that I want to hide but can't make go away even with the custom AttributeProcessor.



Setting any attributes to it in the AttributeProcessor don't seem to do anything.

 

when i go to About under Odin in Unity. It says Version 2.0.3
When I go to the store it says the newest version is 2.0.13?

 

Hello,

Do you guys respond to emails? I've contacted the support email: contact@devdog.io

Unsure if I should be contacting somewhere else instead..

 

Cool! Thank you!

 

Yeah we do, and sorry about the confusion. DevDog is our publishers. It's actually a different company that's developing Odin (Sirenix). We try to direct our users to http:/www.sirenix.net/support but could do a better job of that.

Discord For some rapid back and forth chat support.
Isssue-Tracker If you have an issue that you don't want us to forget about.
Sirenix.net/support If your question or inquiry is more suited for an email, you can reach of from there.

And we also answer questions in here, but we're most active on the other channels.

 

Hi! Is it possible to speed up scriptable objects in editor? In 2017.2 they work very slow. Or it is not related to Odin?

 

Is it maybe because you are storing a lot of data in them? Unity objects are serialized each frame in the inspector, so the more data they serialize the laggier they become. You can get around this by manually saving and loading the data to a file, and use Odin to inspect the data. One of our users on Discord made this thing which helps with just that: https://pastebin.com/FGXVGXfY maybe you kind find some inspiration there.

 

when I do

Code (csharp):

1.  Vector3[] myVector = new Vector3[10];

It creates a reordering capable list in the editor. Which is awesome but I have a situation where Id rather it not be possible to reorder. Is there something I can do to remove reordering on it?

 

Do you have any tutorial or sample code for ODIN EDITOR WINDOWS (from asset's page)?
Like how you create new window and put details.

 

@banksazero
Try this link out man. It shows examples at the bottom.
This is what I would do. Create a new cs script. Then copy that example into it
That will instantly get you started with seeing how it works with creating editor windows.

Code (csharp):

1.  
2. public class SomeWindow : OdinEditorWindow
3. {
4.    [MenuItem("My Game/Some Window")]
5.    private static void OpenWindow()
6.    {
7.        GetWindow<SomeWindow>().Show();
8.    }
9.  
10.    [Button(ButtonSizes.Large)]
11.    public void SomeButton() { }
12.  
13.    [TableList]
14.    public SomeType[] SomeTableData;
15. }
16.  
17.  

Think you need using Sirenix.OdinInspector at the top.
Its been a long time since i was messing around with this so I kinda forgot.

http://sirenix.net/odininspector/documentation/sirenix/odininspector/editor/odineditorwindow

 

Do you possibly have an Odin build without unityengine.networking for 2019?

 

Is there a way to not show the odin drawer for a list and use unity's native list inspector? Unity's list have an option to add several items at once by dragging and I need that.

 

hi, i have a 2d array of a custom class - that class has an 2 enum properties (enum ArmyType & enum UnitType) of
i want in the inspector to have a grid for my array where each box in the grid uses the armyType property to draw the background of the entire grid cell. and the other enum type to draw a normal enum button in the middle of the grid cell.
how can i achieve this with Odin? (i saw in the examples how i can use the Draw rect to color the cell - but i cant manage to put a button over that Rect)

 

Hello and thank you for this very useful plugin! Can we ask for some improvements?

I think of the AssetList, who may need some fields and properties of the ListDrawerSettings. Particularly the HideAddButton and HideRemoveButton, because we get unwanted prefab added to our target asset folder on each click on the wrong list

Thank you again!

 

Hi
I have problems getting an InspectorProperty.Children items.
When I remove an Item from the list, property after removed lost children. In the resolver I see all the fields, but the number of children remains empty. When I add any item to the collection (after remove), the problem is solved and i can get all children.
How i can fix it?
Thanks

 

how can i Serialized protobuf dataformat? please help me

 

enum's LabelText does not apply to EnumPaging, EnumToggleButtons.

Code (CSharp):

1. public class EnumToggleButtonsExamples : MonoBehaviour
2. {
3.     [Title("Default")]
4.     public SomeBitmaskEnum DefaultEnumBitmask;
5.  
6.     [EnumPaging]
7.     public SomeEnum SomeEnumPagingField;
8.  
9.     [Title("Standard Enum")]
10.     [EnumToggleButtons]
11.     public SomeEnum SomeEnumField;
12.  
13.     [EnumToggleButtons, HideLabel]
14.     public SomeEnum WideEnumField;
15.  
16.     [Title("Bitmask Enum")]
17.     [EnumToggleButtons]
18.     public SomeBitmaskEnum BitmaskEnumField;
19.  
20.     [EnumToggleButtons, HideLabel]
21.     public SomeBitmaskEnum EnumFieldWide;
22.  
23.     public enum SomeEnum
24.     {
25.         [LabelText("First:1")]
26.         First,
27.  
28.         [LabelText("Second:2")]
29.         Second,
30.  
31.         [LabelText("Third:3")]
32.         Third,
33.  
34.         [LabelText("Fourth")]
35.         Fourth,
36.  
37.         [LabelText("AndSoOn:5")]
38.         AndSoOn
39.     }
40.  
41.     [System.Flags]
42.     public enum SomeBitmaskEnum
43.     {
44.         [LabelText("A:1")]
45.         A = 1 << 1,
46.         [LabelText("B:2")]
47.         B = 1 << 2,
48.         [LabelText("C:3")]
49.         C = 1 << 3,
50.         [LabelText("All:4")]
51.         All = A | B | C
52.     }
53. }

 

Hi, is there an attribute to prevent certain serialized fields from being folded/hidden by default?

 

Hi, i'm using a dictionary with a custom type as value, something like Dictionary<string, MyType> but i cannot make it display MyType content as columns like a TableList.

Basic display with [DictionaryDrawerSettings(DisplayMode = DictionaryDisplayOptions.OneLine)] :


Display with [HorizontalGroup] on fields :


Is there a feature that i'm missing or do i have to make it using HorizontalGroup ? If the last is true how do i use label as column header ?

 

Hi, I used Odin for a few weeks. It work almost perfect, saved me a lot of time.
here is a small question.

When the class don't have "color", Inspector is good.
only "showColor" and "v4" in a HorizontalGroup.

Code (CSharp):

1. //Case A
2. public class HorizontalGroupTest : MonoBehaviour {
3.     [HorizontalGroup]    [HideLabel]
4.     public bool showColor;
5.  
6.     [HorizontalGroup]    [HideLabel]
7.     public Vector4 v4 = Vector4.zero;
8.  
9.     //[ShowIf("showColor")]
10.     //[HorizontalGroup]    [HideLabel]
11.     //public Color color;
12. }

But when I try to show "color" control by "showColor".
It look weird.

Code (CSharp):

1. //Case B
2. public class HorizontalGroupTest : MonoBehaviour {
3.     [HorizontalGroup]    [HideLabel]
4.     public bool showColor;
5.  
6.     [HorizontalGroup]    [HideLabel]
7.     public Vector4 v4 = Vector4.zero;
8.  
9.     [ShowIf("showColor")]
10.     [HorizontalGroup]    [HideLabel]
11.     public Color color;
12. }
13.  

Even "showColor" is false, it still create a small empty space there.



When a class has many hide member in a [HorizontalGroup], all of than make a small space.
The other member has no space and show vary small.

How can I remove the empty space?

 

Oh, not many hide member.
It happened when a field and a sub field( in a data class) in the same HorizontalGroup.

Code (CSharp):

1. public class HorizontalGroupTest : MonoBehaviour {
2.     [HideLabel]
3.     public HorizontalGroupTestGoodItem itemA;
4.  
5.     [HideLabel]
6.     public HorizontalGroupTestBadItem itemB;
7.  
8.     [HorizontalGroup(100)]    [HideLabel]
9.     public GameObject gameObject;
10.  
11.     [HorizontalGroup]    [HideLabel]
12.     public HorizontalGroupTestBadItem itemC;
13. }
14.  
15. [System.Serializable]
16. public class HorizontalGroupTestGoodItem {  // A
17.     [HorizontalGroup(20)]
18.     [HideLabel]
19.     public bool showColor;
20.  
21.     [HorizontalGroup(LabelWidth = 1)]
22.     [HideLabel]
23.     public Vector4 v4 = Vector4.zero;
24.  
25.     //[ShowIf("showColor")]
26.     //[HorizontalGroup(LabelWidth = 1)]
27.     //[HideLabel]
28.     //public Color color1;
29. }
30.  
31. [System.Serializable]
32. public class HorizontalGroupTestBadItem {    // B C
33.     [HorizontalGroup(20)]    [HideLabel]
34.     public bool showColor;
35.  
36.     [HorizontalGroup(LabelWidth = 1)]    [HideLabel]
37.     public Vector4 v4 = Vector4.zero;
38.  
39.     [ShowIf("showColor")]
40.     [HorizontalGroup(LabelWidth = 1)]    [HideLabel]
41.     public Color color1;
42. }

A is good.
B just a little bit weird.
C is main problem.

 

Hello. I'm trying to copy one object's properties to other partially. At first I used Unity's SerializedObject, but now I had to switch to PropertyTree so it will support Properties as well.
After that I encountered one Issue - how can I change size of array/list/collection from InspectorProperty similiar to SerializedProperty.arraySize?
I tried getting SerializedProperty from within loop and modifying it, but I have to call Apply PropertyTree first, change array size, apply serialized object, Update PropertyTree. That's really slow. Is there any convinient way to do so?

 

Hi,

I am picking up work on a project that hasn't been touched in quite some time. This project uses Odin and was originally created in an earlier version of Unity. I don't recall which version but it is probably about two years old.

I updated the project to Unity 2018.3, and updated all assets used including Odin.

However, I am having trouble with code that used to work fine but no longer does. This code involved the serialization and deserialization of a SerializedScriptableObject instance to JSON using JsonUtil.and asset bundle data.

Code (CSharp):

1. HardwareComponent loadedComponent = JsonUtility.FromJson<HardwareComponent>(bundleAsset.text);

HardwareComponent is a SerializedSriptableObject

Code (CSharp):

1.     [Serializable]
2.     [CreateAssetMenu(menuName="Hardware/Hardware Component")]
3.     public class HardwareComponent : SerializedScriptableObject
4.  

The error I am getting is: ArgumentException: Cannot deserialize JSON to new instances of type 'HardwareComponent.'

Now as I said this code used to work fine, so I am a bit confused as to what has changed. Has there been a change in Odin's SerializedScriptableObject that makes this not work anymore?

 

Hello I am trying to serialize an instance of a serializedscriptableobject, send it over the network and overwrite the instance there, but I 'm receiving an error when deserializing

Code (CSharp):

1.     void SaveState(string url, GameState Data)
2.     {
3.         var data = SerializationUtility.SerializeValue<GameState>(Data, DataFormat.JSON);
4.         Task.Run(async () =>
5.         {
6.  
7.             await SaveStateAsync(url, data);
8.         });
9.     }
10.  
11. //Deserializing after receiving the bytes
12. var state = SerializationUtility.DeserializeValue<GameState>(data, DataFormat.JSON);
13.  
14.  

This is working fine with serializable classes/ structs but fails for scriptableobjects, is there something that I am missing? I could have the scriptable classes hold a serializable class but this seemed straight forward

 

Hi. I asked this in Discord but as it maybe needs a more detailed answer, I'll post it in here.
I'm looking to create a dropdown menu like this one where each item has a label and a colour. How can I create this in Odin (or indeed in Unity!). I was suggested to look at OdinMenuTree and OdinMenuItem but I can't find any good examples of how to use that for this purpose.

 

Hi Dave, Yes OdinMenuTrees with the help from OdinSelector is a really good candidate for a dropdown like that.

There are simpler ways of making them but this polished solution

Code (CSharp):

1. private void InSomeIMGUIContext()
2. {
3.     myColor = MyColorSelector.DrawColorDropdown(new GUIContent("Select Color"), myColor);
4. }
5.  
6. public class MyColorSelector : OdinSelector<Color>
7. {
8.     private static Dictionary<Color, string> colorNameLookup = new Dictionary<Color, string>()
9.         {
10.             { Color.red, "Red" },
11.             { Color.green, "Green" },
12.         };
13.  
14.     protected override void BuildSelectionTree(OdinMenuTree tree)
15.     {
16.         tree.DefaultMenuStyle = OdinMenuStyle.TreeViewStyle;
17.         tree.DefaultMenuStyle.IndentAmount += 20; // Room for the color preview.
18.  
19.         foreach (var item in colorNameLookup.OrderByDescending(x => x.Value))
20.         {
21.             var name = item.Value;
22.             var color = item.Key;
23.             var menuItem = tree.AddObjectAtPath(name, color).First();
24.             menuItem.OnDrawItem += (m) =>
25.             {
26.                 var rect = m.LabelRect.Padding(2);
27.                 rect.x -= 18;
28.                 rect.Padding(2);
29.                 rect.width = 16;
30.                 EditorGUI.DrawRect(rect, color);
31.                 SirenixEditorGUI.DrawBorders(rect, 1);
32.             };
33.         }
34.     }
35.  
36.     public static Color DrawColorDropdown(GUIContent label, Color color)
37.     {
38.         string name;
39.         if (!colorNameLookup.TryGetValue(color, out name))
40.         {
41.             name = color.ToString();
42.         }
43.  
44.         var selector = new TypeSelector(AssemblyTypeFlags.All, false);
45.         var selection = DrawSelectorDropdown(label, name, CreateAndShowSelector);
46.         if (selection != null && selection.Any())
47.         {
48.             color = selection.FirstOrDefault();
49.         }
50.  
51.         return color;
52.     }
53.  
54.     private static OdinSelector<Color> CreateAndShowSelector(Rect rect)
55.     {
56.         var selector = new ColorSelector();
57.         selector.ShowInPopup(rect);
58.         selector.EnableSingleClickToSelect();
59.         return selector;
60.     }
61. }

If you need further help with it, let me know!

The following is just a reminder to everyone who also finds this forum page, don't take the big title personally hehe, just making sure people see it.

For support come join us on Discord!

Our support is primarily going on Discord, our Issue-Tracker or from our contact page: So go find us there

Cheers!

 

Thanks very much for that! There is a missing method and a missing class in that sample
DrawSelectorDropdown and
new ColorSelector()

 

Ah sorry about that. ColorSelector should be MyColorSelector, but DrawSelectorDropdown should be available? It's a static method inside the base class (OdinSelector) What version of Odin are you on?

 

Thanks. I thought I had the latest version but I didn't. That's working perfectly now. Thank you so much for your help!

 

Is this only for a specific Unity?

I tried using it but:

error CS1061: Type `System.Collections.Generic.Dictionary<UnityEngine.Color,string>' does not contain a definition for `OrderByDescending' and no extension method `OrderByDescending' of type `System.Collections.Generic.Dictionary<UnityEngine.Color,string>' could be found. Are you missing `System.Linq' using directive?

With a few other errors

 

If you read what the error tells you, you'll know that you have to add the System.Linq using statement to the top of your script.

 

I made a simple database like in the example RPG editor, but I added a delete function. But when the delete function is pressed an error occurs. How to handle it? Thanks

 

You just need to add the missing using statements at the top of your script file. "using System.Linq;"

 

Hmm try doing it in a delayed call and see if that makes a difference: EditorApplication.delayedCall +=() => delete();

 

Thanks, it works

 

I have a little problem with renaming assets in this simple database. When I press the rename button, the editor window loses focus on the selected item.How to rename assets not lose the focus of the selected item?

 

Odin inspector can not serialize classes like below?

Code (CSharp):

1. public class ClassA: MonoBehaviour,IInterface{}
2. public class ClassA:ScriptableObject,IInterface{}
3.  
4. public class ClassB:SerializedMonoBehaviour{
5.    public IInterface Sample;
6. }
7.  
8.  

If I can drag gameObjects or scriptableObject assets and drop them in the inspector, It will be awesome.

 

Hi, I've been trying to understand why my Enter Play mode is taking so long in the Unity edtir, and I see that OdinEditor.OnDisable() is a huge portion of the "ReloadAssembly" time:



Do you have any idea why this might be happening?

Thanks!

 

Hello, I'm having trouble reverting values in a prefab that are overriding values in another nested prefab which are using Odin inspectors.

 

Hello, I have a list, set to show 1 item per page. Is there a way to control which page to show by a slider? Or by any script?