1681-engine / index / Letterbox

Class: Letterbox

Defined in: src/transitions/Letterbox.ts:17

Cinema bars for a cut scene: two bars slide in from the top and bottom of the screen and back out. They live on the stage's screen layer, above what was there when they were made; a HUD added later draws over them, so hide it for the scene. Bar heights are whole screen pixels at every step of the slide.

Constructors

Constructor

new Letterbox(stage, options?): Letterbox;

Defined in: src/transitions/Letterbox.ts:25

Parameters

Parameter	Type
stage	Stage
options	LetterboxOptions

Returns

Letterbox

Properties

view

readonly view: Container<ContainerChild>;

Defined in: src/transitions/Letterbox.ts:18

Accessors

shown

Get Signature

get shown(): boolean;

Defined in: src/transitions/Letterbox.ts:38

Whether the bars are (partly) in.

Returns

boolean

Methods

destroy()

destroy(): void;

Defined in: src/transitions/Letterbox.ts:51

Returns

void

---

hide()

hide(ms?): Promise<void>;

Defined in: src/transitions/Letterbox.ts:47

Parameters

Parameter	Type	Default value
ms	number	400

Returns

Promise<void>

---

show()

show(ms?): Promise<void>;

Defined in: src/transitions/Letterbox.ts:43

Slides the bars in over ms (0: at once).

Parameters

Parameter	Type	Default value
ms	number	400

Returns

Promise<void>