Enum simconnect_sdk::SystemEventRequest

#[repr(u32)]
#[non_exhaustive]
pub enum SystemEventRequest {
    OneSecond,
    FourSeconds,
    SixTimesPerSecond,
    AircraftLoaded,
    Crashed,
    CrashReset,
    FlightLoaded,
    FlightSaved,
    FlightPlanActivated,
    FlightPlanDeactivated,
    Frame,
    Pause,
    Paused,
    PauseFrame,
    PositionChanged,
    Sim,
    SimStart,
    SimStop,
    Sound,
    Unpaused,
    View,
}

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

Request a notification every second.

FourSeconds

Request a notification every four seconds.

SixTimesPerSecond

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

AircraftLoaded

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

Crashed

Request a notification if the user aircraft crashes.

CrashReset

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

FlightLoaded

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

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

FlightPlanActivated

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

FlightPlanDeactivated

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

Frame

Request notifications every visual frame.

Pause

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

Paused

Request a notification when the scenario is paused.

PauseFrame

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

PositionChanged

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

Sim

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

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

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

Request a notification when the flight is un-paused.

View

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 copy of the value.

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<SystemEventRequest> for SystemEventRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

type Primitive = u32

const NAME: &'static str = _

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

impl Copy for SystemEventRequest

impl Eq for SystemEventRequest

impl StructuralEq for SystemEventRequest

impl StructuralPartialEq for SystemEventRequest