SfxEvent#

Import

from scenet import SfxEvent

Defined in

scenet.ir (source)

Install

pip install scenet

Since

0.11

Stability

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

class scenet.ir.SfxEvent[source]#

Bases: Strict

A sound effect: letters that are part of the picture.

BLAM is not dialogue. Comics letter sound as art – big, angled, outlined, near where the sound is – in a display face, not in the balloon face, and with no balloon.

Placed by candidates and cost, never at a coordinate. It never covers a face, and balloons pay to cover it, as they pay to cover emanata. It takes its number in the script’s one reading order, which is what a reader of the text follows, but it is exempt from the geometric reading-order rule: a sound sits where the sound is.

Example

>>> from scenet import SfxEvent
>>> SfxEvent.model_validate({"text": "BLAM", "from": "bob"}).source
'bob'

See also

SfxSize, how large it is.

verb: Literal['sfx']#

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

text: str#

The sound, lettered exactly as written, in the display face.

source: str | None#

Written from: the actor id the sound comes from, which it is placed near.

prefer: PlacementZone | None#

Where the effect would like to sit, one of nine zones of the panel: on its own, or as a pull on an effect that has a from.

size: SfxSize#

How loud: small, medium or large, lettered at 1.6, 2.6 or 4 times the dialogue type size.

rotate: float#

How far the effect is turned clockwise, in degrees, from -45 to 45.

arc: float#

How far the line of letters bends, in degrees, from -120 to 120: positive bows its middle up, negative down.

hollow: bool#

true letters the effect as an outline with no fill, so the art shows through: an open effect.