Struct Flags

pub struct Flags(/* private fields */);

The current flags for the player. These flags are mostly for things that are related to the player’s ship.

Implementations

impl Flags

pub fn docked(&self) -> bool

Whether the player is currently docked at a station.

pub fn landed(&self) -> bool

Whether the player is landed on a planetary surface.

pub fn landing_gear_down(&self) -> bool

Whether the landing gear is currently down.

pub fn shields_up(&self) -> bool

Whether the shields are up.

pub fn supercruise(&self) -> bool

Whether player is currently flying in supercruise.

pub fn flight_assist_off(&self) -> bool

Whether flight assist has been turned off.

pub fn hardpoints_deployed(&self) -> bool

Whether the hardpoints of the ship are currently deployed.

pub fn in_wing(&self) -> bool

Whether the player is in a wing.

pub fn lights_on(&self) -> bool

Whether the lights of the current active vehicle are on.

pub fn cargo_scoop_deployed(&self) -> bool

Whether the cargo scoop of the current active vehicle is deployed.

pub fn silent_running(&self) -> bool

Whether silent running is currently active.

pub fn scooping_fuel(&self) -> bool

Whether the player is currently fuel scooping.

pub fn srv_handbreak(&self) -> bool

Whether the SRV handbreak is currently on.

pub fn srv_turret_view(&self) -> bool

Whether the player is currently directly piloting the SRV turret.

pub fn srv_turret_retracted(&self) -> bool

Whether the turret of the SRV has been retracted. The turret is retracted when the player is close to their own ship.

pub fn srv_drive_assist(&self) -> bool

Whether the player has enabled drive assist in the SRV.

pub fn fsd_masslocked(&self) -> bool

Whether the FSD is currently masslocked. This prevents the player from charging the FSD.

pub fn fsd_charging(&self) -> bool

Whether the FSD is currently spinning up. This does not differentiate between charging to jump to supercruise or hyperspace.

pub fn fsd_cooldown(&self) -> bool

Whether the FSD is currently cooling down. This prevents the player from charging the FSD.

pub fn low_fuel(&self) -> bool

Whether the player’s current vehicle is low on fuel, which is when the total fuel reserves of the vehicle drop below 25%.

pub fn overheating(&self) -> bool

Whether the player’s current vehicle is overheating, which is when the heat level exceeds 100% heat.

pub fn has_lat_long(&self) -> bool

Whether the lat/long values are available in the status. Set when near a planet.

pub fn in_danger(&self) -> bool

Whether the player is counted as ‘in danger’. If this is true then the player has to wait 15 seconds before they can log out of the game.

pub fn being_interdicted(&self) -> bool

Whether the player is currently getting interdicted. This doesn’t differentiate between an attempt by an NPC or a player.

pub fn in_main_ship(&self) -> bool

Whether the player is currently piloting the main ship (aka the mother ship.)

pub fn in_fighter(&self) -> bool

Whether the player is currently piloting a fighter.

pub fn in_srv(&self) -> bool

Whether the player is currently piloting an SRV.

pub fn analysis_mode(&self) -> bool

Whether the current cockpit mode is currently set to analysis mode.

pub fn night_vision(&self) -> bool

Whether night vision is currently active.

pub fn altitude_from_average_radius(&self) -> bool

Is set when the average radius of the planet is used for the altitude instead of the altitude to the actual terrain and elevation of the planet’s surface.

pub fn fsd_jump(&self) -> bool

Whether the player is currently jumping through hyperspace.

pub fn srv_high_beam(&self) -> bool

Whether the SRV has the high beam lights active.

Trait Implementations

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Flags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Flags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Flags

fn eq(&self, other: &Flags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Flags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Flags

impl StructuralPartialEq for Flags