nightshade 0.13.0

A cross-platform data-oriented game engine.
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

//! The immutable authored content.
//!
//! Everything the engine interprets lives here. The engine holds a shared
//! reference to a `World` for the lifetime of a run and only ever mutates a
//! `RuntimeState`.

use crate::interactive_fiction::data::condition::Condition;
use crate::interactive_fiction::data::dialogue::Dialogue;
use crate::interactive_fiction::data::ending::Ending;
use crate::interactive_fiction::data::entity::Entity;
use crate::interactive_fiction::data::ids::{
    ConditionId, DialogueId, EndingId, EntityId, ItemId, QuestId, RoomId, RuleId, TextId, TimerId,
};
use crate::interactive_fiction::data::item::Item;
use crate::interactive_fiction::data::quest::Quest;
use crate::interactive_fiction::data::room::Room;
use crate::interactive_fiction::data::rule::Rule;
use crate::interactive_fiction::data::text::Text;
use crate::interactive_fiction::data::timer::Timer;
use crate::interactive_fiction::data::verb_responses::VerbResponses;
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

/// The authored world.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct World {
    /// Human-readable title, shown in the window title and opening banner.
    pub title: String,
    /// Opening text shown before the first room.
    pub intro: Text,
    /// Where the player starts.
    pub start_room: RoomId,

    pub rooms: BTreeMap<RoomId, Room>,
    pub items: BTreeMap<ItemId, Item>,
    /// Characters and objects. Use `Entity::character` or
    /// `Entity::object` to build; the `kind` field decides menu
    /// framing and whether a disposition is tracked.
    pub entities: BTreeMap<EntityId, Entity>,
    pub dialogues: BTreeMap<DialogueId, Dialogue>,
    pub quests: BTreeMap<QuestId, Quest>,
    pub endings: BTreeMap<EndingId, Ending>,
    pub rules: BTreeMap<RuleId, Rule>,
    pub timers: BTreeMap<TimerId, Timer>,

    /// Shared text table; `Text::Ref(id)` resolves here.
    pub texts: BTreeMap<TextId, Text>,
    /// Shared condition table; `Condition::Ref(id)` resolves here.
    pub conditions: BTreeMap<ConditionId, Condition>,

    /// Every baked string the engine emits on its own (take/drop/wait
    /// responses, room headers, choice-menu labels, the rule-tracing
    /// prefix). Defaults are English; override any field to change or
    /// translate what the engine prints.
    #[serde(default)]
    pub verb_responses: VerbResponses,
}