ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Dalamud.Plugin.PluginDefinition.html
goat aceb905c82 docs: regenerate
2021-04-06 00:41:38 +02:00

747 lines
36 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class PluginDefinition
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PluginDefinition
">
<meta name="generator" content="docfx 2.56.6.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Plugin.PluginDefinition">
<h1 id="Dalamud_Plugin_PluginDefinition" data-uid="Dalamud.Plugin.PluginDefinition" class="text-break">Class PluginDefinition
</h1>
<div class="markdown level0 summary"><p>Class containing information about a plugin.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">PluginDefinition</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Plugin.html">Dalamud.Plugin</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Plugin_PluginDefinition_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PluginDefinition</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_ApplicableVersion.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.ApplicableVersion%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L52">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_ApplicableVersion_" data-uid="Dalamud.Plugin.PluginDefinition.ApplicableVersion*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_ApplicableVersion" data-uid="Dalamud.Plugin.PluginDefinition.ApplicableVersion">ApplicableVersion</h4>
<div class="markdown level1 summary"><p>Gets or sets the version of the game this plugin works with.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ApplicableVersion { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_AssemblyVersion.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.AssemblyVersion%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L32">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_AssemblyVersion_" data-uid="Dalamud.Plugin.PluginDefinition.AssemblyVersion*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_AssemblyVersion" data-uid="Dalamud.Plugin.PluginDefinition.AssemblyVersion">AssemblyVersion</h4>
<div class="markdown level1 summary"><p>Gets or sets the current assembly version of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AssemblyVersion { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_Author.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.Author%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L17">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_Author_" data-uid="Dalamud.Plugin.PluginDefinition.Author*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_Author" data-uid="Dalamud.Plugin.PluginDefinition.Author">Author</h4>
<div class="markdown level1 summary"><p>Gets or sets the author/s of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Author { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_DalamudApiLevel.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.DalamudApiLevel%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L72">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_DalamudApiLevel_" data-uid="Dalamud.Plugin.PluginDefinition.DalamudApiLevel*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_DalamudApiLevel" data-uid="Dalamud.Plugin.PluginDefinition.DalamudApiLevel">DalamudApiLevel</h4>
<div class="markdown level1 summary"><p>Gets or sets the API level of this plugin. For the current API level, please see <span class="xref">Dalamud.Plugin.PluginManager.DalamudApiLevel</span> for the currently used API level.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int DalamudApiLevel { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_Description.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.Description%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L47">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_Description_" data-uid="Dalamud.Plugin.PluginDefinition.Description*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_Description" data-uid="Dalamud.Plugin.PluginDefinition.Description">Description</h4>
<div class="markdown level1 summary"><p>Gets or sets a description of the plugins functions.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Description { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_DownloadCount.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.DownloadCount%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L77">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_DownloadCount_" data-uid="Dalamud.Plugin.PluginDefinition.DownloadCount*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_DownloadCount" data-uid="Dalamud.Plugin.PluginDefinition.DownloadCount">DownloadCount</h4>
<div class="markdown level1 summary"><p>Gets or sets the number of downloads this plugin has.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long DownloadCount { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_DownloadLinkInstall.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.DownloadLinkInstall%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L92">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_DownloadLinkInstall_" data-uid="Dalamud.Plugin.PluginDefinition.DownloadLinkInstall*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_DownloadLinkInstall" data-uid="Dalamud.Plugin.PluginDefinition.DownloadLinkInstall">DownloadLinkInstall</h4>
<div class="markdown level1 summary"><p>Gets or sets the download link used to install the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string DownloadLinkInstall { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_DownloadLinkTesting.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.DownloadLinkTesting%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L102">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_DownloadLinkTesting_" data-uid="Dalamud.Plugin.PluginDefinition.DownloadLinkTesting*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_DownloadLinkTesting" data-uid="Dalamud.Plugin.PluginDefinition.DownloadLinkTesting">DownloadLinkTesting</h4>
<div class="markdown level1 summary"><p>Gets or sets the download link used to get testing versions of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string DownloadLinkTesting { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_DownloadLinkUpdate.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.DownloadLinkUpdate%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L97">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_DownloadLinkUpdate_" data-uid="Dalamud.Plugin.PluginDefinition.DownloadLinkUpdate*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_DownloadLinkUpdate" data-uid="Dalamud.Plugin.PluginDefinition.DownloadLinkUpdate">DownloadLinkUpdate</h4>
<div class="markdown level1 summary"><p>Gets or sets the download link used to update the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string DownloadLinkUpdate { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_InternalName.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.InternalName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L27">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_InternalName_" data-uid="Dalamud.Plugin.PluginDefinition.InternalName*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_InternalName" data-uid="Dalamud.Plugin.PluginDefinition.InternalName">InternalName</h4>
<div class="markdown level1 summary"><p>Gets or sets the internal name of the plugin, which should match the assembly name of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string InternalName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_IsHide.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.IsHide%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L67">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_IsHide_" data-uid="Dalamud.Plugin.PluginDefinition.IsHide*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_IsHide" data-uid="Dalamud.Plugin.PluginDefinition.IsHide">IsHide</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether or not the plugin is hidden in the plugin installer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsHide { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_IsTestingExclusive.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.IsTestingExclusive%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L42">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_IsTestingExclusive_" data-uid="Dalamud.Plugin.PluginDefinition.IsTestingExclusive*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_IsTestingExclusive" data-uid="Dalamud.Plugin.PluginDefinition.IsTestingExclusive">IsTestingExclusive</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the plugin is only available for testing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsTestingExclusive { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_LastUpdate.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.LastUpdate%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L82">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_LastUpdate_" data-uid="Dalamud.Plugin.PluginDefinition.LastUpdate*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_LastUpdate" data-uid="Dalamud.Plugin.PluginDefinition.LastUpdate">LastUpdate</h4>
<div class="markdown level1 summary"><p>Gets or sets the last time this plugin was updated.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long LastUpdate { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_LoadPriority.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.LoadPriority%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L107">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_LoadPriority_" data-uid="Dalamud.Plugin.PluginDefinition.LoadPriority*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_LoadPriority" data-uid="Dalamud.Plugin.PluginDefinition.LoadPriority">LoadPriority</h4>
<div class="markdown level1 summary"><p>Gets or sets the load priority for this plugin. Higher values means higher priority. 0 is default priority.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LoadPriority { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_Name.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L22">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_Name_" data-uid="Dalamud.Plugin.PluginDefinition.Name*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_Name" data-uid="Dalamud.Plugin.PluginDefinition.Name">Name</h4>
<div class="markdown level1 summary"><p>Gets or sets the public name of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_RepoNumber.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.RepoNumber%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L87">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_RepoNumber_" data-uid="Dalamud.Plugin.PluginDefinition.RepoNumber*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_RepoNumber" data-uid="Dalamud.Plugin.PluginDefinition.RepoNumber">RepoNumber</h4>
<div class="markdown level1 summary"><p>Gets or sets the index of the third party repo.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int RepoNumber { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_RepoUrl.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.RepoUrl%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L57">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_RepoUrl_" data-uid="Dalamud.Plugin.PluginDefinition.RepoUrl*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_RepoUrl" data-uid="Dalamud.Plugin.PluginDefinition.RepoUrl">RepoUrl</h4>
<div class="markdown level1 summary"><p>Gets or sets an URL to the website or source code of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string RepoUrl { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_Tags.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.Tags%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L62">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_Tags_" data-uid="Dalamud.Plugin.PluginDefinition.Tags*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_Tags" data-uid="Dalamud.Plugin.PluginDefinition.Tags">Tags</h4>
<div class="markdown level1 summary"><p>Gets or sets a list of tags defined on the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;string&gt; Tags { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition_TestingAssemblyVersion.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition.TestingAssemblyVersion%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L37">View Source</a>
</span>
<a id="Dalamud_Plugin_PluginDefinition_TestingAssemblyVersion_" data-uid="Dalamud.Plugin.PluginDefinition.TestingAssemblyVersion*"></a>
<h4 id="Dalamud_Plugin_PluginDefinition_TestingAssemblyVersion" data-uid="Dalamud.Plugin.PluginDefinition.TestingAssemblyVersion">TestingAssemblyVersion</h4>
<div class="markdown level1 summary"><p>Gets or sets the current testing assembly version of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string TestingAssemblyVersion { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_PluginDefinition.md&amp;value=---%0Auid%3A%20Dalamud.Plugin.PluginDefinition%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Plugin/PluginDefinition.cs/#L12" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink