Understanding Dictionary Usage with Enum

Understanding Dictionary Usage with Enum

What is an enum?

In C#, an enum represents a collection of named constants. By default, enum values start from 0, but it is recommended to explicitly assign = 0 to avoid confusion when linking with arrays or other data structures.

enum PlayerState
{
    Idle = 0,
    Run,
    Jump
}

In this example, Idle has a value of 0, Run is 1, and Jump is 2. If you do not specify a value, they automatically increment by 1.

How to convert a string to an enum value (Enum.TryParse)

To convert a string to an enum value, use the Enum.TryParse<T>() method. For example, if you have the string "Run", you can convert it to PlayerState.Run like this:

Enum.TryParse<PlayerState>("Run", out PlayerState state);
Debug.Log(state);
// Output: Run

If the conversion is successful, state will hold the PlayerState.Run value. If it fails, it returns false, allowing safe error handling.

Comparison with int.TryParse

int.TryParse("123", out int number) does not use generics because int is a single type. However, there are many different enums like PlayerState, MonsterState, and WeaponState. Therefore, Enum.TryParse<EnumType>() requires you to specify the target enum type with a generic parameter.

Precautions when using enums with arrays

When using enums with arrays, be cautious. Arrays always start from index 0, but if an enum does not start from 0, indexing mismatches can occur.

enum PlayerState
{
    Idle = 3,
    Run,
    Jump
}

If the enum starts at 3, you must ensure the array can accommodate indices [3], [4], and [5]. Otherwise, indices [0] to [2] are wasted memory.

Thus, it is best practice to define enum values sequentially starting from 0.

Using Dictionary with enum (Simple Example)

Instead of arrays, using a Dictionary allows easier management even if enum values are non-sequential. Here is a simple way to initialize a Dictionary:

var playerStateDic = new Dictionary<PlayerState, string>
{
    { PlayerState.Idle, "Currently in Idle state." },
    { PlayerState.Run, "Currently in Run state." },
    { PlayerState.Jump, "Currently in Jump state." }
};

This way, you can associate descriptions directly with each PlayerState value.

Example of using the Dictionary

string runStateText = playerStateDic[PlayerState.Run];
Debug.Log(runStateText);
// Output: Currently in Run state.

Automatically populating a Dictionary by iterating through an enum

If you want to automatically populate the Dictionary based on enum values, you can use a simple foreach loop:

var playerStateDic = new Dictionary<PlayerState, string>();

foreach (PlayerState state in Enum.GetValues(typeof(PlayerState)))
{
    playerStateDic.Add(state, "Currently in " + state + " state.");
}

Verification Example

string idleText = playerStateDic[PlayerState.Idle];
Debug.Log(idleText);
// Output: Currently in Idle state.

string jumpText = playerStateDic[PlayerState.Jump];
Debug.Log(jumpText);
// Output: Currently in Jump state.

Conclusion

Enums improve code readability. Using a Dictionary with enums allows much cleaner and safer management of states. Especially when associating descriptions or names with different states, enums combined with Dictionary are very effective. Please take this opportunity to practice using enums and Dictionary together!

Popular posts from this blog

Understanding Arrays as Reference Types in C#

Image
Arrays as Reference Types In programming, it's important to understand the behavior of arrays. In most programming languages including C#, arrays are treated as reference types. This article will explore what that means and how to use that knowledge effectively. Value Types vs Reference Types In C#, data types are categorized into two main types: Value types : Store actual values directly. Examples : int , float , bool , struct Reference types : Store memory addresses instead of the actual values. Examples: class , string , array , delegate Arrays, like classes, are reference types. When you assign one array variable to another, you're copying the reference, not the actual data. Example: Arrays as Reference Types using System; class Program { static void Main() { int[] array1 = { 1, 2, 3 }; int[] array2 = array1; // Copy reference array2[0] = 100; Console.WriteLine(array1[0]); // Out...
Read more

Setting Up a Basic Follow Camera with Cinemachine 3.x

Image
Setting Up a Basic Follow Camera with Cinemachine 3.x Cinemachine has been significantly upgraded in version 3.x, introducing new concepts, improved terminology, and a refined workflow. In this post, we’ll go through how to set up a simple follow camera using the latest version. For more advanced examples, be sure to check out the sample scenes provided in the Cinemachine package—they’re very helpful for understanding the system. Install the Cinemachine Package Start by downloading and importing the Cinemachine package from the Unity Package Manager. Check the Main Camera After installation, you'll notice that the Main Camera now has a Cinemachine Brain component attached. Make sure the Live Camera field shows the name of your Cinemachine Camera. Create a Cinemachine Camera In the Hierarchy window, right-click and go to Cinemachine > Cinemachine Camera to create a new virtual camera. Set the Tracking Targe...
Read more

How to Initialize Struct – C# Struct Initialization Guide

Image
How to Initialize Struct – C# Struct Initialization Guide In C#, there are multiple ways to declare and initialize structs. While using just one method is often enough, it's common to encounter different initialization styles in real-world code. This guide summarizes the most common approaches, including how to handle struct arrays and lists. Struct Declaration struct Item { public string name; public int price; public string desc; } 1. Declare First, Assign Later This is the most straightforward method. Declare the struct first, then assign values to its fields one by one. Item item; item.name = "Fireball"; item.price = 100; item.desc = "Deals fire damage to the enemy."; Note: Structs are value types, so you can declare them without new . However, you must initialize all fields before use, or you'll get a compile-time error. 2. Use new and Assign Fields Item item = new Item(); item.name = "Fir...
Read more