Struct DialoguePlayer 

pub struct DialoguePlayer<H: DialogueHooks> { /* private fields */ }

Plays a scene: each advance moves to the next text box (speech or narration), applying the portrait and caption steps in between. At a reply choice it waits for choose, plays that reply’s reaction, then rejoins the scene after the choice. The @music lines passed on the way are kept for take_music. It plays the scene as it is for those present when it starts: the lines of an @if block whose character isn’t there are no part of it, read or skipped. The game’s own lines play on its stage as the scene reaches them (DialogueHooks::direct). Pure: no drawing, no clock, no sound. Cheap to clone (the scene is shared), so a copy can be kept as the scene was at a line (a dialogue log).

Implementations

impl<H: DialogueHooks> DialoguePlayer<H>

pub fn new(scene: &Scene<H::Directive>, hooks: H, present: &Present) -> Self

Starts scene as it plays for those present, at its first text box, with hooks filling its text and playing the game’s lines. A scene with nothing to say for them is finished at once.

pub fn hooks(&self) -> &H

What fills the text and plays the game’s lines.

pub fn stage(&self) -> &H::Stage

What the game’s lines have set so far.

pub fn stage_mut(&mut self) -> &mut H::Stage

What the game’s lines have set so far, for the game to take what it has played from it.

pub fn scene_id(&self) -> &str

The id of the scene being played.

pub fn scene(&self) -> &Scene<H::Directive>

The scene being played: the one it was started with, as it is for those present.

pub fn current(&self) -> View<'_, H::Stage>

What to show now.

pub fn line(&self) -> Option<&LineId>

The id of the line in the text box (while a choice is open, of the line being answered); None once the scene is finished.

pub fn reply_line(&self, option: usize) -> Option<&LineId>

The id of reply option of the open choice, if a choice is open and has it.

pub fn pending_music(&self) -> Option<&MusicLine>

The music the scene has asked for and take_music hasn’t taken yet, without taking it.

pub fn advance(&mut self)

Moves to the next text box, applying every portrait, caption and place step before it. After the last one the scene is finished; advancing a finished scene does nothing. While a choice is open this does nothing either: choose a reply.

pub fn choose(&mut self, option: usize)

Picks reply option of the open choice: plays its reaction, then the scene after the choice. Does nothing if no choice is open or there is no such option.

pub fn skip_to_choice(&mut self)

Advances until a choice is open or the scene is over (skipping a scene stops at each choice).

pub fn take_music(&mut self) -> Option<MusicLine>

The music the scene has asked for since the last call: the last @music line reached, whether the lines before it were read or skipped. None if no @music line was reached since.

pub fn is_choosing(&self) -> bool

Whether a reply choice is waiting for choose.

pub fn is_finished(&self) -> bool

Whether every text box has been shown and advanced past.

Trait Implementations

impl<H: Clone + DialogueHooks> Clone for DialoguePlayer<H>

where H::Directive: Clone, H::Stage: Clone,

fn clone(&self) -> DialoguePlayer<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H: Debug + DialogueHooks> Debug for DialoguePlayer<H>

where H::Directive: Debug, H::Stage: Debug,

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

Formats the value using the given formatter.

impl<H: Eq + DialogueHooks> Eq for DialoguePlayer<H>

where H::Directive: Eq, H::Stage: Eq,

impl<H: PartialEq + DialogueHooks> PartialEq for DialoguePlayer<H>

where H::Directive: PartialEq, H::Stage: PartialEq,

fn eq(&self, other: &DialoguePlayer<H>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<H: PartialEq + DialogueHooks> StructuralPartialEq for DialoguePlayer<H>

where H::Directive: PartialEq, H::Stage: PartialEq,