Skip to main content

StoryCommand

Enum StoryCommand 

Source
pub enum StoryCommand {
Show 13 variants Start, Continue, Advance, Choose(usize), ToggleAuto, ToggleSkip, ToggleLog, OpenSave, OpenLoad, Slot(usize), TogglePause, OpenSettings, CloseSettings,
}
Expand description

Runtime-only event sent by UiInputSystem when a story:* action fires (a stage click, a Space press, a choice button, a Start / Restart button). The story system reads these and moves through the story graph. World authors never declare this type directly.

Variants§

§

Start

Reset to the first node and show the stage.

§

Continue

Resume from the saved position, or start fresh when no save exists.

§

Advance

Advance the current page: complete a mid-reveal, else move on.

§

Choose(usize)

Pick the current choice menu’s option by index.

§

ToggleAuto

Toggle auto-advance (pages turn on their own once revealed).

§

ToggleSkip

Toggle fast-forward (instant reveal, rapid page turns; stops at menus).

§

ToggleLog

Toggle the dialogue-history overlay.

§

OpenSave

Open the slot overlay in save mode.

§

OpenLoad

Open the slot overlay in load mode.

§

Slot(usize)

Pick a slot in the open slot overlay.

§

TogglePause

Toggle the pause menu over the stage: show it from the stage (or close an open overlay first), and return to the stage when it is up.

§

OpenSettings

Open the settings screen, remembering the menu that opened it so it can be returned to.

§

CloseSettings

Close the settings screen, returning to whichever menu opened it.

Trait Implementations§

Source§

impl Clone for StoryCommand

Source§

fn clone(&self) -> StoryCommand

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 StoryCommand

Source§

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

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

impl Default for StoryCommand

Source§

fn default() -> StoryCommand

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

impl Eq for StoryCommand

Source§

impl PartialEq for StoryCommand

Source§

fn eq(&self, other: &StoryCommand) -> bool

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StoryCommand

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.