Struct oxygengine_visual_novel::story::Story

pub struct Story { /* fields omitted */ }

Implementations

impl Story

pub fn initialize(&mut self)

pub fn register_scene(&mut self, scene: Scene)

pub fn unregister_scene(&mut self, name: &str) -> Option<Scene>

pub fn register_background(&mut self, background: Background)

pub fn unregister_background(&mut self, name: &str) -> Option<Background>

pub fn register_character(&mut self, character: Character)

pub fn unregister_character(&mut self, name: &str) -> Option<Character>

pub fn register_chapter(&mut self, chapter: Chapter)

pub fn unregister_chapter(&mut self, name: &str) -> Option<Chapter>

pub fn backgrounds(&self) -> impl Iterator<Item = (&str, &Background)>

pub fn background(&self, name: &str) -> Option<&Background>

pub fn scenes(&self) -> impl Iterator<Item = (&str, &Scene)>

pub fn scene(&self, name: &str) -> Option<&Scene>

pub fn characters(&self) -> impl Iterator<Item = (&str, &Character)>

pub fn character(&self, name: &str) -> Option<&Character>

pub fn character_mut(&mut self, name: &str) -> Option<&mut Character>

pub fn chapter(&self, name: &str) -> Option<&Chapter>

pub fn active_scene(&self) -> &ActiveScene

pub fn active_dialogue(&self) -> &ActiveDialogue

pub fn current_chapter(&self) -> Option<(&str, usize)>

pub fn is_paused(&self) -> bool

pub fn set_paused(&mut self, value: bool)

pub fn is_waiting_for_dialogue_option_selection(&self) -> bool

pub fn select_dialogue_option(&mut self, index: usize) -> Result<(), StoryError>

pub fn unselect_dialogue_option(&mut self)

pub fn go_to_scene(&mut self, name: &str) -> Result<(), StoryError>

pub fn end_scene(&mut self)

pub fn change_scene_background(&mut self, name: &str) -> Result<(), StoryError>

pub fn jump_to_label(&mut self, name: &str) -> Result<(), StoryError>

pub fn run_chapter(&mut self, name: &str) -> Result<(), StoryError>

pub fn in_progress(&self) -> bool

pub fn is_complete(&self) -> bool

pub fn debug_state(&self) -> StoryDebugState

pub fn process(&mut self, delta_time: Scalar) -> Result<(), StoryError>

Trait Implementations

impl Clone for Story

fn clone(&self) -> Story

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Story

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

Formats the value using the given formatter.

impl Default for Story

fn default() -> Story

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Story

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

Deserialize this value from the given Serde deserializer.

impl Prefab for Story

fn from_prefab(data: Value) -> Result<Self, PrefabError>

fn from_prefab_with_extras(
    data: Value,
    _named_entities: &HashMap<String, Entity, RandomState>,
    _state_token: ID<()>
) -> Result<Self, PrefabError>

fn to_prefab(&self) -> Result<Value, PrefabError>

fn from_prefab_str(data: &str) -> Result<Self, PrefabError>

fn to_prefab_string(&self) -> Result<String, PrefabError>

fn post_from_prefab(&mut self)

impl Serialize for Story

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

Serialize this value into the given Serde serializer.