CastMember#

Import

from scenet import CastMember

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.CastMember[source]#

Bases: Strict

One character present in the panel: a puppet Scenet poses, or a figure a picture draws.

The split between actor id and reference is what lets one puppet appear twice in a panel as two different people:

cast:
  guard_left:  {reference: bob, pose: arms_crossed}
  guard_right: {reference: bob, pose: standing_neutral, facing: left}

Example

>>> from scenet import CastMember, Facing
>>> member = CastMember(reference="alice", at="left_third", facing="left")
>>> member.facing is Facing.LEFT
True

See also

PanelIR, whose cast holds them. AnchorX and Facing, what it takes.

reference: str | None#

The puppet to draw: a shipped puppet’s name, or the path of a .puppet.yaml file, relative to the document. Written instead of figure.

pose: str#

A pose the puppet declares, by name.

expression: str#

An expression the puppet declares, by name.

marks: tuple[Mark, ...]#

Emanata drawn around the character – plewds, squeans, grawlixes, briffits – in any order, each once. They compose with the expression.

at: AnchorX#

Where along the panel’s width the figure would like to stand. A preference: non-overlap and left_of override it.

facing: Facing#

Which way the figure is turned, left or right, gaze and all.

figure: str | None#

A figure the panel’s picture draws, by the name its artwork contract gives it. Written instead of reference, and with none of the keys that pose or place a puppet.

property is_figure: bool#

Whether this member is a figure a picture draws, rather than a puppet.