epicinium_lib 1.1.0

Rust bindings for libepicinium, the game logic library of the strategy game Epicinium.
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

/*
 * Part of epicinium_lib
 * developed by A Bunch of Hacks.
 *
 * Copyright (c) 2018-2020 A Bunch of Hacks
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * [authors:]
 * Sander in 't Veld (sander@abunchofhacks.coop)
 */

use crate::logic::ai;
use crate::logic::map;
use crate::logic::player::PlayerColor;

use serde_derive::{Deserialize, Serialize};

// These are only the fields that libepicinium is interested in.
#[derive(Debug, Clone, Serialize)]
pub struct Metadata
{
	#[serde(rename = "map")]
	pub map_name: String,

	#[serde(rename = "online")]
	pub is_online: bool,

	#[serde(rename = "planningtime")]
	pub planning_time_in_seconds_or_zero: u32,

	pub players: Vec<PlayerMetadata>,
	pub watchers: Vec<WatcherMetadata>,
	pub bots: Vec<BotMetadata>,

	#[serde(flatten)]
	pub map_metadata: map::Metadata,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PlayerMetadata
{
	#[serde(rename = "player")]
	pub color: PlayerColor,

	pub username: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WatcherMetadata
{
	pub username: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BotMetadata
{
	#[serde(rename = "player")]
	pub color: PlayerColor,

	#[serde(flatten)]
	pub ai_metadata: ai::Metadata,
}