Options used when opening a script dialogue. Controls the targeted player, the use of the camera and if we want to wait if the user is busy.

interface ShowDialogueOptions {
    busyRetriesCount?: number;
    busyRetriesTick?: number;
    lockPlayerCamera?: boolean;
    player: Player;
}

Hierarchy

  • Partial<OptionalShowDialogueOptions>
  • RequiredShowDialogueOptions
    • ShowDialogueOptions

Properties

busyRetriesCount?: number

Configures how many times retry the script dialogue if the player is busy.

5
busyRetriesTick?: number

Configures how long (in ticks) to wait between retries if the player is busy.

5
lockPlayerCamera?: boolean

Locks the camera when opening a script dialogue. This prevents the camera from panning when moving the mouse/dragging on transitions.

true
player: Player

Player to show the script dialogue to