Class: Dialog

Hierarchy

• Handle<dialog>

  ↳ Dialog

Constructors

constructor

new Dialog(): Dialog

Returns: Dialog

Defined in: handles/dialog.ts:22

Properties

handle

• Readonly handle: dialog

Inherited from: Handle.handle

Defined in: handles/handle.ts:6

Accessors

id

id(): number

Get the unique ID of the handle. The ID is recycled once you destroy the object.

Returns: number

The unique ID of a handle object.

Defined in: handles/handle.ts:18

Methods

addButton

addButton(text: string, hotkey?: number, quit?: boolean, score?: boolean): DialogButton

Parameters:

Name	Type	Default value
text	string	-
hotkey	number	0
quit	boolean	false
score	boolean	false

Returns: DialogButton

Defined in: handles/dialog.ts:27

---

clear

clear(): void

Returns: void

Defined in: handles/dialog.ts:31

---

destroy

destroy(): void

Returns: void

Defined in: handles/dialog.ts:35

---

display

display(whichPlayer: MapPlayer, flag: boolean): void

note Dialogs can not be shown at map-init. Use a wait or a zero-timer to display as soon as possible.

Parameters:

Name	Type
whichPlayer	MapPlayer
flag	boolean

Returns: void

Defined in: handles/dialog.ts:42

---

setMessage

setMessage(whichMessage: string): void

Parameters:

Name	Type
whichMessage	string

Returns: void

Defined in: handles/dialog.ts:46

---

fromHandle

static fromHandle(handle: dialog): Dialog

Parameters:

Name	Type
handle	dialog

Returns: Dialog

Defined in: handles/dialog.ts:50