Class TextInterceptor

The TextInterceptor is a wrapper class that intercepts and logs any messages that would be displayed on-screen.

Index

Constructors

Properties

Methods

clearLogs formatText showDialogue showText

Constructors

constructor

new TextInterceptor(scene: BattleScene): TextInterceptor
Parameters
- scene: BattleScene
Returns TextInterceptor
- Defined in test/test-utils/text-interceptor.ts:12

Properties

`Readonly`logs

logs: string[] = []

A log containing messages having been displayed on screen, sorted in FIFO order.

Methods

clearLogs

clearLogs(): void
Clear the current content of the TextInterceptor.

Returns void
- Defined in test/test-utils/text-interceptor.ts:18

`Private`formatText

formatText(text: string): string
Format text to be displayed to the test console, as follows:
1. Replaces new lines and new text boxes (marked by $) with indented new lines.
2. Removes all @c{}, @d{}, @s{}, and @f{} flags from the text.
3. Makes text blue
Parameters
- text: string
  The unformatted text
Returns string
The formatted text
- Defined in test/test-utils/text-interceptor.ts:41

showDialogue

showDialogue(text: string, name: string): void
Parameters
- text: string
- name: string
Returns void
- Defined in test/test-utils/text-interceptor.ts:28

showText

showText(text: string): void
Parameters
- text: string
Returns void
- Defined in test/test-utils/text-interceptor.ts:22