Enum SystemEventRequest

#[non_exhaustive]
#[repr(u32)]
pub enum SystemEventRequest {
    OneSecond = 0,
    FourSeconds = 1,
    SixTimesPerSecond = 2,
    AircraftLoaded = 3,
    Crashed = 4,
    CrashReset = 5,
    FlightLoaded = 6,
    FlightSaved = 7,
    FlightPlanActivated = 8,
    FlightPlanDeactivated = 9,
    Frame = 10,
    Pause = 11,
    Paused = 12,
    PauseFrame = 13,
    PositionChanged = 14,
    Sim = 15,
    SimStart = 16,
    SimStop = 17,
    Sound = 18,
    Unpaused = 19,
    View = 20,
}

SimConnect System Event Request.

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 = 0

Request a notification every second.

FourSeconds = 1

Request a notification every four seconds.

SixTimesPerSecond = 2

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

AircraftLoaded = 3

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

Crashed = 4

Request a notification if the user aircraft crashes.

CrashReset = 5

Request a notification when the crash cut-scene has completed.

FlightLoaded = 6

Request 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.

FlightSaved = 7

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

FlightPlanActivated = 8

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

FlightPlanDeactivated = 9

Request a notification when the active flight plan is de-activated.

Frame = 10

Request notifications every visual frame.

Pause = 11

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

Paused = 12

Request a notification when the scenario is paused.

PauseFrame = 13

Request notifications for every visual frame that the simulation is paused.

PositionChanged = 14

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

Sim = 15

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

SimStart = 16

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

SimStop = 17

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

Sound = 18

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

Unpaused = 19

Request a notification when the flight is un-paused.

View = 20

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

Trait Implementations

impl Clone for SystemEventRequest

fn clone(&self) -> SystemEventRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemEventRequest

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

Formats the value using the given formatter.

impl PartialEq for SystemEventRequest

fn eq(&self, other: &SystemEventRequest) -> 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 TryFrom<u32> for SystemEventRequest

type Error = TryFromPrimitiveError<SystemEventRequest>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for SystemEventRequest

const NAME: &'static str = "SystemEventRequest"

type Primitive = u32

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for SystemEventRequest

impl Eq for SystemEventRequest

impl StructuralPartialEq for SystemEventRequest