mirror of
https://github.com/9ParsonsB/Pulsar.git
synced 2025-04-05 17:39:39 -04:00
351dcdb732
* [Core] Settings improvements: Grouping w/labels, support for doubles
Layout improvements:
* Plugins can set `[SettingSuggestedColumnWidth(123)]` on a settings class to adjust the settings view column width to make it wider or narrower to fit things nicely.
* Plugins can set `[SettingNewGroup("label")]` on any setting property to force a "new paragraph", or group, of settings. If "label" is also provided, a grouping header with that text will also be created.
* A double precision up/down numeric control has been added. In support of this, there is now a precision value on the existing `[SettingNumericBounds]` attribute to specify the number of digits of precision the control displays/allows.
Plugins:
* The above have been applied/demonstrated on the Botanist and Explorer plugin settings.
1751 lines
80 KiB
XML
1751 lines
80 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>ObservatoryFramework</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Observatory.Framework.SettingSuggestedColumnWidth">
|
|
<summary>
|
|
Specifies the width of a settings column in the settings view. There are two columns.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.SettingSuggestedColumnWidth.#ctor(System.Int32)">
|
|
<summary>
|
|
Specifies the width of a settings column in the settings view. There are two columns.
|
|
</summary>
|
|
<param name="width">Provides a hint of the width of a settings column.</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingSuggestedColumnWidth.Width">
|
|
<summary>
|
|
Provides a hint of the width of a settings column.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.SettingDisplayName">
|
|
<summary>
|
|
Specifies text to display as the name of the setting in the UI instead of the property name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.SettingDisplayName.#ctor(System.String)">
|
|
<summary>
|
|
Specifies text to display as the name of the setting in the UI instead of the property name.
|
|
</summary>
|
|
<param name="name">Name to display</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingDisplayName.DisplayName">
|
|
<summary>
|
|
Accessor to get/set displayed name.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.SettingNewGroup">
|
|
<summary>
|
|
Starts a new visual group of settings beginning with the current setting with an optional label.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.SettingNewGroup.#ctor(System.String)">
|
|
<summary>
|
|
Starts a new visual group of settings beginning with the current setting with an optional label.
|
|
</summary>
|
|
<param name="label">An optional label describing the group.</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingNewGroup.Label">
|
|
<summary>
|
|
An optional label describing the group.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.SettingIgnore">
|
|
<summary>
|
|
Indicates that the property should not be displayed to the user in the UI.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.SettingNumericUseSlider">
|
|
<summary>
|
|
Indicates numeric properly should use a slider control instead of a numeric textbox with roller.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.SettingBackingValue">
|
|
<summary>
|
|
Specify backing value used by Dictionary<string, object> to indicate selected option.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.SettingBackingValue.#ctor(System.String)">
|
|
<summary>
|
|
Specify backing value used by Dictionary<string, object> to indicate selected option.
|
|
</summary>
|
|
<param name="property">Property name for backing value.</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingBackingValue.BackingProperty">
|
|
<summary>
|
|
Accessor to get/set backing value property name.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.SettingNumericBounds">
|
|
<summary>
|
|
Specify bounds for numeric inputs.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.SettingNumericBounds.#ctor(System.Double,System.Double,System.Double,System.Int32)">
|
|
<summary>
|
|
Specify bounds for numeric inputs.
|
|
</summary>
|
|
<param name="minimum">Minimum allowed value.</param>
|
|
<param name="maximum">Maximum allowed value.</param>
|
|
<param name="increment">Increment between allowed values in slider/roller inputs.</param>
|
|
<param name="precision">The number of digits to display for non integer values.</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingNumericBounds.Minimum">
|
|
<summary>
|
|
Minimum allowed value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingNumericBounds.Maximum">
|
|
<summary>
|
|
Maximum allowed value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingNumericBounds.Increment">
|
|
<summary>
|
|
Increment between allowed values in slider/roller inputs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.SettingNumericBounds.Precision">
|
|
<summary>
|
|
The number of digits to display for non integer values.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.ColumnSuggestedWidth">
|
|
<summary>
|
|
Suggests default column width when building basic plugin grid UI.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.ColumnSuggestedWidth.#ctor(System.Int32)">
|
|
<summary>
|
|
Suggests default column width when building basic plugin grid UI.
|
|
</summary>
|
|
<param name="width">The suggested width of the annotated column.</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.ColumnSuggestedWidth.Width">
|
|
<summary>
|
|
The suggested width of the annotated column.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.JournalEventArgs">
|
|
<summary>
|
|
Provides data for Elite Dangerous journal events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.JournalEventArgs.journalType">
|
|
<summary>
|
|
<para>Type of journal entry that triggered event.</para>
|
|
<para>Will be a class from the Observatory.Framework.Files.Journal namespace derived from JournalBase, or JournalBase itself in the case of an unhandled journal event type.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.JournalEventArgs.journalEvent">
|
|
<summary>
|
|
<para>Elite Dangerous journal event, deserialized into a .NET object of the type specified by JournalEventArgs.journalType.</para>
|
|
<para>Unhandled json values within a journal entry type will be contained in member property:<br/>Dictionary<string, object> AdditionalProperties.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.NotificationArgs">
|
|
<summary>
|
|
Provides values used as arguments for Observatory notification events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.Title">
|
|
<summary>
|
|
Text typically displayed as header content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.TitleSsml">
|
|
<summary>
|
|
SSML representation of Title text.<br/>
|
|
This value is optional, if omitted the value of <c>NotificationArgs.Title</c> will be used for voice synthesis without markup.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.Detail">
|
|
<summary>
|
|
Text typically displayed as body content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.DetailSsml">
|
|
<summary>
|
|
SSML representation of Detail text.<br/>
|
|
This value is optional, if omitted the value of <c>NotificationArgs.Detail</c> will be used for voice synthesis without markup.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.Timeout">
|
|
<summary>
|
|
Specify window timeout in ms (overrides Core setting). Specify 0 timeout to persist until removed via IObservatoryCore.CancelNotification. Default -1 (use Core setting).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.XPos">
|
|
<summary>
|
|
Specify window X position as a percentage from upper left corner (overrides Core setting). Default -1.0 (use Core setting).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.YPos">
|
|
<summary>
|
|
Specify window Y position as a percentage from upper left corner (overrides Core setting). Default -1.0 (use Core setting).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.Rendering">
|
|
<summary>
|
|
Specifies the desired renderings of the notification. Defaults to <see cref="F:Observatory.Framework.NotificationRendering.All"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.Suppression">
|
|
<summary>
|
|
Specifies if some part of the notification should be suppressed. Not supported by all notifiers. Defaults to <see cref="F:Observatory.Framework.NotificationSuppression.None"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.Sender">
|
|
<summary>
|
|
The plugin sending this notification.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.ExtendedDetails">
|
|
<summary>
|
|
Additional notification detailed (generally not rendered by voice or popup; potentially used by aggregating/logging plugins).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationArgs.CoalescingId">
|
|
<summary>
|
|
A value which allows grouping of notifications together. For example, values >= 0 <= 1000 could be system body IDs, -1 is the system, anything else is arbitrary.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.NotificationSuppression">
|
|
<summary>
|
|
Defines constants for suppression of title or detail announcement in a notification.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationSuppression.None">
|
|
<summary>
|
|
No suppression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationSuppression.Title">
|
|
<summary>
|
|
Suppress title.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationSuppression.Detail">
|
|
<summary>
|
|
Suppress detail.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.NotificationRendering">
|
|
<summary>
|
|
Defines constants for controlling notification routing to plugins or native notification handlers.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationRendering.NativeVisual">
|
|
<summary>
|
|
Send notification to native visual popup notificaiton handler.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationRendering.NativeVocal">
|
|
<summary>
|
|
Send notification to native speech notification handler.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationRendering.PluginNotifier">
|
|
<summary>
|
|
Send notification to all installed notifier plugins.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.NotificationRendering.All">
|
|
<summary>
|
|
Send notification to all available handlers.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.LogMonitorState">
|
|
<summary>
|
|
Flags indicating current state of journal monitoring.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.LogMonitorState.Idle">
|
|
<summary>
|
|
Monitoring is stopped.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.LogMonitorState.Realtime">
|
|
<summary>
|
|
Real-time monitoring is active.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.LogMonitorState.Batch">
|
|
<summary>
|
|
Batch read of historical journals is in progress.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.LogMonitorState.PreRead">
|
|
<summary>
|
|
Batch read of recent journals is in progress to establish current player state.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.LogMonitorStateChangedEventArgs">
|
|
<summary>
|
|
Provides information about a LogMonitor state transition.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.LogMonitorStateChangedEventArgs.PreviousState">
|
|
<summary>
|
|
The previous LogMonitor state.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.LogMonitorStateChangedEventArgs.NewState">
|
|
<summary>
|
|
The new, current LogMonitor state.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.LogMonitorStateChangedEventArgs.IsBatchRead(Observatory.Framework.LogMonitorState)">
|
|
<summary>
|
|
Determins if the given state is a batch read of any form.
|
|
</summary>
|
|
<param name="state">The state to evaluate</param>
|
|
<returns>A boolean; True iff the state provided represents a batch-mode read.</returns>
|
|
</member>
|
|
<member name="T:Observatory.Framework.PluginException">
|
|
<summary>
|
|
Container for exceptions within plugins which cannot be gracefully handled in context,
|
|
but benefit from having a context-specific user message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.PluginException.#ctor(System.String,System.String,System.Exception)">
|
|
<summary>
|
|
Initialze new PluginException with details of the originating plugin and a specific user-facing message for display.
|
|
</summary>
|
|
<param name="pluginName"></param>
|
|
<param name="userMessage"></param>
|
|
<param name="innerException"></param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.PluginException.PluginName">
|
|
<summary>
|
|
Name of plugin from which the exception was thrown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.PluginException.UserMessage">
|
|
<summary>
|
|
Message to be displayed to user.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.BackpackFile">
|
|
<summary>
|
|
Elite Dangerous backpack.json file. Describes all the items currently carried by the player.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.BackpackFile.Items">
|
|
<summary>
|
|
List of all items carried.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.BackpackFile.Components">
|
|
<summary>
|
|
List of all components carried.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.BackpackFile.Consumables">
|
|
<summary>
|
|
List of player consumable items carried.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.BackpackFile.Data">
|
|
<summary>
|
|
List of all data currently stored by the player.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.BuyExplorationData">
|
|
<summary>
|
|
Journal event generated when buying system data from the galaxy map while docked.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.BuyExplorationData.System">
|
|
<summary>
|
|
Name of the system for which data was purchased.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.BuyExplorationData.Cost">
|
|
<summary>
|
|
Amount paid for the data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.CodexEntry">
|
|
<summary>
|
|
Event generated when an item in the codex is scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.EntryID">
|
|
<summary>
|
|
Unique ID of the entry.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Name">
|
|
<summary>
|
|
Name of the item scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Name_Localised">
|
|
<summary>
|
|
Localised name of the item scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.SubCategory">
|
|
<summary>
|
|
Codex sub category of the item scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.SubCategory_Localised">
|
|
<summary>
|
|
Localised sub category name of the item scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Category">
|
|
<summary>
|
|
Codex category of the item scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Category_Localised">
|
|
<summary>
|
|
Localised category name of the item scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Region">
|
|
<summary>
|
|
Codex region the scan occured in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Region_Localised">
|
|
<summary>
|
|
Localised name of the region.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.System">
|
|
<summary>
|
|
Name of the system in which the scan occured.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.SystemAddress">
|
|
<summary>
|
|
Unique ID of the system in which the scan occured.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.NearestDestination">
|
|
<summary>
|
|
Name of the nearest surface signal.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.NearestDestination_Localised">
|
|
<summary>
|
|
Localised name of hte nearest surface signal.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.IsNewEntry">
|
|
<summary>
|
|
Indicator that this codex entry hasn't been previously scanned by the CMDR.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.NewTraitsDiscovered">
|
|
<summary>
|
|
Indicator that htis codex entry has a trait not previously seen by the CMDR.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Traits">
|
|
<summary>
|
|
List of trais of the scanned item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.VoucherAmount">
|
|
<summary>
|
|
Value of the codex entry when sold to Universal Cartographics.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Latitude">
|
|
<summary>
|
|
Surface latitude where the scan occured.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.Longitude">
|
|
<summary>
|
|
Surface longitude where the scan occured.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CodexEntry.BodyID">
|
|
<summary>
|
|
Body ID of the system body where the scan occured.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.DiscoveryScan">
|
|
<summary>
|
|
Event generated when using the discovery scanner (honk) to initially scan system. No longer used in live game client, will be found only in historical data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.DiscoveryScan.SystemAddress">
|
|
<summary>
|
|
Unique ID of system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.DiscoveryScan.Bodies">
|
|
<summary>
|
|
Number of bodies in system.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.FSSAllBodiesFound">
|
|
<summary>
|
|
Event generated when all bodies within a system have been scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSAllBodiesFound.SystemName">
|
|
<summary>
|
|
Name of the system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSAllBodiesFound.SystemAddress">
|
|
<summary>
|
|
Unique ID of the system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSAllBodiesFound.Count">
|
|
<summary>
|
|
Count of all scanned bodies in system.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.FSSBodySignals">
|
|
<summary>
|
|
Event generated when the full spectrum scanner finds surface signals on a body.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.FSSDiscoveryScan">
|
|
<summary>
|
|
Event generated when using the discovery scanner (honk) to initially scan system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSDiscoveryScan.SystemName">
|
|
<summary>
|
|
Name of the current system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSDiscoveryScan.SystemAddress">
|
|
<summary>
|
|
Unique ID of the current system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSDiscoveryScan.Progress">
|
|
<summary>
|
|
Percentage of current system already scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSDiscoveryScan.BodyCount">
|
|
<summary>
|
|
Number of scannable bodies in system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSDiscoveryScan.NonBodyCount">
|
|
<summary>
|
|
Number of scannable non-body locations in system.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.FSSSignalDiscovered">
|
|
<summary>
|
|
Event generated when a signal source is identified or scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SignalName">
|
|
<summary>
|
|
Name of the signal type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SignalName_Localised">
|
|
<summary>
|
|
Localised name of the signal type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SignalType">
|
|
<summary>
|
|
Type of signal location.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SpawningState">
|
|
<summary>
|
|
Faction state or circumstance that caused this signal to appear.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SpawningState_Localised">
|
|
<summary>
|
|
Localised description of spawning state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SpawningFaction">
|
|
<summary>
|
|
Faction name which is associated with this signal.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SpawningFaction_Localised">
|
|
<summary>
|
|
Localised name of the associated faction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.TimeRemaining">
|
|
<summary>
|
|
Time until the signal despawns, in seconds.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.SystemAddress">
|
|
<summary>
|
|
Unique ID of current system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.ThreatLevel">
|
|
<summary>
|
|
Numeric representation of the signal threat level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.USSType">
|
|
<summary>
|
|
Type of signal.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.USSType_Localised">
|
|
<summary>
|
|
Localised name of signal type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.FSSSignalDiscovered.IsStation">
|
|
<summary>
|
|
Indicator if the signal is a station which can be docked with.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.MaterialCollected">
|
|
<summary>
|
|
Event generated when a material resource is collected.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialCollected.Category">
|
|
<summary>
|
|
Category to which the material belongs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialCollected.Name">
|
|
<summary>
|
|
Name of the material.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialCollected.Name_Localised">
|
|
<summary>
|
|
Localised name of the material.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialCollected.Count">
|
|
<summary>
|
|
Count of the material.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.MaterialDiscarded">
|
|
<summary>
|
|
Event generated when discarding held material resources.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.MaterialDiscovered">
|
|
<summary>
|
|
Event generated the first time a CMDR finds a particular material resource.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialDiscovered.Category">
|
|
<summary>
|
|
Category of the material.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialDiscovered.Name">
|
|
<summary>
|
|
Name of the material.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialDiscovered.Name_Localised">
|
|
<summary>
|
|
Localised name of the material.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MaterialDiscovered.DiscoveryNumber">
|
|
<summary>
|
|
Count of the number of discovered items in that category by the CMDR.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.MultiSellExplorationData">
|
|
<summary>
|
|
Event generated when discovery data for multiple systems are sold at once.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MultiSellExplorationData.Discovered">
|
|
<summary>
|
|
List of all sold first discoveries.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MultiSellExplorationData.BaseValue">
|
|
<summary>
|
|
Base value of total sold data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MultiSellExplorationData.Bonus">
|
|
<summary>
|
|
Bonus value added to base amount.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.MultiSellExplorationData.TotalEarnings">
|
|
<summary>
|
|
Total amount earned by CMDR for data sale.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.NavBeaconScan">
|
|
<summary>
|
|
Event generated when scanned a populated system's navigation beacon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.NavBeaconScan.NumBodies">
|
|
<summary>
|
|
Number of bodies in system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.NavBeaconScan.SystemAddress">
|
|
<summary>
|
|
Unique ID of system.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.SAAScanComplete">
|
|
<summary>
|
|
Event generated when a body surface scan is completed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAAScanComplete.SystemAddress">
|
|
<summary>
|
|
Unique ID of current system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAAScanComplete.BodyName">
|
|
<summary>
|
|
Name of the scanned body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAAScanComplete.BodyID">
|
|
<summary>
|
|
ID of the scanned body within the system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAAScanComplete.Discoverers">
|
|
<summary>
|
|
This property is indicated with strikethrough in Frontier's documentation and is likely unused.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAAScanComplete.Mappers">
|
|
<summary>
|
|
This property is indicated with strikethrough in Frontier's documentation and is likely unused.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAAScanComplete.ProbesUsed">
|
|
<summary>
|
|
Number of probes fired to complete the surface scan.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAAScanComplete.EfficiencyTarget">
|
|
<summary>
|
|
Maximum number of probes which can be used to get efficiency bonus.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.SAASignalsFound">
|
|
<summary>
|
|
Event written when the surface scan finds signals on the body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAASignalsFound.SystemAddress">
|
|
<summary>
|
|
Unique ID of current system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAASignalsFound.BodyName">
|
|
<summary>
|
|
Name of the scanned body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAASignalsFound.BodyID">
|
|
<summary>
|
|
ID of the body within the system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAASignalsFound.Signals">
|
|
<summary>
|
|
List of signals found.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SAASignalsFound.Genuses">
|
|
<summary>
|
|
List of genuses present.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.Scan">
|
|
<summary>
|
|
Journal "Scan" event generated when directly FSS scanning, from automatic proximity scans, or nav beacon data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.ScanType">
|
|
<summary>
|
|
Type of scan which generated the event. Possible options include "Detailed", "AutoScan", and "NavBeaconDetail" (non-exhaustive).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.BodyName">
|
|
<summary>
|
|
Name of scanned body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Parents">
|
|
<summary>
|
|
List which reflects Frontier's JSON structure for the "Parents" object. Use of Parent property is recommended instead.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Parent">
|
|
<summary>
|
|
"Parents" object rearranged into more intuitive structure for ease of use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.DistanceFromArrivalLS">
|
|
<summary>
|
|
Body distance from system arrival point in light-seconds.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.TidalLock">
|
|
<summary>
|
|
Indicates if body is tidally locked to another body (parent, child, or binary partner).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.TerraformState">
|
|
<summary>
|
|
Whether the planet can be or has been terraformed. Options include "Terraformable", "Terraformed", or "" (non-terraformable or naturally earth-like).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.PlanetClass">
|
|
<summary>
|
|
Class of planet. Consult your preferred source of journal documentation for all possible values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Atmosphere">
|
|
<summary>
|
|
Descriptive string for body atmosphere, e.g. "hot thick sulfur dioxide atmosphere".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.AtmosphereType">
|
|
<summary>
|
|
Simple string indicating dominant atmosphere type, e.g. "SulfurDioxide".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.AtmosphereComposition">
|
|
<summary>
|
|
List containing full breakdown of atmospheric components and their relative percentages.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Volcanism">
|
|
<summary>
|
|
Descriptive string for type of volcanism present, or an empty string for none, e.g. "major silicate vapour geysers volcanism".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.MassEM">
|
|
<summary>
|
|
Mass of body in multiples of Earth's mass (5.972e24 kg).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Radius">
|
|
<summary>
|
|
Radius of body in metres.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.SurfaceGravity">
|
|
<summary>
|
|
Surface gravity in m/s².
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.SurfaceTemperature">
|
|
<summary>
|
|
Average surface temperature in Kelvin.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.SurfacePressure">
|
|
<summary>
|
|
Average surface pressure in Pascals.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Landable">
|
|
<summary>
|
|
Whether the body in landable in the player's current version of Elite Dangerous.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Materials">
|
|
<summary>
|
|
List containing full breakdown of prospectable surface materials and their relative percentages.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Composition">
|
|
<summary>
|
|
Overall composition of body, expressed as percentages of ice, rock, and metal.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.RotationPeriod">
|
|
<summary>
|
|
Rotation period of body in seconds.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.AxialTilt">
|
|
<summary>
|
|
Axial tilt of body in radians.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Rings">
|
|
<summary>
|
|
List of all planetary or stellar ring systems around the body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.ReserveLevel">
|
|
<summary>
|
|
Description of the minable material abundance.<br/>Possible values inclue "PristineResources", "MajorResources", "CommonResources", "LowResources", and "DepletedResources".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.StarType">
|
|
<summary>
|
|
Type of star. Consult your preferred source of journal documentation for all possible values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Subclass">
|
|
<summary>
|
|
Subclass of star. Consult your preferred source of journal documentation for all possible values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.StellarMass">
|
|
<summary>
|
|
Mass of star in multiples of The Sun's mass (1.989e30 kg).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.AbsoluteMagnitude">
|
|
<summary>
|
|
Absolute magnitude of star.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Age_MY">
|
|
<summary>
|
|
Age of body in millions of years.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.Luminosity">
|
|
<summary>
|
|
Yerkes luminosity class of star.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.WasDiscovered">
|
|
<summary>
|
|
Whether the body has been previously discovered by a player.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Scan.WasMapped">
|
|
<summary>
|
|
Whether the body has been previously mapped by a player.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.ScanBaryCentre">
|
|
<summary>
|
|
Barycentre orbital properties, automatically recorded when any member of a multiple-body orbital arrangement is first scanned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.StarSystem">
|
|
<summary>
|
|
Name of star system containing scanned body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.SystemAddress">
|
|
<summary>
|
|
64-bit unique identifier for the current star system. Also known as the system's "ID64".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.BodyID">
|
|
<summary>
|
|
Id number of body within a system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.SemiMajorAxis">
|
|
<summary>
|
|
Orbital semi-major axis in metres.<br/>Distance from the body's centre of gravity to the parent's centre of gravity at the most distant point in the orbit.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.Eccentricity">
|
|
<summary>
|
|
Orbital eccentricity.<br/>0: perfectly circular, 0 > x > 1: eccentric, 1: parabolic (escape) trajectory.<br/>(You should not ever see 1 or 0.)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.OrbitalInclination">
|
|
<summary>
|
|
Orbital inclination in degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.Periapsis">
|
|
<summary>
|
|
Argument of periapsis in degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.OrbitalPeriod">
|
|
<summary>
|
|
Orbital period in seconds.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.AscendingNode">
|
|
<summary>
|
|
Longitude of the ascending node in degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.ScanBaryCentre.MeanAnomaly">
|
|
<summary>
|
|
Mean anomaly in degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.Screenshot">
|
|
<summary>
|
|
Event generated when the player takes a screenshot.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Filename">
|
|
<summary>
|
|
<para>Filename of the screenshot taken in the form of "\\ED Pictures\\filename"</para>
|
|
<para>"\\ED Pictures\\" corresponds to "%userprofile%\Pictures\Frontier Developments\Elite Dangerous\"</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Width">
|
|
<summary>
|
|
Pixel width of the saved image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Height">
|
|
<summary>
|
|
Pixel height of the saved image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.System">
|
|
<summary>
|
|
System name of the current system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Body">
|
|
<summary>
|
|
Body name of the current location.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Latitude">
|
|
<summary>
|
|
Current latitude if applicable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Longitude">
|
|
<summary>
|
|
Current longitude if applicable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Altitude">
|
|
<summary>
|
|
Current altitude if applicable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Screenshot.Heading">
|
|
<summary>
|
|
Current heading if applicable.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Journal.SellExplorationData">
|
|
<summary>
|
|
Event generated when selling exploration data. Historically also written for multi-selling, but used only for single system sales in current live game client.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SellExplorationData.Systems">
|
|
<summary>
|
|
List of systems for which data was sold.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SellExplorationData.Discovered">
|
|
<summary>
|
|
List of first discovered bodies.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SellExplorationData.BaseValue">
|
|
<summary>
|
|
Base value of sold data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SellExplorationData.Bonus">
|
|
<summary>
|
|
Extra amount from bonuses.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.SellExplorationData.TotalEarnings">
|
|
<summary>
|
|
Total amount made from selling data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.CarrierJump.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Disembark.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Market.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Outfitting.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Shipyard.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.StoredModules.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.StoredShips.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Docked.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.DockingRequested.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Location.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Journal.Undocked.StationName">
|
|
<summary>
|
|
Name of the station at which this event occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.CargoFile">
|
|
<summary>
|
|
Elite Dangerous cargo.json file. Describes the current cargo carried above the player's ship.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.CargoFile.Vessel">
|
|
<summary>
|
|
Type of vehicle currently being reported. "Ship" or "SRV".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.CargoFile.Count">
|
|
<summary>
|
|
Number of different types of cargo carried(?)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.CargoFile.Inventory">
|
|
<summary>
|
|
List of full cargo details.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Converters.LegacyFactionConverter`1">
|
|
<summary>
|
|
Faction changed from a simple string to an object with additional state information. If we find a string convert it to an object with null state.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Converters.MaterialCompositionConverter">
|
|
<summary>
|
|
The format used for materials changed from an object with a key for each material to an array of objects containing "name" and "percent".
|
|
Need to handle both if we're going to read historical data. This reads the old format into a class reflecting the new structure.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Converters.MaterialConverter">
|
|
<summary>
|
|
The format used for materials changed from an object with a key for each material to an array of objects containing "name" and "percent".
|
|
Need to handle both if we're going to read historical data. This reads the old format into a class reflecting the new structure.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Converters.StarPosConverter">
|
|
<summary>
|
|
Converting the ordered array of coordinates from the journal to a named tuple for clarity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.FCMaterialsFile">
|
|
<summary>
|
|
Elite Dangerous fcmaterials.json file. Contains data about current fleet carrier bartender stock.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.FCMaterialsFile.Items">
|
|
<summary>
|
|
List of items in stock and in demand from the carrier bartender.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.MarketFile">
|
|
<summary>
|
|
Elite Dangerous market.json file. Contains details about all available commodities available at the current station.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.MarketFile.MarketID">
|
|
<summary>
|
|
Unique ID of current market.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.MarketFile.StationName">
|
|
<summary>
|
|
Name of the station where the market is located.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.MarketFile.StationType">
|
|
<summary>
|
|
Type of station where the market is located.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.MarketFile.StarSystem">
|
|
<summary>
|
|
Name of star system where the market is located.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.MarketFile.Items">
|
|
<summary>
|
|
List of all commodities available in the market.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.ModuleInfoFile">
|
|
<summary>
|
|
Information about current player ship equipped modules.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ModuleInfoFile.Modules">
|
|
<summary>
|
|
List of all equipped modules.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.NavRouteFile">
|
|
<summary>
|
|
Elite Dangerous navroute.json file. Contains data about currently plotted FSD jump route.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.NavRouteFile.Route">
|
|
<summary>
|
|
List of star systems and their locations in the current route.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.OutfittingFile">
|
|
<summary>
|
|
Elite Dangerous outfitting.json file. Contains data about ship modules available for purchase at the current station.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.OutfittingFile.MarketID">
|
|
<summary>
|
|
Unique ID of current market.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.OutfittingFile.StationName">
|
|
<summary>
|
|
Name of the station where the market is located.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.OutfittingFile.StarSystem">
|
|
<summary>
|
|
Name of the star system where the market is located.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.OutfittingFile.Horizons">
|
|
<summary>
|
|
Indicator if the player has access to Horizons content.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.OutfittingFile.Items">
|
|
<summary>
|
|
List of all available parts in shipyard.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.Files.ParameterTypes.StatusFlags.RadialAltitude">
|
|
<summary>
|
|
Altitude above average radius (sea level) when set. Altitude raycast to ground when unset.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.ParameterTypes.GenusType">
|
|
<summary>
|
|
Genus object used within SAASignalsFound event
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ParameterTypes.GenusType.Genus">
|
|
<summary>
|
|
Internal (non-localised) name of genus, e.g.: "$Codex_Ent_Stratum_Genus_Name"
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ParameterTypes.GenusType.Genus_Localised">
|
|
<summary>
|
|
Name of genus localised for player locale, e.g.: "Stratum"
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.ShipyardFile">
|
|
<summary>
|
|
Elite Dangerous shipyard.json file. Contains data about ships available for purchase at the current station.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ShipyardFile.MarketID">
|
|
<summary>
|
|
Unique ID of current market.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ShipyardFile.StationName">
|
|
<summary>
|
|
Name of station where shipyard is located.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ShipyardFile.StarSystem">
|
|
<summary>
|
|
Starsystem where shipyard is located.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ShipyardFile.Horizons">
|
|
<summary>
|
|
Whether player has access to Horizons content.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ShipyardFile.AllowCobraMkIV">
|
|
<summary>
|
|
<para>Whether player has access to the Cobra MkIV.</para>
|
|
<para>Will never be set to true for CMDR Nuse.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.ShipyardFile.PriceList">
|
|
<summary>
|
|
List of all ships and prices for them at the current shipyard.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Files.Status">
|
|
<summary>
|
|
Elite Dangerous status.json file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Flags">
|
|
<summary>
|
|
Set of flags representing current player state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Flags2">
|
|
<summary>
|
|
Additional set of flags representing current player state.
|
|
Added in later versions of Elite Dangerous.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Pips">
|
|
<summary>
|
|
Current allocation of power distribution (pips) between SYS, ENG, and WEP, in "half pip" increments.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Firegroup">
|
|
<summary>
|
|
Currently selected fire group.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.GuiFocus">
|
|
<summary>
|
|
UI component currently focused by the player.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Fuel">
|
|
<summary>
|
|
Fuel remaining in the current ship.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Cargo">
|
|
<summary>
|
|
Amount of cargo currently carried.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.LegalState">
|
|
<summary>
|
|
Legal status in the current jurisdiction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Altitude">
|
|
<summary>
|
|
<para>Current altitude.</para>
|
|
<para>Check if RadialAltitude is set in StatusFlags to determine if altitude is based on planetary radius (set) or raycast to ground (unset).</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Latitude">
|
|
<summary>
|
|
Latitude of current surface location.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Longitude">
|
|
<summary>
|
|
Longitude of current surface location.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Heading">
|
|
<summary>
|
|
Current heading for surface direction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.BodyName">
|
|
<summary>
|
|
Body name of current location.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.PlanetRadius">
|
|
<summary>
|
|
Radius of current planet.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Oxygen">
|
|
<summary>
|
|
Oxygen remaining on foot, range from 0.0 - 1.0.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Health">
|
|
<summary>
|
|
Health remaining on foot, range from 0.0 - 1.0.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Temperature">
|
|
<summary>
|
|
Current environmental temperature in K while on foot.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.SelectedWeapon">
|
|
<summary>
|
|
Name of currently selected personal weapon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Gravity">
|
|
<summary>
|
|
Current strength of gravity while on foot, in g.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Balance">
|
|
<summary>
|
|
Current credit balance of player.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Files.Status.Destination">
|
|
<summary>
|
|
Currently set destination.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Interfaces.IObservatoryPlugin">
|
|
<summary>
|
|
<para>Base plugin interface containing methods common to both notifiers and workers.</para>
|
|
<para>Note: Not intended to be implemented on its own and will not define a functional plugin. Use IObservatoryWorker, IObservatoryNotifier, or both, as appropriate.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryPlugin.Load(Observatory.Framework.Interfaces.IObservatoryCore)">
|
|
<summary>
|
|
<para>This method will be called on startup by Observatory Core when a plugin is first loaded.</para>
|
|
<para>Passes the Core interface to the plugin.</para>
|
|
</summary>
|
|
<param name="observatoryCore">Object implementing Observatory Core's main interface. A reference to this object should be maintained by the plugin for communication back to Core.</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryPlugin.Name">
|
|
<summary>
|
|
Full name of the plugin. Displayed in the Core settings tab's plugin list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryPlugin.ShortName">
|
|
<summary>
|
|
Short name of the plugin. Used as the tab title for the plugin UI.<br/>
|
|
Can be omitted, in which case the full Name will be used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryPlugin.Version">
|
|
<summary>
|
|
Version string displayed in the Core settings tab's plugin list.<br/>
|
|
Potentially used for automated version checking. (Not yet implemented)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryPlugin.PluginUI">
|
|
<summary>
|
|
Reference to plugin UI to display within its tab.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryPlugin.Settings">
|
|
<summary>
|
|
<para>Accessors for plugin settings object. Should be initialized with a default state during the plugin constructor.</para>
|
|
<para>Saving and loading of settings is handled by Observatory Core, and any previously saved settings will be set after plugin instantiation, but before Load() is called.</para>
|
|
<para>A plugin's settings class is expected to consist of properties with public getters and setters. The settings UI will be automatically generated based on each property type.<br/>
|
|
The [SettingDisplayName(string name)] attribute can be used to specify a display name, otherwise the name of the property will be used.<br/>
|
|
Private or internal properties and methods are ignored and can be used for backing values or any other purpose.<br/>
|
|
If a public property is necessary but not required to be user accessible the [SettingIgnore] property will suppress display.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryPlugin.ColumnSorter">
|
|
<summary>
|
|
<para>Plugin-specific object implementing the IComparer interface which is used to sort columns in the basic UI datagrid.</para>
|
|
<para>If omitted a natural sort order is used.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryPlugin.HandlePluginMessage(System.String,System.String,System.Object)">
|
|
<summary>
|
|
Receives data sent by other plugins.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Interfaces.IObservatoryWorker">
|
|
<summary>
|
|
<para>Interface for worker plugins which process journal data to update their UI or send notifications.</para>
|
|
<para>Work required on plugin startup — for example object instantiation — can be done in the constructor or Load() method.<br/>
|
|
Be aware that saved settings will not be available until Load() is called.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryWorker.JournalEvent``1(``0)">
|
|
<summary>
|
|
Method called when new journal data is processed. Most work done by worker plugins will occur here.
|
|
</summary>
|
|
<typeparam name="TJournal">Specific type of journal entry being received.</typeparam>
|
|
<param name="journal"><para>Elite Dangerous journal event, deserialized into a .NET object.</para>
|
|
<para>Unhandled json values within a journal entry type will be contained in member property:<br/>Dictionary<string, object> AdditionalProperties.</para>
|
|
<para>Unhandled journal event types will be type JournalBase with all values contained in AdditionalProperties.</para></param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryWorker.StatusChange(Observatory.Framework.Files.Status)">
|
|
<summary>
|
|
Method called when status.json content is updated.<br/>
|
|
Can be omitted for plugins which do not use this data.
|
|
</summary>
|
|
<param name="status">Player status.json content, deserialized into a .NET object.</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryWorker.LogMonitorStateChanged(Observatory.Framework.LogMonitorStateChangedEventArgs)">
|
|
<summary>
|
|
Called when the LogMonitor changes state. Useful for suppressing output in certain situations
|
|
such as batch reads (ie. "Read all") or responding to other state transitions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryWorker.ReadAllStarted">
|
|
<summary>
|
|
Method called when the user begins "Read All" journal processing, before any journal events are sent.<br/>
|
|
Used to track if a "Read All" operation is in progress or not to avoid unnecessary processing or notifications.<br/>
|
|
Can be omitted for plugins which do not require the distinction.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryWorker.ReadAllFinished">
|
|
<summary>
|
|
Method called when "Read All" journal processing completes.<br/>
|
|
Used to track if a "Read All" operation is in progress or not to avoid unnecessary processing or notifications.<br/>
|
|
Can be omitted for plugins which do not require the distinction.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Interfaces.IObservatoryNotifier">
|
|
<summary>
|
|
<para>Interface for notifier plugins which receive notification events from other plugins for any purpose.</para>
|
|
<para>Work required on plugin startup — for example object instantiation — can be done in the constructor or Load() method.<br/>
|
|
Be aware that saved settings will not be available until Load() is called.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryNotifier.OnNotificationEvent(Observatory.Framework.NotificationArgs)">
|
|
<summary>
|
|
Method called when other plugins send notification events to Observatory Core.
|
|
</summary>
|
|
<param name="notificationEventArgs">Details of the notification as sent from the originating worker plugin.</param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryNotifier.OverrideAudioNotifications">
|
|
<summary>
|
|
Property set by notification plugins to indicate to Core
|
|
that native audio notifications should be disabled/suppressed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryNotifier.OverridePopupNotifications">
|
|
<summary>
|
|
Property set by notification plugins to indicate to Core
|
|
that native popup notifications should be disabled/suppressed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Interfaces.IObservatoryCore">
|
|
<summary>
|
|
Interface passed by Observatory Core to plugins. Primarily used for sending notifications and UI updates back to Core.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.SendNotification(System.String,System.String)">
|
|
<summary>
|
|
Send a notification out to all native notifiers and any plugins implementing IObservatoryNotifier.
|
|
</summary>
|
|
<param name="title">Title text for notification.</param>
|
|
<param name="detail">Detail/body text for notificaiton.</param>
|
|
<returns>Guid associated with the notification during its lifetime. Used as an argument with CancelNotification and UpdateNotification.</returns>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.SendNotification(Observatory.Framework.NotificationArgs)">
|
|
<summary>
|
|
Send a notification with arguments out to all native notifiers and any plugins implementing IObservatoryNotifier.
|
|
</summary>
|
|
<param name="notificationEventArgs">NotificationArgs object specifying notification content and behaviour.</param>
|
|
<returns>Guid associated with the notification during its lifetime. Used as an argument with CancelNotification and UpdateNotification.</returns>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.CancelNotification(System.Guid)">
|
|
<summary>
|
|
Cancel or close an active notification.
|
|
</summary>
|
|
<param name="notificationId">Guid of notification to be cancelled.</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.UpdateNotification(System.Guid,Observatory.Framework.NotificationArgs)">
|
|
<summary>
|
|
Update an active notification with a new set of NotificationsArgs. Timeout values are reset and begin counting again from zero if specified.
|
|
</summary>
|
|
<param name="notificationId">Guid of notification to be updated.</param>
|
|
<param name="notificationEventArgs">NotificationArgs object specifying updated notification content and behaviour.</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.AddGridItem(Observatory.Framework.Interfaces.IObservatoryWorker,System.Object)">
|
|
<summary>
|
|
Add an item to the bottom of the basic UI grid.
|
|
</summary>
|
|
<param name="worker">Reference to the calling plugin's worker interface.</param>
|
|
<param name="item">Grid item to be added. Object type should match original template item used to create the grid.</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.AddGridItems(Observatory.Framework.Interfaces.IObservatoryWorker,System.Collections.Generic.IEnumerable{System.Object})">
|
|
<summary>
|
|
Add multiple items to the bottom of the basic UI grid.
|
|
</summary>
|
|
<param name="worker">Reference to the calling plugin's worker interface.</param>
|
|
<param name="items">Grid items to be added. Object types should match original template item used to create the grid.</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.ClearGrid(Observatory.Framework.Interfaces.IObservatoryWorker,System.Object)">
|
|
<summary>
|
|
Clears basic UI grid, removing all items.
|
|
</summary>
|
|
<param name="worker">Reference to the calling plugin's worker interface.</param>
|
|
<param name="templateItem">Template item used to re-initialise the grid.</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.GetStatus">
|
|
<summary>
|
|
Requests current Elite Dangerous status.json content.
|
|
</summary>
|
|
<returns>Status object reflecting current Elite Dangerous player status.</returns>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryCore.Version">
|
|
<summary>
|
|
Version string of Observatory Core.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.GetPluginErrorLogger(Observatory.Framework.Interfaces.IObservatoryPlugin)">
|
|
<summary>
|
|
Returns a delegate for logging an error for the calling plugin. A plugin can wrap this method
|
|
or pass it along to its collaborators.
|
|
</summary>
|
|
<param name="plugin">The calling plugin</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.ExecuteOnUIThread(System.Action)">
|
|
<summary>
|
|
Perform an action on the current Avalonia UI thread.
|
|
</summary>
|
|
<param name="action"></param>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryCore.HttpClient">
|
|
<summary>
|
|
Shared application HttpClient object. Provided so that plugins can adhere to .NET recommended behaviour of a single HttpClient object per application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryCore.CurrentLogMonitorState">
|
|
<summary>
|
|
Returns the current LogMonitor state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryCore.IsLogMonitorBatchReading">
|
|
<summary>
|
|
Returns true if the current LogMonitor state represents a batch-read mode.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryCore.PluginStorageFolder">
|
|
<summary>
|
|
Retrieves and ensures creation of a location which can be used by the plugin to store persistent data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.PlayAudioFile(System.String)">
|
|
<summary>
|
|
Plays audio file using default audio device.
|
|
</summary>
|
|
<param name="filePath">Absolute path to audio file.</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.Interfaces.IObservatoryCore.SendPluginMessage(Observatory.Framework.Interfaces.IObservatoryPlugin,System.Object)">
|
|
<summary>
|
|
Sends arbitrary data to all other plugins. The full name and version of the sending plugin will be used to identify the sender to any recipients.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.Interfaces.IObservatoryComparer">
|
|
<summary>
|
|
Extends the base IComparer interface with exposed values for the column ID and sort order to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryComparer.SortColumn">
|
|
<summary>
|
|
Column ID to be currently sorted by.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Observatory.Framework.Interfaces.IObservatoryComparer.Order">
|
|
<summary>
|
|
Current order of sorting. Ascending = 1, Descending = -1, No sorting = 0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Observatory.Framework.PluginUI">
|
|
<summary>
|
|
Class permitting plugins to provide their UI, if any, to Observatory Core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.PluginUI.PluginUIType">
|
|
<summary>
|
|
Type of UI used by plugin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.PluginUI.UI">
|
|
<summary>
|
|
<para>UI object used by plugins with UIType.Panel.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.PluginUI.DataGrid">
|
|
<summary>
|
|
<para>Collection bound to DataGrid used by plugins with UIType.Basic.</para>
|
|
<para>Objects in collection should be of a class defined within the plugin consisting of string properties.<br/>Each object is a single row, and the property names are used as column headers.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Observatory.Framework.PluginUI.#ctor(System.Collections.ObjectModel.ObservableCollection{System.Object})">
|
|
<summary>
|
|
Instantiate PluginUI of UIType.Basic.
|
|
</summary>
|
|
<param name="DataGrid">
|
|
<para>Collection bound to DataGrid used by plugins with UIType.Basic.</para>
|
|
<para>Objects in collection should be of a class defined within the plugin consisting of string properties.<br/>Each object is a single row, and the property names are used as column headers.</para>
|
|
</param>
|
|
</member>
|
|
<member name="M:Observatory.Framework.PluginUI.#ctor(Observatory.Framework.PluginUI.UIType,System.Object)">
|
|
<summary>
|
|
Instantiate PluginUI of specified UIType.
|
|
<para>(Untested/not implemented)</para>
|
|
</summary>
|
|
<param name="uiType">UIType for plugin.</param>
|
|
<param name="UI">Avalonia control to place in plugin tab.</param>
|
|
</member>
|
|
<member name="T:Observatory.Framework.PluginUI.UIType">
|
|
<summary>
|
|
Options for plugin UI types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.PluginUI.UIType.None">
|
|
<summary>
|
|
No UI. Tab will not be added to list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.PluginUI.UIType.Basic">
|
|
<summary>
|
|
Simple listview, to which items can be added or removed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.PluginUI.UIType.Panel">
|
|
<summary>
|
|
Panel control which is placed in plugin tab.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Observatory.Framework.PluginUI.UIType.Core">
|
|
<summary>
|
|
UI used by Observatory Core settings tab.<br/>
|
|
Not intended for use by plugins.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|