bladeink 1.2.5

This is a Rust port of inkle's ink, a scripting language for writing interactive narrative.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! A generated [`Choice`] from the story.
use core::fmt;
use std::cell::RefCell;

use crate::{
    callstack::Thread,
    object::{Object, RTObject},
    path::Path,
};

/// Represents a choice generated by a [`Story`](crate::story::Story).
#[derive(Clone)]
pub struct Choice {
    obj: Object,
    thread_at_generation: RefCell<Option<Thread>>,
    pub(crate) original_thread_index: RefCell<usize>,
    /// Get the path to the original choice point - where was this choice defined in the story?
    pub(crate) source_path: String,
    pub(crate) target_path: Path,
    pub(crate) is_invisible_default: bool,
    /// Ink tags attached to this `Choice`.
    pub tags: Vec<String>,
    /// The original index into `currentChoices` list on the [`Story`](crate::story::Story) when
    /// this `Choice` was generated, for convenience.
    pub index: RefCell<usize>,
    /// The main text to present to the player for this `Choice`.
    pub text: String,
}

impl Choice {
    pub(crate) fn new(
        target_path: Path,
        source_path: String,
        is_invisible_default: bool,
        tags: Vec<String>,
        thread_at_generation: Thread,
        text: String,
    ) -> Choice {
        Self {
            obj: Object::new(),
            target_path,
            is_invisible_default,
            tags,
            index: RefCell::new(0),
            original_thread_index: RefCell::new(0),
            text,
            thread_at_generation: RefCell::new(Some(thread_at_generation)),
            source_path,
        }
    }

    pub(crate) fn new_from_json(
        path_string_on_choice: &str,
        source_path: String,
        text: &str,
        index: usize,
        original_thread_index: usize,
        choice_tags: Vec<String>,
    ) -> Choice {
        Choice {
            obj: Object::new(),
            target_path: Path::new_with_components_string(Some(path_string_on_choice)),
            is_invisible_default: false,
            tags: choice_tags,
            index: RefCell::new(index),
            original_thread_index: RefCell::new(original_thread_index),
            text: text.to_string(),
            thread_at_generation: RefCell::new(None),
            source_path,
        }
    }

    pub(crate) fn set_thread_at_generation(&self, thread: Thread) {
        self.thread_at_generation.replace(Some(thread));
    }

    pub(crate) fn get_thread_at_generation(&self) -> Option<Thread> {
        self.thread_at_generation
            .borrow()
            .as_ref()
            .map(|t| t.clone())
    }
}

impl RTObject for Choice {
    fn get_object(&self) -> &Object {
        &self.obj
    }
}

impl fmt::Display for Choice {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "**Choice**")
    }
}