CWEnumUtils

Content Warning Enum Utils

A library with utilities for dynamically creating and getting Enums.

Originally for Lethal Company, but ported to Content Warning for a request. Everything is identical except the dll relies on CW files instead.

For feature requests or issues, go to my repo.

General Users

This mod is just a dependency for other mods, it doesn't add content by itself.

Recommended Install

Please use a mod manager. I recommend r2modman as the mod manager to use.

Developer Quick-Start

Download the latest release from either the Thunderstore.

Extract the zip and add a reference to the dll file of the mod in the IDE (Visual Studio, Rider, or etc) you use.

Enum Utilities

Getting Enums

Shortcuts for getting enums. There is various functions you can use. Here are some of the examples.

[BepInPlugin(modGUID, modName, modVersion)]
public class ExampleModClass : BaseUnityPlugin
{
    private void Start()
    {
        RARITY mythic = EnumUtils.Parse("mythic");

        if (EnumUtils.TryParse("example", out RARITY example))
        {

        }

        int numOfRarities = EnumUtils.Count();
        RARITY minRarity = EnumUtils.GetMinValue();
        RARITY maxRarity = EnumUtils.GetMaxValue();
        RARITY randomRarity = EnumUtils.GetRandom();
        RARITY unusedRarityValue = EnumUtils.GetFirstFreeValue();
        string[] allRarityNames = EnumUtils.GetNames();
        RARITY[] allRarityValues = EnumUtils.GetValues();
        bool doesExampleRarityExist = EnumUtils.IsDefined("example");
        Type valueType = EnumUtils.GetUnderlyingType();
        bool hasFlags = EnumUtils.IsPowerOfTwoEnum();
    }
}

Creating Enums

You can use the EnumUtils class to create enums just like this.

[BepInPlugin(modGUID, modName, modVersion)]
public class ExampleModClass : BaseUnityPlugin
{
    // Associate an unused enum value with a name of your choosing.
    private static readonly RARITY example = EnumUtils.Create("example");
    // Associate a specific enum value with a name of your choosing.
    private static readonly RARITY example2 = EnumUtils.Create("example2", -1);

    private void Awake()
    {
    }
}

Enum Holders

Another way to create enums.

Add the [EnumHolder] attribute to a class, run the RegisterAllEnumHolders function, and any static enum fields will have an enum value created with the name of the field. It'll select any unused enum value to be associated with that name (or if you specify a value it'll use that one).

using System.Reflection;

[BepInPlugin(modGUID, modName, modVersion)]
public class ExampleModClass : BaseUnityPlugin
{
    private void Awake()
    {
        EnumUtils.RegisterAllEnumHolders(Assembly.GetExecutingAssembly());
    }
}

[EnumHolder]
public static class ExampleEnumHolderClass 
{
    public static readonly RARITY example;
    public static readonly RARITY example2 = (RARITY)-1;
}