isEnabled
isEnabled: (Notification) -> booleanWhether it does anything.
Notification.new(…)
Notification.OFF
Notification.ON| Method | Returns | Description |
|---|---|---|
isEnabled() | boolean | Whether it does anything. |
getFlash() | FlashNotification? | How it flashes the game frame. |
getFlashColor() | Color? | The flash's colour. |
getRequestFocus() | RequestFocusType? | The window focus request it makes. |
getSound() | NotificationSound? | The sound it plays. |
getSoundName() | string? | The name of the custom sound it plays, if any. |
getTimeout() | number | How long it shows, in milliseconds. |
getVolume() | number | The volume of a custom sound. |
isGameMessage() | boolean | Whether it adds a message to the chatbox. |
isInitialized() | boolean | Whether its settings were filled in: with isOverride, what keeps it from taking the user's. |
isOverride() | boolean | Whether it uses its own settings rather than the user's. |
isSendWhenFocused() | boolean | Whether it fires even when the client is focused. |
isTray() | boolean | Whether it shows a tray notification. |
getTrayIconType() | any | The tray notification's icon (TrayIcon.MessageType). |
withEnabled(enabled: boolean) | Notification | A copy with enabled changed. |
withFlash(flash: FlashNotification?) | Notification | A copy with flash changed. |
withFlashColor(flashColor: Color?) | Notification | A copy with flashColor changed. |
withGameMessage(gameMessage: boolean) | Notification | A copy with gameMessage changed. |
withOverride(override: boolean) | Notification | A copy with override changed. |
withRequestFocus(requestFocus: RequestFocusType?) | Notification | A copy with requestFocus changed. |
withSendWhenFocused(sendWhenFocused: boolean) | Notification | A copy with sendWhenFocused changed. |
withSound(sound: NotificationSound?) | Notification | A copy with sound changed. |
withSoundName(soundName: string?) | Notification | A copy with soundName changed. |
withTimeout(timeout: number) | Notification | A copy with timeout changed. |
withTray(tray: boolean) | Notification | A copy with tray changed. |
withVolume(volume: number) | Notification | A copy with volume changed. |
withInitialized(initialized: boolean) | Notification | A copy with initialized changed. |
withTrayIconType(trayIconType: any) | Notification | A copy with trayIconType changed. |
new(...any) | Notification | Every field, or none. In order: enabled, initialized, override, tray, trayIconType, requestFocus, sound, soundName, `volume… |
| Field | Type | Description |
|---|---|---|
OFF | Notification | Disabled. |
ON | Notification | Enabled, with the user's notification settings. |
| Method | Returns | Description |
|---|---|---|
NotificationClass.new | Notification | Every field, or none. In order: enabled, initialized, override, tray, trayIconType, requestFocus, sound, soundName, `volume… |
isEnabledisEnabled: (Notification) -> booleanWhether it does anything.
getFlashgetFlash: (Notification) -> FlashNotification?How it flashes the game frame.
getFlashColorgetFlashColor: (Notification) -> Color?The flash's colour.
getRequestFocusgetRequestFocus: (Notification) -> RequestFocusType?The window focus request it makes.
getSoundgetSound: (Notification) -> NotificationSound?The sound it plays.
getSoundNamegetSoundName: (Notification) -> string?The name of the custom sound it plays, if any.
getTimeoutgetTimeout: (Notification) -> numberHow long it shows, in milliseconds.
getVolumegetVolume: (Notification) -> numberThe volume of a custom sound.
isGameMessageisGameMessage: (Notification) -> booleanWhether it adds a message to the chatbox.
isInitializedisInitialized: (Notification) -> booleanWhether its settings were filled in: with isOverride, what keeps it from taking the user's.
isOverrideisOverride: (Notification) -> booleanWhether it uses its own settings rather than the user's.
isSendWhenFocusedisSendWhenFocused: (Notification) -> booleanWhether it fires even when the client is focused.
isTrayisTray: (Notification) -> booleanWhether it shows a tray notification.
getTrayIconTypegetTrayIconType: (Notification) -> anyThe tray notification's icon (TrayIcon.MessageType).
withEnabledwithEnabled: (Notification, enabled: boolean) -> NotificationA copy with enabled changed.
withFlashwithFlash: (Notification, flash: FlashNotification?) -> NotificationA copy with flash changed.
withFlashColorwithFlashColor: (Notification, flashColor: Color?) -> NotificationA copy with flashColor changed.
withGameMessagewithGameMessage: (Notification, gameMessage: boolean) -> NotificationA copy with gameMessage changed.
withOverridewithOverride: (Notification, override: boolean) -> NotificationA copy with override changed.
withRequestFocuswithRequestFocus: (Notification, requestFocus: RequestFocusType?) -> NotificationA copy with requestFocus changed.
withSendWhenFocusedwithSendWhenFocused: (Notification, sendWhenFocused: boolean) -> NotificationA copy with sendWhenFocused changed.
withSoundwithSound: (Notification, sound: NotificationSound?) -> NotificationA copy with sound changed.
withSoundNamewithSoundName: (Notification, soundName: string?) -> NotificationA copy with soundName changed.
withTimeoutwithTimeout: (Notification, timeout: number) -> NotificationA copy with timeout changed.
withTraywithTray: (Notification, tray: boolean) -> NotificationA copy with tray changed.
withVolumewithVolume: (Notification, volume: number) -> NotificationA copy with volume changed.
withInitializedwithInitialized: (Notification, initialized: boolean) -> NotificationA copy with initialized changed.
withTrayIconTypewithTrayIconType: (Notification, trayIconType: any) -> NotificationA copy with trayIconType changed.
newnew: (...any) -> NotificationEvery field, or none. In order: enabled, initialized, override, tray, trayIconType, requestFocus, sound, soundName, volume, timeout, gameMessage, flash, flashColor, sendWhenFocused.