2
0
mirror of https://github.com/9ParsonsB/Pulsar.git synced 2025-07-03 09:03:42 -04:00

Added framework xml documentation for all "exploration" events.

This commit is contained in:
Xjph
2022-06-12 14:44:04 -02:30
parent 9586e37be7
commit 0c218ed52b
17 changed files with 782 additions and 4 deletions

View File

@ -1,15 +1,46 @@
namespace Observatory.Framework.Files.Journal
{
/// <summary>
/// Event generated when the player takes a screenshot.
/// </summary>
public class Screenshot : JournalBase
{
/// <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>
public string Filename { get; init; }
/// <summary>
/// Pixel width of the saved image.
/// </summary>
public int Width { get; init; }
/// <summary>
/// Pixel height of the saved image.
/// </summary>
public int Height { get; init; }
/// <summary>
/// System name of the current system.
/// </summary>
public string System { get; init; }
/// <summary>
/// Body name of the current location.
/// </summary>
public string Body { get; init; }
/// <summary>
/// Current latitude if applicable.
/// </summary>
public float Latitude { get; init; }
/// <summary>
/// Current longitude if applicable.
/// </summary>
public float Longitude { get; init; }
/// <summary>
/// Current altitude if applicable.
/// </summary>
public float Altitude { get; init; }
/// <summary>
/// Current heading if applicable.
/// </summary>
public int Heading { get; init; }
}
}