Enum SystemEvent

#[non_exhaustive]
pub enum SystemEvent {
    OneSecond,
    FourSeconds,
    SixTimesPerSecond,
    AircraftLoaded {
        file_name: String,
    },
    Crashed,
    CrashReset,
    FlightLoaded {
        file_name: String,
    },
    FlightSaved {
        file_name: String,
    },
    FlightPlanActivated {
        file_name: String,
    },
    FlightPlanDeactivated,
    Frame {
        frame_rate: f32,
        sim_speed: f32,
    },
    Pause {
        state: bool,
    },
    Paused,
    PauseFrame {
        frame_rate: f32,
        sim_speed: f32,
    },
    PositionChanged,
    Sim {
        state: bool,
    },
    SimStart,
    SimStop,
    Sound {
        state: bool,
    },
    Unpaused,
    View {
        view: ViewType,
    },
}

SimConnect System Event Notification.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OneSecond

A notification every second.

FourSeconds

A notification every four seconds.

SixTimesPerSecond

A notification six times per second. This is the same rate that joystick movement events are transmitted.

AircraftLoaded

A notification when the aircraft flight dynamics file is changed. These files have a .AIR extension. The filename is returned.

Fields

file_name: String

The returned filename.

Crashed

A notification if the user aircraft crashes.

CrashReset

A notification when the crash cut-scene has completed.

FlightLoaded

A notification when a flight is loaded. Note that when a flight is ended, a default flight is typically loaded, so these events will occur when flights and missions are started and finished. The filename of the flight loaded is returned.

Fields

file_name: String

The returned filename.

FlightSaved

A notification when a flight is saved correctly. The filename of the flight saved is returned.

Fields

file_name: String

The returned filename.

FlightPlanActivated

A notification when a new flight plan is activated. The filename of the activated flight plan is returned.

Fields

file_name: String

The returned filename.

FlightPlanDeactivated

A notification when the active flight plan is de-activated.

Frame

Notifications every visual frame.

Fields

frame_rate: f32

The visual frame rate in frames per second.

sim_speed: f32

The simulation rate. For example if the simulation is running at four times normal speed – 4X – then 4.0 will be returned.

Pause

Notifications when the scenario is paused or unpaused, and also immediately returns the current pause state.

Fields

state: bool

The current pause state (true = paused or false = unpaused).

Paused

A notification when the scenario is paused.

PauseFrame

Notifications for every visual frame that the simulation is paused.

Fields

frame_rate: f32

The visual frame rate in frames per second.

sim_speed: f32

The simulation rate. For example if the simulation is running at four times normal speed – 4X – then 4.0 will be returned.

PositionChanged

A notification when the user changes the position of their aircraft through a dialog.

Sim

Notifications when the scenario is running or not, and also immediately returns the current state.

Fields

state: bool

The current state (true = running or false = not running).

SimStart

The simulator is running. Typically the user is actively controlling the vehicle which is on the ground, underwater or in the air.

SimStop

The simulator is not running. Typically the user is loading a scenario, navigating the user interface or in a dialog.

Sound

A notification when the master sound switch is changed. This request will also return the current state of the master sound switch immediately.

Fields

state: bool

The current state of the master sound switch. false if the switch is off, true if the switch is on.

Unpaused

A notification when the flight is un-paused.

View

A notification when the user aircraft view is changed. This request will also return the current view immediately.

Fields

view: ViewType

The current cockpit view type.

Trait Implementations

impl Clone for SystemEvent

fn clone(&self) -> SystemEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemEvent

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

Formats the value using the given formatter.

impl PartialEq for SystemEvent

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

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

const 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 StructuralPartialEq for SystemEvent