space_traders_api/models/
waypoint.rs

1/*
2 * SpaceTraders API
3 *
4 * SpaceTraders is an open-universe game and learning platform that offers a set of HTTP endpoints to control a fleet of ships and explore a multiplayer universe.  The API is documented using [OpenAPI](https://github.com/SpaceTradersAPI/api-docs). You can send your first request right here in your browser to check the status of the game server.  ```json http {   \"method\": \"GET\",   \"url\": \"https://api.spacetraders.io/v2\", } ```  Unlike a traditional game, SpaceTraders does not have a first-party client or app to play the game. Instead, you can use the API to build your own client, write a script to automate your ships, or try an app built by the community.  We have a [Discord channel](https://discord.com/invite/jh6zurdWk5) where you can share your projects, ask questions, and get help from other players.   
5 *
6 * The version of the OpenAPI document: 2.3.0
7 * Contact: joel@spacetraders.io
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// Waypoint : A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct Waypoint {
17    /// The symbol of the waypoint.
18    #[serde(rename = "symbol")]
19    pub symbol: String,
20    #[serde(rename = "type")]
21    pub r#type: models::WaypointType,
22    /// The symbol of the system.
23    #[serde(rename = "systemSymbol")]
24    pub system_symbol: String,
25    /// Relative position of the waypoint on the system's x axis. This is not an absolute position in the universe.
26    #[serde(rename = "x")]
27    pub x: i32,
28    /// Relative position of the waypoint on the system's y axis. This is not an absolute position in the universe.
29    #[serde(rename = "y")]
30    pub y: i32,
31    /// Waypoints that orbit this waypoint.
32    #[serde(rename = "orbitals")]
33    pub orbitals: Vec<models::WaypointOrbital>,
34    /// The symbol of the parent waypoint, if this waypoint is in orbit around another waypoint. Otherwise this value is undefined.
35    #[serde(rename = "orbits", skip_serializing_if = "Option::is_none")]
36    pub orbits: Option<String>,
37    #[serde(rename = "faction", skip_serializing_if = "Option::is_none")]
38    pub faction: Option<Box<models::WaypointFaction>>,
39    /// The traits of the waypoint.
40    #[serde(rename = "traits")]
41    pub traits: Vec<models::WaypointTrait>,
42    /// The modifiers of the waypoint.
43    #[serde(rename = "modifiers", skip_serializing_if = "Option::is_none")]
44    pub modifiers: Option<Vec<models::WaypointModifier>>,
45    #[serde(rename = "chart", skip_serializing_if = "Option::is_none")]
46    pub chart: Option<Box<models::Chart>>,
47    /// True if the waypoint is under construction.
48    #[serde(rename = "isUnderConstruction")]
49    pub is_under_construction: bool,
50}
51
52impl Waypoint {
53    /// A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.
54    pub fn new(symbol: String, r#type: models::WaypointType, system_symbol: String, x: i32, y: i32, orbitals: Vec<models::WaypointOrbital>, traits: Vec<models::WaypointTrait>, is_under_construction: bool) -> Waypoint {
55        Waypoint {
56            symbol,
57            r#type,
58            system_symbol,
59            x,
60            y,
61            orbitals,
62            orbits: None,
63            faction: None,
64            traits,
65            modifiers: None,
66            chart: None,
67            is_under_construction,
68        }
69    }
70}
71
space_traders_api/models/waypoint.rs

space_traders_api/models/
waypoint.rs
