Ability to add enum argument to button functions

Well spotted and great fix. Thank you for sharing, I have implemented it and reuploaded the file.

 

I would just like to let the dev team know this is the thread we are sent to when asking this question in google. Would be a wonderful addition.

 

Its a small world. I use only enums on my buttons. I am just that nice to my memory.

 

Works as expected, thank you very much!

This should definitely be a Unity built-in feature! =)

It would be very nice too if we could see the actual Id number in the Editor.
For instance: "EnumName - EnumID"

 

Just type (int)MyEnumBtn.Action = the number

 

Code (CSharp):

1. using UnityEngine;
2. using System.Collections;
3. using UnityEngine.UI;
4. using System;
5. public class Test_Btn : MonoBehaviour {
6.     public enum Btn_Name
7.     {
8.         Btn_A, Btn_B, Btn_C, Btn_D, Btn_E, Btn_AA, Btn_BB, Btn_CC, Btn_DD, Btn_EE,
9.     }
10.  
11.     private GameObject gm_V;
12.     private Transform btn_ParentLayout;
13.     // Use this for initialization
14.     void Start () {
15.         gm_V = GameObject.Find("Viewport").gameObject;
16.         if (gm_V!=null && gm_V.GetComponent<VerticalLayoutGroup>() == null)
17.         {
18.             gm_V.AddComponent<VerticalLayoutGroup>();
19.         }
20.         btn_ParentLayout = gm_V.transform.GetChild(0);
21.         GameObject btn_Res = Resources.Load<GameObject>("Prefabs/Btn_");
22.         Btn_Name[] btnAllEnum = (Btn_Name[]) Enum.GetValues(typeof(Btn_Name));
23.         for (int i = 0; i < btnAllEnum.Length; i++)
24.         {
25.             GameObject gmIns = Instantiate(btn_Res) as GameObject;
26.             gmIns.transform.SetParent(btn_ParentLayout);
27.             Button btn_Gm = gmIns.GetComponent<Button>();
28.             Btn_Name btnType = btnAllEnum[i];
29.             gmIns.name = btnType.ToString();
30.             gmIns.GetComponentInChildren<Text>().text = btnType.ToString();
31.             btn_Gm.onClick.AddListener(delegate () {
32.  
33.                 OnClick_BtnEnum(btnType);
34.             });
35.         }
36.     }
37.  
38.     void OnClick_BtnEnum(Btn_Name btn_Type)
39.     {
40.         Debug.Log("Click BtnEnum??"+ btn_Type);
41.     }
42.    
43. }
44.  

 

The hole point with Enums is that they are fast and not string based, the code you just posted uses string in loops, hence the whole point of enum gone..

 

2 Years later, it is 2017 and we still can't use enums with UnityEvents. The technology just isn't there yet!

 

So will it be added or not ?

 

more like this? (just for kissUI)

 

@Tim-C @phil-Unity Enums with UI events seem like something that should have been done long ago. Is it still on the TODO list? Any plans to implement it in the near future?

 

This must be in the TODO list right after nested prefabs

 

+1 want this

 

Yes please - the whole point of enum is type safety and to reduce the possibility of introducing errors due to typos or just not remembering that 1 = Dog and 2 = Cat. That's why we don't have strings "Monday", "Tuesday" and "Wednesday" in our code - but instead use named int values, i.e. enums.

I don't want to pass strings or ints to OnClick events and then cast them to the typesafe enum. This is just asking for errors to creep in.

 

Obligatory monthly bump of this thread, I guess, but worth it all the same. Enum params on UGUI button events are a must. And frankly, with the number of custom inspector assets that are out there that are able to introduce things Unity doesn't include by default, this doesn't seem like something that requires a grand plan or anything.

 

Same goes for Gameobject tags

 

People think this is really easy to fix, but the problem lies deeper and this is one of the symptoms. The problem is Unity's God-awful serialization system that doesn't allow polymorphism. For example not being able to serialize a Giraffe or Elephant type in an Animal type field. It gets the job done for most unprofessional users, but if you look into the .dll files you can see all the terrible ways Unity tries to get around the issue. For example, in order to serialize a small range of simple types like integers, floats, strings, etc. in event arguments it has a field for each type! What a waste of space.

So why can't it just add an Enum typed field?
Because the Unity serialization system doesn't support polymorphism, meaning it would have to have a field for each enum type, which is obviously not a viable solution at all, so they just didn't include that feature. The best you can do without an extensive rehaul is probably the solution I posted earlier. Make a method with an integer argument and include the type of the enum in an attribute above the method, then the editor can display it in the inspector as that type.

If Unity wants to fix this issue they will have to redo the serialization system, which they apparently have no intention of doing, so they just have their people run around and say "they'll get to it". It requires too much time to redo it and for what? A determined minority that is easily ignored. Instead, they want to work on bigger features for their main userbase and fixing bugs.

I posted a workaround earlier that you can use.

TL;DR:
Unity will probably never fix this as well as a lot of other things because of their bad serialization system, but you can use the workaround I posted earlier.

 

Almost 3 years later...

I guess no one is working on this anymore.

 

You guys rock! Thanks!

 

As much as I would absolutely love to see this (This is a +1 on the feature request), I can see the difficulty here. Enums can be flag enums. And anyone who works with those knows that Unity doesn't implement them very well and we have to run to special property drawers and stuff. So... Unity, please figure out how to work with enums. It's been years. Enums are a good thing. Please include support for them by default without having to install extra editor classes just to see them.

 

Well, if what @llamagod says is true then we may never see it or if we do it'll be when they feel like doing stuff that is on the back-burner. I am going to make a post here as I also want this feature and want to keep attention on this.

 

Bumped into this issue myself.
@phil-Unity Any news?

 

Shame on Unity. 3 years and there is still nothing... I hope Unreal Engine brings C# support with a good documentation and mobile optimization. Then everybody will go for UE4. I am tired of dealing with Unity's problems. Everything about Unity is problem. The only thing why most people is using Unity is that it has no real alternative. I hope we will see one.

 

Glad I found the fixes in this thread. A shame this isnt baked into Unity yet.

 

Except although the actual fix for this is simple, Implementing the fix is not, its a hack that circumvents the compiled code, is imperfect (can't use in EventTriggers) and not future proof.

The simplest "proper" solution is for Unity to add this to their code base

 

@llamagod I had to add:

using System;
using UnityEngine;

to the EnumActionAttribute script. Is that expected?

 

Damn bump this..

 

Could we please get any update form a developer?

 

This is a very nice solution, thanks!

One thing though, how can we also make it work for toggles?

 

Just found this old post and I have to say, sir your script works f**king awesome!!!! Nice job man!!!!
(And Unity still doesn't provide this feature in 2017.... guess there're really some big problems fixing this)

also, as @AdamBL mentioned, if you want to use @llamagod 's script in a quick way, you have to add

Code (csharp):

1.  
2. using System;
3. using UnityEngine;
4.  

in EnumActionAttribute.cs

 

I am currently facing this same old problem. Even though Unity serialization system has this flaw according to @llamagod , they must fix this ASAP.

 

+1 This would be nice

 

Seriosuly, we need an explanation...

 

Almost 3 years later and still not implemented ? :/
It's like passing int but instead of raw int we are passing int value from enum list.
It can't be so hard to implement dear Unity team that it takes so long and still nothing

 

lol

 

3 years later, not implemented

 

+1, ran into this myself, going to be a real headache to work around

 

was shocked to discover this wasn't built in today... +1 from me

also, to anyone finding this, make sure to vote here - https://feedback.unity3d.com/suggestions/allow-enums-with-onclick-buttons

 

Isn't 4 YEARS enough time Phil?

 

I coming to the same thread 3 years later and nothing has changed. Impressive!

 

This is definitely needed, it's simple, and basically everyone wants it...

 

I put a button down on a form today and wanted to pass an enum through on its event.

Found out I cannot do it.
Googled it, saw people from 2014 saying: "HEY we want this"
Saw devs' say "We shall do it!"

RIP 2018.

For all the shade you guys throw on enums in the docs and tuts over the years, it's pretty sad that this is not possible
and that you guys don't reply or give updates on when it will be done.

We are all developers on one level or another on here, so don't be afraid to say if it's hard
THEN SAY listen guys: This gonna be hard but we will do it, or screw it too hard wont do it
with a bit of an explanation. don't just go AFK. ffs.



Now excuse me while i go apply an UGLY ASF BODGE to my button which can't use enums.
YOU BASTARDS!

 

My workaround: added a super-simple script that holds the enum as a public property, then I pass that component reference to onclick and pull the enum out in the handler.

Gotta admit, it's kinda silly we can set components as on click parameters but not enums.

Also gotta admit unity framework devs probably have more important things on their plate, so meh. whatever.

 

easiest workaround I can ever think of:
we can use ScriptableObject:

Code (CSharp):

1. using UnityEngine;
2.  
3. [CreateAssetMenu(fileName = "EnumTeam", menuName = "EnumTeam")]
4. public class EnumTeam : ScriptableObject {
5.  
6.     public Team t;
7. }
8.  

 

Thanks for the transparency Phil! Will keep an eye out for this

 

Thank you for the update, greatly appreciate it.

Definitely a feature that supports good coding practices all around, but I can completely understand that adding complex data structures in the Unity UI is quite challenging. Please keep us updated if you manage to add the feature.

 

@llamagod Unfortunately there's an annoying quirk with your code - when selecting multiple buttons with an enum UnityEvent, they all set to the same int internally.

 

I have replaced the files in my original post to use the namespaces required in EnumActionAttribute.cs as mentioned by @AdamBL and @samuelchou

I made a very small change to UnityEventDrawer.cs to fix the problem you describe. I just disabled multi-editing since it's not particularly useful in this case and there are a lot of caveats to enable multi-editing that could break a lot of stuff.