Class NoticeService

Index

Constructors

Methods

clearNotice playSound printToChat showNotice

Constructors

constructor

new NoticeService(owner: string): NoticeService
Parameters
- owner: string
  The addon that shows the messages: its block of lines in the shared notice.
Returns NoticeService
- Defined in notice.service.ts:29

Methods

clearNotice

clearNotice(): void
This addon's message goes out now, without waiting for its time.

Returns void
- Defined in notice.service.ts:64

playSound

playSound(kitName: string | undefined, fallbackId: number): void
Plays a sound by its SOUNDKIT name, or by fallbackId when the client has no such name.
Parameters
- kitName: string | undefined
- fallbackId: number
Returns void
- Defined in notice.service.ts:35

printToChat

printToChat(text: string): void
A line in the chat window.
Parameters
- text: string
Returns void
- Defined in notice.service.ts:41

showNotice

showNotice(text: string): void
A message in the upper middle of the screen for NOTICE_SECONDS, under the messages of the other addons that are showing one. (UIErrorsFrame fades a message after a second or two: too short to read.)
Parameters
- text: string
Returns void
- Defined in notice.service.ts:49