EnumItem

Overview

Description

The EnumItem is a component that represents a single value within an enumeration (enum). EnumItems are used to define constants in a structured way, making the code more readable and maintainable.

Properties

Name

string

This is the name of the EnumItem. It acts as a unique identifier within its EnumType and is used in the code for referencing this specific value.

Code Samples

-- Example of using EnumItem's Name
local itemName = EnumItem.Name
print("The EnumItem name is: " .. itemName)

Value

number

The Value property is a numerical representation assigned to the EnumItem. It is primarily used internally or for comparison purposes.

Code Samples

-- Example of accessing EnumItem's Value
local itemValue = EnumItem.Value
if itemValue == 1 then
    print("This EnumItem represents the first value.")
end

EnumType

Enum

The EnumType property indicates the enumeration to which this EnumItem belongs. It helps in identifying the group or category of the EnumItem.

Code Samples

-- Example of accessing EnumType
local itemEnumType = EnumItem.EnumType
print("EnumItem belongs to: " .. tostring(itemEnumType))

Constructors

Methods