Skip to main content

Scene

Struct Scene 

Source
pub struct Scene<D = NoDirective> {
    pub id: String,
    pub steps: Vec<Step<D>>,
}
Expand description

One scene: @scene <id> … @end.

Fields§

§id: String

Scene id, unique across every dialogue file.

§steps: Vec<Step<D>>

Its steps, in order.

Implementations§

Source§

impl<D> Scene<D>

Source

pub fn lines(&self) -> Vec<Line<'_>>

Every line that shows text (speech, narration, replies and the lines of their reactions), in script order, whoever is there: both parts of every @if block.

Source

pub fn assign_line_ids(&mut self)

Gives every line of the scene its id, from the scene id, the speakers and the texts as they are now. The parser calls this on each scene it reads; call it after building or editing a scene by hand.

Source§

impl<D: Clone> Scene<D>

Source

pub fn resolved(&self, present: &Present) -> Scene<D>

The scene as it plays for those present: every @if block replaced by the steps of the part that holds, in reactions and in other blocks too. The lines keep their ids.

Source§

impl<D> Scene<D>

Source

pub fn has_text(&self) -> bool

Whether the scene has a speech or narration line to play, whichever reply is picked. Run on a Scene::resolved scene: one with nothing left to say for those present isn’t played.

Trait Implementations§

Source§

impl<D: Clone> Clone for Scene<D>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<D: Debug> Debug for Scene<D>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<D> Default for Scene<D>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, D> Deserialize<'de> for Scene<D>
where D: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<D: Eq> Eq for Scene<D>

Source§

impl<D: PartialEq> PartialEq for Scene<D>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<D> Serialize for Scene<D>
where D: Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Auto Trait Implementations§

§

impl<D> Freeze for Scene<D>

§

impl<D> RefUnwindSafe for Scene<D>
where D: RefUnwindSafe,

§

impl<D> Send for Scene<D>
where D: Send,

§

impl<D> Sync for Scene<D>
where D: Sync,

§

impl<D> Unpin for Scene<D>
where D: Unpin,

§

impl<D> UnsafeUnpin for Scene<D>

§

impl<D> UnwindSafe for Scene<D>
where D: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.