Lua API
On this page

Enum

Inherits from

Tip

This is a builtin dotnet type. The documentation and api interface are generated from dotnet source files.

Provides the base class for enumerations.

Methods:

CompareTo(target?: Object) : number

Compares this instance to a specified object and returns an indication of their relative values.

Parameters:
NameTypeDefaultSummary
targetObject

An object to compare, or null.

Returns:number

GetNames() : string

static

Retrieves an array of the names of the constants in a specified enumeration type.

Returns:string

GetPropertyKeys() : string[]

Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts

Returns:string[]

GetTypeCode() : TypeCode

Returns the type code of the underlying type of this enumeration member.

Returns:TypeCode

HasFlag(flag: Enum) : boolean

Determines whether one or more bit fields are set in the current instance.

Parameters:
NameTypeDefaultSummary
flagEnum

An enumeration value.

Returns:boolean

ToNumber(source)

ToString()

ToString(format) format string