You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
728 lines
37 KiB
728 lines
37 KiB
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class PluginMetadata
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class PluginMetadata
|
|
">
|
|
<meta name="generator" content="docfx 2.56.2.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">
|
|
<link rel="stylesheet" href="../styles/fix.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
<meta property="docfx:newtab" content="true">
|
|
</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 class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list"></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination"></ul>
|
|
</div>
|
|
</div>
|
|
<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="IPA.Loader.PluginMetadata">
|
|
|
|
|
|
<h1 id="IPA_Loader_PluginMetadata" data-uid="IPA.Loader.PluginMetadata" class="text-break">Class PluginMetadata
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>A class which describes a loaded plugin.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
|
|
<div class="level1"><span class="xref">PluginMetadata</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
|
|
<h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
|
|
<h5 id="IPA_Loader_PluginMetadata_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class PluginMetadata</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Assembly.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Assembly%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L26">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_Assembly_" data-uid="IPA.Loader.PluginMetadata.Assembly*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_Assembly" data-uid="IPA.Loader.PluginMetadata.Assembly">Assembly</h4>
|
|
<div class="markdown level1 summary"><p>The assembly the plugin was loaded from.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Assembly Assembly { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.reflection.assembly">Assembly</a></td>
|
|
<td><p>the loaded Assembly that contains the plugin main type</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_AssociatedFiles.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.AssociatedFiles%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L87">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_AssociatedFiles_" data-uid="IPA.Loader.PluginMetadata.AssociatedFiles*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_AssociatedFiles" data-uid="IPA.Loader.PluginMetadata.AssociatedFiles">AssociatedFiles</h4>
|
|
<div class="markdown level1 summary"><p>A list of files (that aren't <a class="xref" href="IPA.Loader.PluginMetadata.html#IPA_Loader_PluginMetadata_File">File</a>) that are associated with this plugin.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IReadOnlyList<FileInfo> AssociatedFiles { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a>></td>
|
|
<td><p>a list of associated files</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Author.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L50">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_Author_" data-uid="IPA.Loader.PluginMetadata.Author*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_Author" data-uid="IPA.Loader.PluginMetadata.Author">Author</h4>
|
|
<div class="markdown level1 summary"><p>The name of the author that wrote this 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; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><p>the name of the plugin's author</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Description.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L56">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_Description_" data-uid="IPA.Loader.PluginMetadata.Description*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_Description" data-uid="IPA.Loader.PluginMetadata.Description">Description</h4>
|
|
<div class="markdown level1 summary"><p>The description of this 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 Description { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><p>the description of the plugin</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_DonateLink.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.DonateLink%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L110">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_DonateLink_" data-uid="IPA.Loader.PluginMetadata.DonateLink*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_DonateLink" data-uid="IPA.Loader.PluginMetadata.DonateLink">DonateLink</h4>
|
|
<div class="markdown level1 summary"><p>A link to a donate page for the author of this plugin, if avaliable.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Uri DonateLink { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.uri">Uri</a></td>
|
|
<td><p>the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.uri">Uri</a> of the author's donate page</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Features.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Features%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L75">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_Features_" data-uid="IPA.Loader.PluginMetadata.Features*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_Features" data-uid="IPA.Loader.PluginMetadata.Features">Features</h4>
|
|
<div class="markdown level1 summary"><p>The features this plugin requests.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IReadOnlyList<Feature> Features { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a><<a class="xref" href="IPA.Loader.Features.Feature.html">Feature</a>></td>
|
|
<td><p>the list of features requested by the plugin</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_File.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.File%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L68">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_File_" data-uid="IPA.Loader.PluginMetadata.File*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_File" data-uid="IPA.Loader.PluginMetadata.File">File</h4>
|
|
<div class="markdown level1 summary"><p>The file the plugin was loaded from.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public FileInfo File { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
|
|
<td><p>the file the plugin was loaded from</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_IconName.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.IconName%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L93">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_IconName_" data-uid="IPA.Loader.PluginMetadata.IconName*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_IconName" data-uid="IPA.Loader.PluginMetadata.IconName">IconName</h4>
|
|
<div class="markdown level1 summary"><p>The name of the resource in the plugin assembly containing the plugin's icon.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string IconName { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><p>the name of the plugin's icon</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Id.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Id%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L44">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_Id_" data-uid="IPA.Loader.PluginMetadata.Id*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_Id" data-uid="IPA.Loader.PluginMetadata.Id">Id</h4>
|
|
<div class="markdown level1 summary"><p>The BeatMods ID of the plugin, or null if it doesn't have one.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Id { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><p>the updater ID of the plugin</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_IsBare.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.IsBare%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L118">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_IsBare_" data-uid="IPA.Loader.PluginMetadata.IsBare*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_IsBare" data-uid="IPA.Loader.PluginMetadata.IsBare">IsBare</h4>
|
|
<div class="markdown level1 summary"><p>Whether or not this metadata object represents a bare manifest.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsBare { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><p><span class="xref">true</span> if it is bare, <span class="xref">false</span> otherwise</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Name.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L38">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_Name_" data-uid="IPA.Loader.PluginMetadata.Name*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_Name" data-uid="IPA.Loader.PluginMetadata.Name">Name</h4>
|
|
<div class="markdown level1 summary"><p>The human readable 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; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><p>the name of the plugin</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_PluginHomeLink.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.PluginHomeLink%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L99">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_PluginHomeLink_" data-uid="IPA.Loader.PluginMetadata.PluginHomeLink*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_PluginHomeLink" data-uid="IPA.Loader.PluginMetadata.PluginHomeLink">PluginHomeLink</h4>
|
|
<div class="markdown level1 summary"><p>A link to this plugin's home page, if any.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Uri PluginHomeLink { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.uri">Uri</a></td>
|
|
<td><p>the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.uri">Uri</a> of the plugin's home page</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_PluginSourceLink.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.PluginSourceLink%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L105">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_PluginSourceLink_" data-uid="IPA.Loader.PluginMetadata.PluginSourceLink*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_PluginSourceLink" data-uid="IPA.Loader.PluginMetadata.PluginSourceLink">PluginSourceLink</h4>
|
|
<div class="markdown level1 summary"><p>A link to this plugin's source code, if avaliable.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Uri PluginSourceLink { get; }</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><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.uri">Uri</a></td>
|
|
<td><p>the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.uri">Uri</a> of the plugin's source code</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_PluginType.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.PluginType%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L32">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_PluginType_" data-uid="IPA.Loader.PluginMetadata.PluginType*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_PluginType" data-uid="IPA.Loader.PluginMetadata.PluginType">PluginType</h4>
|
|
<div class="markdown level1 summary"><p>The TypeDefinition for the main type 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 TypeDefinition PluginType { get; }</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">Mono.Cecil.TypeDefinition</span></td>
|
|
<td><p>the Cecil definition for the plugin main type</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_RuntimeOptions.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.RuntimeOptions%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L140">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_RuntimeOptions_" data-uid="IPA.Loader.PluginMetadata.RuntimeOptions*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_RuntimeOptions" data-uid="IPA.Loader.PluginMetadata.RuntimeOptions">RuntimeOptions</h4>
|
|
<div class="markdown level1 summary"><p>The <a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a> that the plugin specified in its <a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public RuntimeOptions RuntimeOptions { get; }</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><a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_Version.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.Version%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L62">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_Version_" data-uid="IPA.Loader.PluginMetadata.Version*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_Version" data-uid="IPA.Loader.PluginMetadata.Version">Version</h4>
|
|
<div class="markdown level1 summary"><p>The 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 Version Version { get; }</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">SemVer.Version</span></td>
|
|
<td><p>the version of the plugin</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata_ToString.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata.ToString%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L146">View Source</a>
|
|
</span>
|
|
<a id="IPA_Loader_PluginMetadata_ToString_" data-uid="IPA.Loader.PluginMetadata.ToString*"></a>
|
|
<h4 id="IPA_Loader_PluginMetadata_ToString" data-uid="IPA.Loader.PluginMetadata.ToString">ToString()</h4>
|
|
<div class="markdown level1 summary"><p>Gets all of the metadata as a readable string.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
|
|
<td><p>the readable printable metadata string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a></div>
|
|
<h3 id="extensionmethods">Extension Methods</h3>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod<U, T>(T, String, Object[])</a>
|
|
</div>
|
|
</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/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginMetadata.md&value=---%0Auid%3A%20IPA.Loader.PluginMetadata%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/bsmg/BeatSaber-IPA-Reloaded/blob/ec36037b38fcfffd4ac587497e47c2c3934c9859/IPA.Loader/Loader/PluginMetadata.cs/#L20" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</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>
|