DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git
1
1
Fork 0
Code Issues 0 Projects 0 Releases 78 Wiki Activity
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.
36 Commits
9 Branches
188 MiB
Tree: 7cebd04aea
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7cebd04aea'
${ noResults }
BeatSaber-IPA-Reloaded/api/IPA.ModsaberModInfo.html

246 lines
12 KiB
Raw Normal View History

upgraded VS image -- Generated Docs
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Fixed Assemby version -- Generated Docs
5 years ago
upgraded VS image -- Generated Docs
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Fixed Assemby version -- Generated Docs
5 years ago
upgraded VS image -- Generated Docs
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Fixed Assemby version -- Generated Docs
5 years ago
upgraded VS image -- Generated Docs
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4.   
  5.   <head>
  6.     <meta charset="utf-8">
  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  8.     <title>Class ModsaberModInfo
  9.    </title>
  10.     <meta name="viewport" content="width=device-width">
  11.     <meta name="title" content="Class ModsaberModInfo
  12.    ">
  13.     <meta name="generator" content="docfx 2.43.0.0">
  14.     
  15.     <link rel="shortcut icon" href="../favicon.ico">
  16.     <link rel="stylesheet" href="../styles/docfx.vendor.css">
  17.     <link rel="stylesheet" href="../styles/docfx.css">
  18.     <link rel="stylesheet" href="../styles/main.css">
  19.     <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
  20.     <meta property="docfx:navrel" content="../toc.html">
  21.     <meta property="docfx:tocrel" content="toc.html">
  22.     
  23.     <meta property="docfx:rel" content="../">
  24.     <meta property="docfx:newtab" content="true">
  25.   </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
  26.     <div id="wrapper">
  27.       <header>
  28.         
  29.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  30.           <div class="container">
  31.             <div class="navbar-header">
  32.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  33.                 <span class="sr-only">Toggle navigation</span>
  34.                 <span class="icon-bar"></span>
  35.                 <span class="icon-bar"></span>
  36.                 <span class="icon-bar"></span>
  37.               </button>
  38.               
  39.               <a class="navbar-brand" href="../index.html">
  40.                 <img id="logo" class="svg" src="../logo.svg" alt="">
  41.               </a>
  42.             </div>
  43.             <div class="collapse navbar-collapse" id="navbar">
  44.               <form class="navbar-form navbar-right" role="search" id="search">
  45.                 <div class="form-group">
  46.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  47.                 </div>
  48.               </form>
  49.             </div>
  50.           </div>
  51.         </nav>
  52.         
  53.         <div class="subnav navbar navbar-default">
  54.           <div class="container hide-when-search" id="breadcrumb">
  55.             <ul class="breadcrumb">
  56.               <li></li>
  57.             </ul>
  58.           </div>
  59.         </div>
  60.       </header>
  61.       <div class="container body-content">
  62.         
  63.         <div id="search-results">
  64.           <div class="search-list"></div>
  65.           <div class="sr-items">
  66.             <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  67.           </div>
  68.           <ul id="pagination"></ul>
  69.         </div>
  70.       </div>
  71.       <div role="main" class="container body-content hide-when-search">
  72.         
  73.         <div class="sidenav hide-when-search">
  74.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  75.           <div class="sidetoggle collapse" id="sidetoggle">
  76.             <div id="sidetoc"></div>
  77.           </div>
  78.         </div>
  79.         <div class="article row grid-right">
  80.           <div class="col-md-10">
  81.             <article class="content wrap" id="_content" data-uid="IPA.ModsaberModInfo">
  82.   
  83.   
  84.   <h1 id="IPA_ModsaberModInfo" data-uid="IPA.ModsaberModInfo" class="text-break">Class ModsaberModInfo
  85.   </h1>
  86.   <div class="markdown level0 summary"><p>A class to provide information about a mod on ModSaber.ML</p>
  87. </div>
  88.   <div class="markdown level0 conceptual"></div>
  89.   <div class="inheritance">
  90.     <h5>Inheritance</h5>
  91.     <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  92.     <div class="level1"><span class="xref">ModsaberModInfo</span></div>
  93.   </div>
  94.   <div class="inheritedMembers">
  95.     <h5>Inherited Members</h5>
  96.     <div>
  97.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  98.     </div>
  99.     <div>
  100.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  101.     </div>
  102.     <div>
  103.       <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>
  104.     </div>
  105.     <div>
  106.       <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>
  107.     </div>
  108.     <div>
  109.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  110.     </div>
  111.     <div>
  112.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  113.     </div>
  114.     <div>
  115.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  116.     </div>
  117.   </div>
  118.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>
  119.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  120.   <h5 id="IPA_ModsaberModInfo_syntax">Syntax</h5>
  121.   <div class="codewrapper">
  122.     <pre><code class="lang-csharp hljs">[Obsolete(&quot;This is unused, and has been since the manifest was introduced. All functionality is provided by the manifest.&quot;)]
  123. public class ModsaberModInfo</code></pre>
  124.   </div>
  125.   <h3 id="properties">Properties
  126.   </h3>
  127.   <span class="small pull-right mobile-hide">
  128.     <span class="divider">|</span>
  129.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_ModsaberModInfo_CurrentVersion.md&amp;value=---%0Auid%3A%20IPA.ModsaberModInfo.CurrentVersion%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>
  130.   </span>
  131.   <span class="small pull-right mobile-hide">
  132.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7c7ba452c300fa8c9d02ceb20f9d33b0cc5ab329/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L38">View Source</a>
  133.   </span>
  134.   <a id="IPA_ModsaberModInfo_CurrentVersion_" data-uid="IPA.ModsaberModInfo.CurrentVersion*"></a>
  135.   <h4 id="IPA_ModsaberModInfo_CurrentVersion" data-uid="IPA.ModsaberModInfo.CurrentVersion">CurrentVersion</h4>
  136.   <div class="markdown level1 summary"><p>The version of the currently installed mod. Used to compare to the version on ModSaber. Should be a valid SemVer version.</p>
  137. </div>
  138.   <div class="markdown level1 conceptual"></div>
  139.   <h5 class="decalaration">Declaration</h5>
  140.   <div class="codewrapper">
  141.     <pre><code class="lang-csharp hljs">public string CurrentVersion { get; set; }</code></pre>
  142.   </div>
  143.   <h5 class="propertyValue">Property Value</h5>
  144.   <table class="table table-bordered table-striped table-condensed">
  145.     <thead>
  146.       <tr>
  147.         <th>Type</th>
  148.         <th>Description</th>
  149.       </tr>
  150.     </thead>
  151.     <tbody>
  152.       <tr>
  153.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  154.         <td></td>
  155.       </tr>
  156.     </tbody>
  157.   </table>
  158.   <span class="small pull-right mobile-hide">
  159.     <span class="divider">|</span>
  160.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_ModsaberModInfo_InternalName.md&amp;value=---%0Auid%3A%20IPA.ModsaberModInfo.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>
  161.   </span>
  162.   <span class="small pull-right mobile-hide">
  163.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7c7ba452c300fa8c9d02ceb20f9d33b0cc5ab329/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L18">View Source</a>
  164.   </span>
  165.   <a id="IPA_ModsaberModInfo_InternalName_" data-uid="IPA.ModsaberModInfo.InternalName*"></a>
  166.   <h4 id="IPA_ModsaberModInfo_InternalName" data-uid="IPA.ModsaberModInfo.InternalName">InternalName</h4>
  167.   <div class="markdown level1 summary"><p>The name the mod uses on ModSaber as an identifier.</p>
  168. </div>
  169.   <div class="markdown level1 conceptual"></div>
  170.   <h5 class="decalaration">Declaration</h5>
  171.   <div class="codewrapper">
  172.     <pre><code class="lang-csharp hljs">public string InternalName { get; set; }</code></pre>
  173.   </div>
  174.   <h5 class="propertyValue">Property Value</h5>
  175.   <table class="table table-bordered table-striped table-condensed">
  176.     <thead>
  177.       <tr>
  178.         <th>Type</th>
  179.         <th>Description</th>
  180.       </tr>
  181.     </thead>
  182.     <tbody>
  183.       <tr>
  184.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  185.         <td></td>
  186.       </tr>
  187.     </tbody>
  188.   </table>
  189.   <h3 id="extensionmethods">Extension Methods</h3>
  190.   <div>
  191.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  192.   </div>
  193.   <div>
  194.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetPrivateField__1_System_Object_System_String_">ReflectionUtil.GetPrivateField&lt;T&gt;(Object, String)</a>
  195.   </div>
  196.   <div>
  197.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  198.   </div>
  199.   <div>
  200.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  201.   </div>
  202.   <div>
  203.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod&lt;T&gt;(Object, String, Object[])</a>
  204.   </div>
  205. </article>
  206.           </div>
  207.           
  208.           <div class="hidden-sm col-md-2" role="complementary">
  209.             <div class="sideaffix">
  210.               <div class="contribution">
  211.                 <ul class="nav">
  212.                   <li>
  213.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_ModsaberModInfo.md&amp;value=---%0Auid%3A%20IPA.ModsaberModInfo%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>
  214.                   </li>
  215.                   <li>
  216.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7c7ba452c300fa8c9d02ceb20f9d33b0cc5ab329/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L12" class="contribution-link">View Source</a>
  217.                   </li>
  218.                 </ul>
  219.               </div>
  220.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  221.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  222.               </nav>
  223.             </div>
  224.           </div>
  225.         </div>
  226.       </div>
  227.       
  228.       <footer>
  229.         <div class="grad-bottom"></div>
  230.         <div class="footer">
  231.           <div class="container">
  232.             <span class="pull-right">
  233.               <a href="#top">Back to top</a>
  234.             </span>
  235.             
  236.             <span>Generated by <strong>DocFX</strong></span>
  237.           </div>
  238.         </div>
  239.       </footer>
  240.     </div>
  241.     
  242.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  243.     <script type="text/javascript" src="../styles/docfx.js"></script>
  244.     <script type="text/javascript" src="../styles/main.js"></script>
  245.   </body>
  246. </html>