Enum Step 

pub enum Step<D = NoDirective> {
    Caption {
        text: String,
    },
    Place {
        side: Side,
        character: CharacterId,
        expression: String,
    },
    Clear {
        side: Side,
    },
    Say {
        speaker: CharacterId,
        expression: Option<String>,
        text: String,
        direction: Option<String>,
        line: LineId,
    },
    Narrate {
        text: String,
        direction: Option<String>,
        line: LineId,
    },
    Choice {
        options: Vec<ChoiceOption<D>>,
    },
    Music(MusicLine),
    Directive(D),
    If {
        character: CharacterId,
        then: Vec<Step<D>>,
        otherwise: Vec<Step<D>>,
    },
}

One step of a scene, in script order. D is the game’s own directives.

Variants

Caption

@caption <text>: a location/time caption, shown until the next one.

Fields

text: String

The caption.

Place

@left <id> <expression>: a character enters (or replaces whoever is) on side.

Fields

side: Side

Where.

character: CharacterId

Who.

expression: String

With which expression.

Clear

@left clear: the portrait on side leaves.

Fields

side: Side

Which side empties.

Say

id: text or id[expression]: text: an on-screen character speaks, first changing expression if one is given.

Fields

speaker: CharacterId

Who speaks.

expression: Option<String>

The speaker’s new expression, if it changes.

text: String

What they say.

direction: Option<String>

How it is said, for a voice or an actor; never shown, and not part of the line’s id.

line: LineId

The line’s id.

Narrate

> text: narration, no speaker.

Fields

text: String

The narration.

direction: Option<String>

How it is said, for a voice or an actor; never shown, and not part of the line’s id.

line: LineId

The line’s id.

Choice

@choice … @endchoice: the replies the player picks from, each with its own reaction steps. Every option rejoins the scene after the block.

Fields

options: Vec<ChoiceOption<D>>

The options, in menu order.

Music(MusicLine)

@music <cue> or @music stop: the music changes when playback reaches this line, and stays so after the scene.

Directive(D)

A directive of the game’s (Directive).

If

@if <character> … @else … @endif: steps that play only if the character is there when the scene plays (Present), and the steps that play instead if they aren’t.

Fields

character: CharacterId

Who must be there.

then: Vec<Step<D>>

The steps played if they are.

otherwise: Vec<Step<D>>

The steps played if they aren’t (none without an @else).

Implementations

impl<D> Step<D>

pub fn text(&self) -> Option<&str>

The text of a text step (one text box): a Say or Narrate.

pub fn has_text(&self) -> bool

Whether the step is, or has inside it, a speech or narration line.

Trait Implementations

impl<D: Clone> Clone for Step<D>

fn clone(&self) -> Step<D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: Debug> Debug for Step<D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, D> Deserialize<'de> for Step<D>

where D: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D: Eq> Eq for Step<D>

impl<D: PartialEq> PartialEq for Step<D>

fn eq(&self, other: &Step<D>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<D> Serialize for Step<D>

where D: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<D: PartialEq> StructuralPartialEq for Step<D>