v1.6.1 - A Few Fixes and New Utility States & Events

[mpaperno]

Changes since v1.6.0:

Version number: 1060100

Fixes

• Fixed validation of L vars to allow leading _ (fixes #73). Thanks to @Mushupm on GitHub for reporting and testing a fix.
• Simulator ('A') type variables can now also have leading index/component name elements (eg. "3:VAR NAME:1").
• Fixed an issue which apparently affected a very limited number of systems (only 1 known occurrence) which resulted in most of the plugin v1.6.0 actions not working at all,
  except when used in a button's "On Hold" setup. This would only have affected actions added to buttons/flows since plugin v1.6.0, older versions of the same actions are unaffected.
  Note For the fix to take effect, any existing plugin v1.6.0 actions need to be replaced with the new ones from this version.
  Thanks to @Raeas on TP's Discord for reporting and troubleshooting a similar issue on another plugin, which led to the fix. (This turned out to be due to a silent Touch Portal error which prevented the action from being sent to the plugin.)
• The "Data from the most recent Simulator System Event" State is now updated before the "Simulator System Event" is triggered so that the data will be available in event handlers immediately.
  Fixes possible issue with needing to add a delay before trying to use the data value, eg. in "AirplaneLoaded" event handler to read the model file name.

New States

• Plugin
  • Plugin Running State (stopped / starting / started) - Changes based on plugin status. Can be used with Touch Portal's "Start/Stop Plug-in" action for a toggle effect, for example.
  • Status of WASM module (unknown / undetected / disconnected / connected) - (MSFS edition only) Reports connection status of the optional WASM module.
    Starts as "unknown" before initial simulator connection is established. "undetected" means the module could not be connected to at all, due to it not being installed or a connection error.
    Otherwise the status should match the main SimConnect connection status of either connected or disconnected.
• Simulator System
  • Simulator Version (0 / 10 / 11 / 12) - Last connected simulator "major" version (default before any connection is 0).
    These are the version numbers reported by SimConnect: 10 = FSX, 11 = FS20, 12 = FS24. (No idea what P3D reports, sorry!)

New Events

Implemented new Touch Portal v4+ event types that can contain associated data values as "local states," which can be used like other "local values" in actions that are placed inside the event block.

These events are alternatives to current options of listening for plugin state changes or the individual events in "Simulator System Event" choices.

Further details about each event and their local states is available in the generated plugin documentation on the Wiki (expand the category details and then go to "Events" link).

• Plugin
  • Plugin Message Event - emitted when the plugin logs an informative message. Local states contain the message source and severity plus the actual message text.
  • Simulator Connection Change - emitted when connection to the simulator changes. Alternative to watching the 'The status of SimConnect' State for changes, or using the individual event types in "Simulator System Event",
  • Touch Portal Device Page Change - emitted when the plugin detects a new page has been loaded on a Touch Portal device. The local states contain the new and previous page names and information about the device.
• Simulator System
  • Simulator Pause State Change - emitted when the Pause State of the simulator changes (MSFS edition only). Local states contain new and previous pause states in numeric and text formats.
  • Simulator System Filename Event - emitted in response to any simulator system event which has an associated file name, such as when loading aircraft, flights, or flight plans.
    It has two local states which describe the event and contain the file name.

Full Commit Log

---

Check the README for installation instructions and other documentation.

The MSFS-TouchPortal-Plugin and FSX-TouchPortal-Plugin are separate plugins which can co-exist in Touch Portal. The "FSX" edition supports FSX Deluxe SP2 or newer simulators, including MSFS 2020, but the "MSFS" version is recommended for that instead. See the README for details.

The WASimModule is an optional WASM module for MSFS 2020 and 2024 which provides additional plugin functionality. Once again, please see that README for details.

---

This discussion was created from the release v1.6.1 - A Few Fixes and New Utility States & Events.