ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2026-01-01 13:23:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

refactor: new code style in PluginDefinition.cs

Browse source
This commit is contained in:
goat 2021-03-31 17:09:17 +02:00
parent c5716cf93e
commit 0d8d9e57d4
1 changed files with 23 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

43
Dalamud/Plugin/PluginDefinition.cs
View file

@ -6,100 +6,103 @@ using System.Threading.Tasks;
namespace Dalamud.Plugin
{
/// <summary>
/// Class containing information about a plugin.
/// </summary>
public class PluginDefinition
{
/// <summary>
/// The author/s of the plugin.
/// Gets or sets the author/s of the plugin.
/// </summary>
public string Author { get; set; }
/// <summary>
/// The public name of the plugin.
/// Gets or sets the public name of the plugin.
/// </summary>
public string Name { get; set; }
/// <summary>
/// The internal name of the plugin, which should match the assembly name of the plugin.
/// Gets or sets the internal name of the plugin, which should match the assembly name of the plugin.
/// </summary>
public string InternalName { get; set; }
/// <summary>
/// The current assembly version of the plugin.
/// Gets or sets the current assembly version of the plugin.
/// </summary>
public string AssemblyVersion { get; set; }
/// <summary>
/// The current testing assembly version of the plugin.
/// Gets or sets the current testing assembly version of the plugin.
/// </summary>
public string TestingAssemblyVersion { get; set; }
/// <summary>
/// Defines if the plugin is only available for testing.
/// Gets or sets a value indicating whether the plugin is only available for testing.
/// </summary>
public bool IsTestingExclusive { get; set; }
/// <summary>
/// A description of the plugins functions.
/// Gets or sets a description of the plugins functions.
/// </summary>
public string Description { get; set; }
/// <summary>
/// The version of the game this plugin works with.
/// Gets or sets the version of the game this plugin works with.
/// </summary>
public string ApplicableVersion { get; set; }
/// <summary>
/// An URL to the website or source code of the plugin.
/// Gets or sets an URL to the website or source code of the plugin.
/// </summary>
public string RepoUrl { get; set; }
/// <summary>
/// List of tags defined on the plugin.
/// Gets or sets a list of tags defined on the plugin.
/// </summary>
public List<string> Tags { get; set; }
/// <summary>
/// Whether or not the plugin is hidden in the plugin installer.
/// Gets or sets a value indicating whether or not the plugin is hidden in the plugin installer.
/// </summary>
public bool IsHide { get; set; }
/// <summary>
/// The API level of this plugin. For the current API level, please see <see cref="PluginManager.DALAMUD_API_LEVEL"/> for the currently used API level.
/// Gets or sets the API level of this plugin. For the current API level, please see <see cref="PluginManager.DALAMUD_API_LEVEL"/> for the currently used API level.
/// </summary>
public int DalamudApiLevel { get; set; }
/// <summary>
/// The number of downloads this plugin has.
/// Gets or sets the number of downloads this plugin has.
/// </summary>
public long DownloadCount { get; set; }
/// <summary>
/// The last time this plugin was updated.
/// Gets or sets the last time this plugin was updated.
/// </summary>
public long LastUpdate { get; set; }
/// <summary>
/// Number of the repo.
/// Gets or sets the index of the third party repo.
/// </summary>
public int RepoNumber { get; set; }
/// <summary>
/// Download link used to install the plugin.
/// Gets or sets the download link used to install the plugin.
/// </summary>
public string DownloadLinkInstall { get; set; }
/// <summary>
/// Download link used to update the plugin.
/// Gets or sets the download link used to update the plugin.
/// </summary>
public string DownloadLinkUpdate { get; set; }
/// <summary>
/// Download link used to get testing versions of the plugin.
/// Gets or sets the download link used to get testing versions of the plugin.
/// </summary>
public string DownloadLinkTesting { get; set; }
/// <summary>
/// Load priority for this plugin. Higher values means higher priority. 0 is default priority.
/// Gets or sets the load priority for this plugin. Higher values means higher priority. 0 is default priority.
/// </summary>
public int LoadPriority { get; set; }
}