inkling 0.12.5

Limited implementation of the Ink markup language.
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

//! Structures representing lines of `Ink` story content.
//!
//! There are two basic types of line content in a story: lines that will be processed
//! as the story is followed and choices which represent branching points that the user
//! has to select from.
//!
//! All line content is contained in the [`InternalLine`][crate::line::InternalLine]
//! structure. This represents a single line from an `Ink` story file. It is split
//! into smaller [`LineChunk`][crate::line::LineChunk] objects, each of which will
//! be processed in turn when the line is encountered. They can be nested with alternatives,
//! conditionals and diverts which will be selected from at runtime. A line
//! may contain internal parts which are only followed during certain conditions,
//! while the rest of the line may be unaffected or always present.
//!
//! Choices are represented by the [`InternalChoice`][crate::line::InternalChoice] object.
//! This contains different variants of text to be shown to the user and once a choice
//! is made and can have conditions for when they are presented at all.

mod alternative;
mod choice;
pub(crate) mod condition;
pub mod expression;
pub(crate) mod line;
pub(crate) mod parse;
mod variable;

pub(crate) use alternative::{Alternative, AlternativeBuilder, AlternativeKind};
pub(crate) use choice::{InternalChoice, InternalChoiceBuilder};
pub(crate) use condition::{
    Condition, ConditionBuilder, ConditionItem, ConditionKind, StoryCondition,
};
pub(crate) use expression::{evaluate_expression, Expression};
#[cfg(test)]
pub(crate) use line::builders::LineChunkBuilder;
pub(crate) use line::{Content, InternalLine, LineChunk};
pub(crate) use parse::{parse_line, parse_variable, ParsedLineKind};
pub use variable::Variable;