Wayback Machinekoobas.hobune.stream
May JUN Jul
Previous capture 13 Next capture
2021 2022 2023
1 capture
13 Jun 22 - 13 Jun 22
sparklines
Close Help
  • Products
  • Solutions
  • Made with Unity
  • Learning
  • Support & Services
  • Community
  • Asset Store
  • Get Unity

UNITY ACCOUNT

You need a Unity Account to shop in the Online and Asset Stores, participate in the Unity Community and manage your license portfolio. Login Create account
  • Blog
  • Forums
  • Answers
  • Evangelists
  • User Groups
  • Beta Program
  • Advisory Panel

Navigation

  • Home
  • Products
  • Solutions
  • Made with Unity
  • Learning
  • Support & Services
  • Community
    • Blog
    • Forums
    • Answers
    • Evangelists
    • User Groups
    • Beta Program
    • Advisory Panel

Unity account

You need a Unity Account to shop in the Online and Asset Stores, participate in the Unity Community and manage your license portfolio. Login Create account

Language

  • Chinese
  • Spanish
  • Japanese
  • Korean
  • Portuguese
  • Ask a question
  • Spaces
    • Default
    • Help Room
    • META
    • Moderators
    • Topics
    • Questions
    • Users
    • Badges
  • Home /
avatar image
0
Question by numberkruncher · Dec 17, 2013 at 01:44 PM · editorenumeditorguienumpopup

How to provide custom descriptions for EditorGUI.EnumPopup?

How can I specify custom descriptions for some enum values within a custom editor interface?

i.e.

 public enum MyEnum {
    [Description("More detailed description for ABC")]
    ABC,
    [Description("More detailed description for DEF")]
    DEF,
 }
Comment
Add comment
10 |3000 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

1 Reply

· Add your reply
  • Sort: 
avatar image
0
Best Answer

Answer by numberkruncher · Dec 17, 2013 at 01:44 PM

Here is a custom control for editing enum fields where custom descriptions can be specified by decorating values with System.ComponentModel.DescriptionAttribute:

 using UnityEngine;
 using UnityEditor;

 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.Linq;

 public static class CustomGUI {
     // Cache of enum values.
     private static Dictionary<Type, int[]> s_EnumValueCache = new Dictionary<Type, int[]>();
     // Cache of enum descriptions/nicified values.
     private static Dictionary<Type, string[]> s_EnumDescriptionCache = new Dictionary<Type, string[]>();

     public static int[] GetEnumValues<T>() {
         if (!s_EnumValueCache.ContainsKey(typeof(T)))
             s_EnumValueCache[typeof(T)] = Enum.GetValues(typeof(T)).Cast<int>().ToArray();
         return s_EnumValueCache[typeof(T)];
     }

     public static string[] GetEnumDescriptions<T>() {
         if (!s_EnumDescriptionCache.ContainsKey(typeof(T))) {
             var list = new List<string>();
             foreach (var value in Enum.GetValues(typeof(T))) {
                 var attribute = typeof(T).GetMember(value.ToString())[0].GetCustomAttributes(typeof(DescriptionAttribute), false).FirstOrDefault() as DescriptionAttribute;
                 list.Add( attribute != null ? attribute.Description : ObjectNames.NicifyVariableName(value.ToString()) );
             }
             s_EnumDescriptionCache[typeof(T)] = list.ToArray();
         }
         return s_EnumDescriptionCache[typeof(T)];
     }

     public static int EnumPopup<T>(Rect position, int value) {
         var values = GetEnumValues<T>();
         int selectedIndex = EditorGUI.Popup(position, Array.IndexOf(values, value), GetEnumDescriptions<T>());
         return (selectedIndex >= 0 && selectedIndex < values.Length) ? values[selectedIndex] : value;
     }
 }

Usage Example:

An enum can then be defined as follows:

 using System.ComponentModel;

 public enum MyEnum {
     [Description("More detailed description for ABC")]
     ABC,
     [Description("More detailed description for DEF")]
     DEF,
     LetUnityNicifyName,
 }

Which can be presented within a custom GUI:

 private MyEnum _selectedEnumValue = MyEnum.ABC;

 private void OnGUI() {
     Rect position = GUILayoutUtility.GetRect(GUIContent.none, EditorStyles.popup);
     _selectedEnumValue = (MyEnum)CustomGUI.EnumPopup<MyEnum>(position, (int)_selectedEnumValue);
 }
Comment
Add comment · Share
10 |3000 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Your answer

Hint: You can notify a user about this post by typing @username

Up to 2 attachments (including images) can be used with a maximum of 524.3 kB each and 1.0 MB total.

Follow this Question

Answers Answers and Comments

17 People are following this question.

avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image

Related Questions

EnumPopup an enum from another class 1 Answer

EditorGUI Enum help 1 Answer

Editor window BuildTarget as enum 2 Answers

Enums are not staying set between Editor and MonoBehavior (target) class 1 Answer

Initialising List array for use in a custom Editor 1 Answer


Enterprise
Social Q&A

Social
Subscribe on YouTube social-youtube Follow on LinkedIn social-linkedin Follow on Twitter social-twitter Follow on Facebook social-facebook Follow on Instagram social-instagram

Footer

  • Purchase
    • Products
    • Subscription
    • Asset Store
    • Unity Gear
    • Resellers
  • Education
    • Students
    • Educators
    • Certification
    • Learn
    • Center of Excellence
  • Download
    • Unity
    • Beta Program
  • Unity Labs
    • Labs
    • Publications
  • Resources
    • Learn platform
    • Community
    • Documentation
    • Unity QA
    • FAQ
    • Services Status
    • Connect
  • About Unity
    • About Us
    • Blog
    • Events
    • Careers
    • Contact
    • Press
    • Partners
    • Affiliates
    • Security
Copyright © 2020 Unity Technologies
  • Legal
  • Privacy Policy
  • Cookies
  • Do Not Sell My Personal Information
  • Cookies Settings
"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Spaces
  • Default
  • Help Room
  • META
  • Moderators
  • Explore
  • Topics
  • Questions
  • Users
  • Badges