CaptionEvent#
Import |
|
Defined in |
|
Install |
|
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:
StrictOne 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.tailis required – a fifth kind would mean inventing a speaker and leaving a field dead.byis 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.CaptionKindandCaptionTone, what it takes.- 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:
localefor a place and time,monologuefor an inner voice,spokenfor speech from off panel,editorialfor the writer’s voice.
- tone: CaptionTone#
What the box is filled with:
paper,pale,ink, which is lettered in paper, orwarm, yellow underpalette: 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, ortop_rightread right to left.