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

//! Contains every possible game event. Events can trigger animations,
//! textboxes, warps and much more.

pub mod bgm_change_event;
pub mod chained_events;
pub mod character_move_event;
pub mod character_rotate_event;
pub mod character_single_move_event;
pub mod cyclic_event;
pub mod event_executor;
pub mod event_queue;
pub mod fade_in_event;
pub mod fade_out_event;
pub mod map_change_event;
pub mod map_interaction_event;
pub mod parallel_events;
pub mod repeated_event;
pub mod script_event;
pub mod switch_map_event;
pub mod text_event;
pub mod warp_event;

use amethyst::ecs::World;

pub use self::{
    bgm_change_event::BgmChangeEvent,
    chained_events::ChainedEvents,
    character_move_event::CharacterMoveEvent,
    character_rotate_event::CharacterRotateEvent,
    character_single_move_event::CharacterSingleMoveEvent,
    cyclic_event::CyclicEvent,
    event_executor::EventExecutor,
    event_queue::EventQueue,
    fade_out_event::FadeOutEvent,
    fade_in_event::FadeInEvent,
    map_change_event::MapChangeEvent,
    map_interaction_event::MapInteractionEvent,
    parallel_events::ParallelEvents,
    repeated_event::RepeatedEvent,
    script_event::ScriptEvent,
    switch_map_event::SwitchMapEvent,
    text_event::TextEvent,
    warp_event::WarpEvent,
};

/// Represents the conditions that a `GameEvent` must fulfill in order to be
/// executed.
#[derive(Default)]
pub struct ExecutionConditions {
    /// Determines whether the event needs the inputs to be disabled in order
    /// to execute.
    pub requires_disabled_input: bool,
}

impl ExecutionConditions {
    fn merge_with(&self, other: &ExecutionConditions) -> ExecutionConditions {
        ExecutionConditions {
            requires_disabled_input: self.requires_disabled_input || other.requires_disabled_input,
        }
    }
}

/// A box containing a generic `GameEvent` that is guaranteed to be `Sync` and
/// `Send`.
pub type BoxedGameEvent = Box<dyn GameEvent + Sync + Send>;

/// A trait representing a game event.
pub trait GameEvent {
    /// Returns an arbitrary `GameEvent` inside a `Box`. This is basically a
    /// trait object-safe version of `Clone` used specifically for game events.
    fn boxed_clone(&self) -> BoxedGameEvent;
    /// Returns the execution conditions of this event.
    fn get_execution_conditions(&self) -> ExecutionConditions;
    /// Starts this event, assuming that its execution conditions hold.
    fn start(&mut self, world: &mut World);
    /// Ticks this event, making it potentially get closer to completion.
    fn tick(&mut self, world: &mut World, disabled_inputs: bool);
    /// Checks if this event has been completed.
    fn is_complete(&self, world: &mut World) -> bool;
}