Simple Enum

A simple Enum class implementation for both Lua and Luau, inspired by Java's Enums (the default ones without a constructor) and the way @herb-ert implemented enums in js.

Both implementations are almost the same, with the only differences being that the Luau implementation is fully typed and replaces some Lua functionality with Luau specific versions (for example the Luau version uses table.freeze instead of setting the __newindex of the enum to ensure immutability).

Note

The Lua version should work with all 5.1+ Lua versions

LuaRocks

You can install SimpleEnum with LuaRocks:

luarocks install simpleenum

Example usage

Using this module is the same for both Lua and Luau versions.

local enum = require("simple_enum")

local DayState = enum.new({
	"DAY",
	"DUSK",
	"NIGHT",
	"DAWN"
}) -- in Luau you could add ":: enum.EnumType" here

local currentDayState = DayState.DAY
print(currentDayState) -- 1

currentDayState = DayState:next(currentDayState)
print(currentDayState) -- 2

print(DayState.NIGHT == currentDayState) -- false
print(DayState:values()) -- a table containing enum values as strings (DAY, DUSK, NIGHT, DAWN)
print(DayState:ordinals()) -- a table containing enum ordinals as numbers (1, 2, 3, 4)
print(DayState:compare(DayState.DAY, DayState.NIGHT)) -- -2, works the same as Java's compareTo
print(DayState:next(DayState.DUSK)) -- NIGHT
print(DayState:previous(DayState.DUSK)) -- DAY
print(DayState:nextOrdinal(DayState.DUSK)) -- 3
print(DayState:previousOrdinal(DayState.DUSK)) -- 1
print(DayState:getByOrdinal(4)) -- DAWN