FlashNotification

Methods
8
Fields
5

Getting one

FlashNotification.valueOf(…)
FlashNotification.DISABLED
FlashNotification.FLASH_TWO_SECONDS

Methods

MethodReturnsDescription
name()stringThe constant's name as declared.
ordinal()numberThe constant's 0-based position in values().
toString()stringThis enum's own text for the constant, which can differ from name(); tostring(c) answers the same.
compareTo(FlashNotification)numberThis ordinal less other's.
equals(any)booleanWhether other is this constant. == answers the same.
getType()stringThis constant's getType() value, listed on each constant.
values(){FlashNotification}Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.
valueOf(string)FlashNotificationvalueOf(name): the constant named name; any other name is an error.

Fields

FieldTypeDescription
DISABLEDFlashNotificationDISABLED: ordinal 0; getType() "Off".
FLASH_TWO_SECONDSFlashNotificationFLASH_TWO_SECONDS: ordinal 1; getType() "Flash for 2 seconds".
SOLID_TWO_SECONDSFlashNotificationSOLID_TWO_SECONDS: ordinal 2; getType() "Solid for 2 seconds".
FLASH_UNTIL_CANCELLEDFlashNotificationFLASH_UNTIL_CANCELLED: ordinal 3; getType() "Flash until cancelled".
SOLID_UNTIL_CANCELLEDFlashNotificationSOLID_UNTIL_CANCELLED: ordinal 4; getType() "Solid until cancelled".

Returned by

MethodReturnsDescription
ClientConfig.flashNotificationFlashNotificationHow notifications flash the game frame.
FlashNotificationClass.valueOfFlashNotificationvalueOf(name): the constant named name; any other name is an error.
FlashNotificationClass.values{FlashNotification}Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.
Notification.getFlashFlashNotification?How it flashes the game frame.

Method details

toString

toString: (FlashNotification) -> string

This enum's own text for the constant, which can differ from name(); tostring(c) answers the same.

values

values: () -> {FlashNotification}

Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.