Telemetry
Telemetry functions let add-ons load, save, clear, identify, and inspect the telemetry document as a whole.
Use this section when your add-on needs to answer practical questions such as:
Is telemetry currently loaded?
Is temporal data available for playback or analysis?
What file path is associated with the current telemetry?
What time range contains transform samples?
Should a tool, button, export, or analysis feature be enabled?
These functions describe the telemetry document itself. To inspect aircraft, vehicles, weapons, bullseyes, and other objects inside the telemetry, use the Telemetry Objects section.
Loading, saving, and clearing telemetry
Telemetry can be loaded from a file, saved to a file, or cleared from memory.
Document-level information such as the telemetry document name is updated when telemetry is loaded or saved, and cleared when telemetry is cleared.
Availability
Use availability helpers before enabling tools which depend on telemetry data.
Use IsTelemetryEmpty() when you only need to know whether there is any telemetry in memory.
Use IsTemporalTelemetryAvailable() when your tool needs time-based transform data, such as playback, trails, charts, or analysis over time.
Document identity
Use document identity helpers when you need a practical file-oriented reference to the current telemetry.
The document name is the full file path associated with the loaded telemetry. It is useful for default export locations, report generation, window titles, and user interface labels.
Time ranges
Use telemetry time helpers when you need to work with the global transform timeline.
The transform time range tells you where temporal transform samples exist in the telemetry as a whole.
This is different from object active time. Object active time describes when a specific object logically exists, and is documented in the Telemetry Objects section.
Last updated