CaptionEvent#

Import

from scenet import CaptionEvent

Defined in

scenet.ir (source)

Install

pip install scenet

Since

0.4

Stability

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

class scenet.ir.CaptionEvent[source]#

Bases: Strict

One caption box: the panel speaking in its own voice.

A caption is what lets a panel say where and when it happens without a character having to explain it out loud. MIDNIGHT. THE DOCKS. in the corner does the work of an establishing shot with no artwork at all, which is how comics established place long before they had reliable backgrounds.

A caption is not a fifth balloon kind. It has no speaker to point at and no tail, and CoreBalloon.tail is required – a fifth kind would mean inventing a speaker and leaving a field dead.

by is the one place where the rule that every actor id resolves does not hold, and deliberately: an off-panel speaker is not in the panel, so requiring them to be in the cast would defeat the point of saying they are off panel.

Example

>>> from scenet import CaptionEvent
>>> CaptionEvent(text="Midnight. The docks.").kind.value
'locale'

See also

SayEvent, words a character says. CaptionKind and CaptionTone, what it takes.

verb: Literal['caption']#

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

text: str#

What the box says, as one string; line breaks are computed. A word between underscores, _word_, is stressed.

kind: CaptionKind#

What the box is doing: locale for a place and time, monologue for an inner voice, spoken for speech from off panel, editorial for the writer’s voice.

tone: CaptionTone#

What the box is filled with: paper, pale, ink, which is lettered in paper, or warm, yellow under palette: tinted.

prefer: PlacementZone | None#

Where the box would like to sit, one of nine zones of the panel. Left out, where reading starts: top_left, or top_right read right to left.

by: str | None#

Who is speaking, for a spoken caption only: any name, in the cast or not.