EnumType

Inherits: LibTSMModule

Functions

IsType

function BaseType.EnumType.IsType(value)
  -> boolean

Returns whether or not the passed value is an enum type.

Parameters:

Name	Type	Description
value	EnumObject | any	The value to check

Returns:

Type	Description
boolean

New

function BaseType.EnumType.New(name, values)
  -> <T:EnumObject>

Creates an enum object.

Parameters:

Name	Type	Description
name	<T>
values	T

Returns:

Type	Description
<T:EnumObject>

NewNested

function BaseType.EnumType.NewNested(name, values)
  -> <T:EnumObject>

Creates an enum object which allows for nested values (performance will be worse).

Parameters:

Name	Type	Description
name	<T>
values	T

Returns:

Type	Description
<T:EnumObject>

NewValue

function BaseType.EnumType.NewValue()
  -> EnumValue

Creates a new enum value for use while defining a new type.

Returns:

Type	Description
EnumValue

Methods

HasValue

function EnumObject:HasValue(value)
  -> boolean

Parameters:

Name	Type	Description
value	EnumValue | any

Returns:

Type	Description
boolean