Skip to main content

StoryNode

Struct StoryNode 

Source
pub struct StoryNode {
    pub slug: String,
    pub pages: Vec<StoryPage>,
    pub choices: Vec<StoryChoice>,
    pub choice_stage: StoryStage,
    pub choice_music: Option<AudioClipHandle>,
    pub choice_sounds: Vec<AudioClipHandle>,
    pub choice_ops: Vec<StoryOp>,
    pub choice_gates: Vec<StoryGate>,
}
Expand description

One jump target in a Story: a run of pages optionally ending in a choice menu.

Fields§

§slug: String

The heading slug this node was compiled from (diagnostics only).

§pages: Vec<StoryPage>

The click-through pages, in order.

§choices: Vec<StoryChoice>

The choice menu shown after the last page. Empty = no menu.

§choice_stage: StoryStage

Stage dressing current at the choice menu.

§choice_music: Option<AudioClipHandle>

Music current at the choice menu (AudioClip reference).

§choice_sounds: Vec<AudioClipHandle>

One-shots played when the choice menu shows.

§choice_ops: Vec<StoryOp>

Flag operations run when the choice menu shows.

§choice_gates: Vec<StoryGate>

Conditional jumps evaluated before the choice menu shows.

Trait Implementations§

Source§

impl Clone for StoryNode

Source§

fn clone(&self) -> StoryNode

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 Debug for StoryNode

Source§

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

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

impl Default for StoryNode

Source§

fn default() -> StoryNode

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

impl<'de> Deserialize<'de> for StoryNode

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 Serialize for StoryNode

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

Auto Trait Implementations§

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> 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 = !

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.