RELEASE NOTES, SDK release 0.9.3

 

Documentation Changes

IMPORTANT! The SDK documentation has had a major overhaul since Microsoft Flight Simulator 2020, and as such, some sections have been moved around, merged, or even removed. The search system and index should help you find what you need. 

Developer Mode

Added:
Improved
  • The SDK Contents page has been updated to reflect changes to the SDK install (Shared Assets, ModelBehaviourDefs, etc...)
  • The page documenting the Virtual File System has been updated, and a new section describing the VFS Projector has been added.
  • The page documenting The Aircraft Capture Tool has been updated to reflect changes in the tool and workflow.

 

 

SDK Tools

Fixed:
  • Updated SDK Tools page to accurately reflect the current tools available
Added:
Improved:
  • The The 3DS Max Plugin documentation has been updated to bring it in line with MSFS 2024 standards (ongoing WIP).

 

 

Model And Textures

Improved:

 

 

Content Configuration

Added:
Improved:

 

 

Programming APIs

Added:
  • The WebAssembly documentation has been updated with information on the new Vars API and Event API, which replace the Gauge API. The Gauge API is now considered a legacy API which should no longer be used.
  • The SimVar page for Aircraft Electrics Variables has been updated to show obsolete SimVars, and two new SimVars: ELECTRICAL BUS AMPS, ELECTRICAL BUS VOLTAGE.

  • The Skydiving Key Event documentation has been updated with the following additions:

    SKYDIVE_DOORLIGHTS_DEC
    SKYDIVE_DOORLIGHTS_GETREADY
    SKYDIVE_DOORLIGHTS_INC
    SKYDIVE_DOORLIGHTS_JUMP
    SKYDIVE_DOORLIGHTS_OFF

  • The Liquid Dropping System Key Event documentation has been updated with the following additions:

    SPRAY_ON
    SPRAY_TOGGLE
    SPRAY_SET

  • The General Engine Key Event docs have the following new events documented:

    AXIS_THRUST_VECTOR_HORIZONTAL_SET
    AXIS_THRUST_VECTOR_VERTICAL_SET
    THRUST_VECTOR_HORIZONTAL_DECREASE
    THRUST_VECTOR_HORIZONTAL_INCREASE
    THRUST_VECTOR_VERTICAL_DECREASE
    THRUST_VECTOR_VERTICAL_INCREASE

 

 

Previous SDK Release Notes

Below you can find a list of the list notes for previous releases of this SDK. Simply double click the release notes you want to explore to open them:

 

SDK RELEASE 0.9.0 (MSFS2024 initial ALPHA release)SDK RELEASE 0.9.0 (MSFS2024 initial ALPHA release)

 DOCUMENTATION

General

  • The structure of the SDK documentation has been improved to enable finding the information you require faster and easier, including improved search, an improved index, and related topics links on all pages.
  • Dark/Light mode has been added to the documentation to improve accessibility.
  • SDK Tools have been moved into their own unique section in the Table Of Contents and all relevant information consolidated under that section.
  • New page added to give a reference for the The Colour Picker.
  • Aircraft samples have been converted into the following two modular aircraft:
    1. SimpleAircraft
    2. WASMAircraft

 

SDK Tools

 

Developer Mode

  • General Developer Mode changes and updates:
    1. The "Debug PBR" menu page has been renamed as Channel Display and has had some additional updates to cover new options.
    2. A new option for Lighting Display debugging has been documented.
    3. Some menus can now be "detached" so you can easily access common options. See here for more information: Detachable Menus
    4. The Aircraft Editor section has been removed and replaced by the more general SimObject Editor.
    5. The section on using the Screenshot tool has been updated.
    6. The DevMode Toolbar has been documented.
    7. The Developer Camera Settings section has been updated with new options.
    8. The Behaviors Debug window has been documented

 

  • Project Editor
    The project editor has been updated with the following changes and new features:
    1. The new Package States have been documented.
    2. The Asset Types page has been tidied and now shows information for all relevant asset types available, including the new Airport asset group type.
    3. New Package Order Hint section has been added to The Project Inspector page.

 

 

  • Material Editor
    The material editor documentation has been refreshed and updated to show new features and improvements.
    1. The Material Inspector page has been updated with new "extra settings" section.
    2. New page on The Bitmap Manager has been added.

 

 

  • The Navigation Graph Editor

    A new section has been added dedicated to navigation graph edition, since these are not limited to use with SimObjects.

    1. Using The Navigation Graph Editor page has been added.

 

  • The SimAttachment Editor has been added to DevMode and the documentation. This editor is similar to the SimObject Editor, but designed for editing stand-along attachments that can then be added to your aircraft and scenery.

 

Models And Textures

 

Content Configuration

NOTE: For new CFG files and Parameters, please see the SimObject Editor (and associated CFG files) section.

 

Programming APIs

  • SimVar Documentation has been updated with multiple new sections. Note that many of the aircraft system SimVars can now take a name (a string) instead of the usual index value when addressing specific components. Each of the sections where where this is applicable explain the setup at the top.
    1. Pneumatics
    2. Hydraulics
    3. Water Ballast
    4. Liquid Dropping System
    5. Aircraft Wear And Tear States
  • New SimVars added in the following sections:
    1. Aircraft System Variables
      • LIQUID DROPPING DOOR FLOW VOLUME, LIQUID DROPPING SCOOP FLOW VOLUME, LIQUID DROPPING TANK CAPACITY VOLUME, LIQUID DROPPING TANK CURRENT VOLUME, LIQUID DROPPING TANK TOTAL CAPACITY VOLUME, LIQUID DROPPING TANK TOTAL CURRENT VOLUME, LIQUID DROPPING TOTAL DROPPED FLOW VOLUME, LIQUID DROPPING TOTAL SCOOPED FLOW VOLUME.
    2. Aircraft Engine Variables
      • RECIP ENG BRAKE POWER PCT,
    3. Aircraft Electrics Variables:
      • CIRCUIT CABIN SIGNAL GO, CIRCUIT CABIN SIGNAL STANDBY, CIRCUIT CABIN SIGNAL STOP, ELECTRICAL CIRCUIT EXISTS, ELECTRICAL GENERATOR ACTIVE, ELECTRICAL GENERATOR AMPS, ELECTRICAL GENERATOR VOLTAGE, ELECTRICAL GENERATOR SWITCH, ELECTRICAL CIRCUIT AMPS, ELECTRICAL CIRCUIT VOLTAGE, ELECTRICAL EXTERNAL POWER AMPS, ELECTRICAL EXTERNAL POWER VOLTAGE,
    4. Aircraft Control Variables:
      • ELEVATOR TRIM MIN, ELEVATOR TRIM MAX, ELEVATOR TRIM PCT EX1, RUDDER TRIM MIN, RUDDER TRIM MAX, RUDDER TRIM PCT EX1, AILERON TRIM MIN, AILERON TRIM MAX, AILERON TRIM PCT EX1, FLAPS CURRENT SPEED LIMITATION,
    5. Aircraft Flight Model Variables:
      • REFERENCE SPEED MAX IAS, REFERENCE SPEED MAX IAS GEAR DOWN, MAX LANDING WEIGHT, MAX TAKEOFF WEIGHT,
    6. Helicopter Variables:
      • HOVER INDUCED VELOCITY, ROTOR GOV TARGET PCT, ROTOR GOV ENGINE TRIM,
    7. Aircraft Misc. Variables:

      • BALLOON GAS DENSITY, BALLOON GAS TEMPERATURE, BALLOON VENT OPEN VALUE, BURNER HEATING POWER, BURNER PILOT LIGHT ON, BURNER VALVE OPEN VALUE,

    8. Miscellaneous Variables:

      • AMBIENT IN SMOKE, ENV CLOUD DENSITY, ENV SMOKE DENSITY, SEA LEVEL AMBIENT TEMPERATURE, HIDE AVATAR IN AIRCRAFT,

  • New section explaining Convenience SimVars.
  • Reverse Polish Notation documentation updated to include the following:
    1. New events added to the Mouse Variables: Enter, Exit,
    2. New vector operators: xyz, pbh, agl, &,
    3. New string operators: slen,
    4. New L:1 variable type added.
  • New section for the Electronic Flight Bag API has been added.
  • New page added to the Key Event ID documentation:
    1. Aircraft General Systems Events

      1. New key events for liquid dropping system added:

        LIQUID_DROPPING_SYSTEM_DOOR_CLOSE
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_CLOSE
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_OPEN
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_SET
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_TOGGLE
        LIQUID_DROPPING_SYSTEM_DOOR_OPEN
        LIQUID_DROPPING_SYSTEM_DOOR_SET
        LIQUID_DROPPING_SYSTEM_DOOR_TOGGLE
        LIQUID_DROPPING_SYSTEM_SCOOP_CLOSE
        LIQUID_DROPPING_SYSTEM_SCOOP_OPEN
        LIQUID_DROPPING_SYSTEM_SCOOP_SET
        LIQUID_DROPPINGSYSTEM_SCOOP_TOGGLE

      2. New key events for the pnuematics system added:

        PNEUMATICS_AREA_TEMPERATURE_DEC
        PNEUMATICS_AREA_TEMPERATURE_INC
        PNEUMATICS_AREA_TEMPERATURE_SET
        PNEUMATICS_FAN_SET
        PNEUMATICS_JUNCTION_LINE_OPENING_STATUS_SET
        PNEUMATICS_PACK_FLOW_AUTO_OFF
        PNEUMATICS_PACK_FLOW_AUTO_ON
        PNEUMATICS_PACK_FLOW_AUTO_SET
        PNEUMATICS_PACK_FLOW_MODE_HIGH
        PNEUMATICS_PACK_FLOW_MODE_LOW
        PNEUMATICS_PACK_FLOW_MODE_NORM
        PNEUMATICS_PACK_FLOW_MODE_SET
        PNEUMATICS_PACK_OFF
        PNEUMATICS_PACK_ON
        PNEUMATICS_PACK_SET
        PNEUMATICS_PACK_TOGGLE
        PNEUMATICS_PACKS_FLOW_DEC
        PNEUMATICS_PACKS_FLOW_INC
        PNEUMATICS_PACKS_FLOW_SET
        PNEUMATICS_TARGET_CABIN_ALTITUDE_DEC
        PNEUMATICS_TARGET_CABIN_ALTITUDE_INC
        PNEUMATICS_TARGET_CABIN_ALTITUDE_SET
        PNEUMATICS_VALVE_CLOSE
        PNEUMATICS_VALVE_MODE_AUTO
        PNEUMATICS_VALVE_MODE_CLOSED
        PNEUMATICS_VALVE_MODE_OPEN
        PNEUMATICS_VALVE_MODE_SET
        PNEUMATICS_VALVE_OPEN
        PNEUMATICS_VALVE_SET
        PNEUMATICS_VALVE_TOGGLE

      3. New key events for the hydraulics system added:

        HYDRAULIC_SWITCH_TOGGLE
        HYDRAULIC_VALVE_CLOSE
        HYDRAULIC_VALVE_OPEN
        HYDRAULIC_VALVE_SET
        HYDRAULIC_VALVE_TOGGLE

  • New page added to the Key Event ID documentation:
    1. Balloon Specific Events
      1. New key events for balloon burner systems have been added:

        AXIS_BURNER_PITCH_SET
        AXIS_BURNER_ROLL_SET
        BURNER_PITCH_DEC
        BURNER_PITCH_INC
        BURNER_ROLL_DEC
        BURNER_ROLL_INC
        BURNER_VALVE_CLOSE
        BURNER_VALVE_OPEN
        BURNER_VALVE_SET
        BURNER_VAL

      2. New key events for balloon envelopes have been added:

        BALLOON_VENT_CLOSE
        BALLOON_VENT_OPEN
        BALLOON_VENT_SET
        BALLOON_VENT_TOGGLE

 

 

Related Topics

  1. Introduction
  2. SDK Contents
  3. SDK Overview