space_traders_api/models/
system_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/// SystemWaypoint : Waypoint details.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct SystemWaypoint {
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    /// Relative position of the waypoint on the system's x axis. This is not an absolute position in the universe.
23    #[serde(rename = "x")]
24    pub x: i32,
25    /// Relative position of the waypoint on the system's y axis. This is not an absolute position in the universe.
26    #[serde(rename = "y")]
27    pub y: i32,
28    /// Waypoints that orbit this waypoint.
29    #[serde(rename = "orbitals")]
30    pub orbitals: Vec<models::WaypointOrbital>,
31    /// The symbol of the parent waypoint, if this waypoint is in orbit around another waypoint. Otherwise this value is undefined.
32    #[serde(rename = "orbits", skip_serializing_if = "Option::is_none")]
33    pub orbits: Option<String>,
34}
35
36impl SystemWaypoint {
37    /// Waypoint details.
38    pub fn new(symbol: String, r#type: models::WaypointType, x: i32, y: i32, orbitals: Vec<models::WaypointOrbital>) -> SystemWaypoint {
39        SystemWaypoint {
40            symbol,
41            r#type,
42            x,
43            y,
44            orbitals,
45            orbits: None,
46        }
47    }
48}
49