SayEvent#

Import

from scenet import SayEvent

Defined in

scenet.ir (source)

Install

pip install scenet

Since

0.1

Stability

Public: follows semantic versioning. Below 1.0, a minor release may change it, and the CHANGELOG says how.

class scenet.ir.SayEvent[source]#

Bases: Strict

One line of dialogue.

Script order is reading order, and reading order is a hard constraint. Reorder these and you reorder the panel.

Example

>>> from scenet import BalloonKind, SayEvent
>>> line = SayEvent(by="alice", text="Psst.", kind="whisper")
>>> line.kind is BalloonKind.WHISPER
True

See also

CaptionEvent, words no character says. SfxEvent, a sound.

verb: Literal['say']#

Always say: the key the entry is written under in a script.

by: str#

Who speaks: an actor id in the cast, whose mouth the tail points at. With off_panel, the name of somebody nobody draws.

text: str#

The line, as one string; the compiler breaks it into lines. A word between underscores, _word_, is stressed, and lettered in bold italic.

prefer: PlacementZone | None#

Where the balloon would like to sit, one of nine zones of the panel. The weakest placement term: face avoidance and reading order override it.

kind: BalloonKind#

The balloon the line is carried in: speech, thought, whisper or shout.

off_panel: bool | Side#

The speaker is outside the panel: true, or the side of the frame they are on. The tail ends on the frame there.

size: TypeSize#

small for a line muttered, said under the breath or weakly: smaller type, in a balloon that keeps its room.