gear-objects 0.3.0

Rust component object model
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

//! Traits for components added to the world. These are the interfaces that the world
//! uses to interact with components and how components interact with each other.
use super::*;
use colored::ColoredString;

pub struct Context<'a, 'b> {
    pub world: &'a mut World,
    pub store: &'b Store,
    pub loc: Point,
    pub id: ComponentId,
}

#[derive(Clone, Copy, Eq, PartialEq)]
pub enum LifeCycle {
    Alive,
    Dead,
}

// ---------------------------------------------------------------------------------------
/// Every component should include this though it can be a no-op.
pub trait Action {
    fn act<'a, 'b>(&mut self, context: Context<'a, 'b>) -> LifeCycle;
}
register_type!(Action);

// ---------------------------------------------------------------------------------------
/// Every component should include this.
pub trait Render {
    fn render(&self) -> ColoredString;
}
register_type!(Render);

// ---------------------------------------------------------------------------------------
/// Helper interface for something that gets hungry.
pub trait Hunger {
    fn get(&self) -> i32;
    fn set(&mut self, value: i32);
    fn adjust(&mut self, delta: i32);
}
register_type!(Hunger);

// ---------------------------------------------------------------------------------------
/// Helper interface for something that can move around, e.g. rabbits and wolves.
pub trait Moveable {
    fn random_move<'a, 'b>(&self, context: &Context<'a, 'b>) -> Option<Point>;
    fn move_towards(&self, world: &World, store: &Store, loc: Point, dst: Point) -> Option<Point>;
}
register_type!(Moveable);

// ---------------------------------------------------------------------------------------
/// Something rabbits can eat.
pub trait Fodder {
    /// Percent is how much of the fodder rabbits eat at a time.
    fn eat<'a, 'b>(&mut self, context: Context<'a, 'b>, percent: i32);

    /// Amount of fodder. Should only be used for comparisons (shorter or taller).
    fn height(&self) -> u8;
}
register_type!(Fodder);

// ---------------------------------------------------------------------------------------
/// Something predators can eat.
pub trait Prey {}
register_type!(Prey);

// ---------------------------------------------------------------------------------------
/// Something that eats prey.
pub trait Predator {}
register_type!(Predator);

// ---------------------------------------------------------------------------------------
/// Used to identify rabbits and wolves.
pub trait Animal {}
register_type!(Animal);