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.
6 Commits
9 Branches
808 MiB
Tree: 544d357104
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '544d357104'
${ noResults }
BeatSaber-IPA-Reloaded/api/IPA.ModsaberModInfo.html

236 lines
11 KiB
Raw Normal View History

i'm fuckin baaaaad -- Docs
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Removed material DocFX template in favor of DarkFX -- Docs
5 years ago
i'm fuckin baaaaad -- Docs
5 years ago
​
​
​
​
Removed material DocFX template in favor of DarkFX -- Docs
5 years ago
i'm fuckin baaaaad -- 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.42.4.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=Open+Sans" rel="stylesheet">
  20.     <meta property="docfx:navrel" content="../toc.html">
  21.     <meta property="docfx:tocrel" content="toc.html">
  22.     
  23.     
  24.     
  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 role="main" class="container body-content hide-when-search">
  62.         
  63.         <div class="sidenav hide-when-search">
  64.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65.           <div class="sidetoggle collapse" id="sidetoggle">
  66.             <div id="sidetoc"></div>
  67.           </div>
  68.         </div>
  69.         <div class="article row grid-right">
  70.           <div class="col-md-10">
  71.             <article class="content wrap" id="_content" data-uid="IPA.ModsaberModInfo">
  72.   
  73.   
  74.   <h1 id="IPA_ModsaberModInfo" data-uid="IPA.ModsaberModInfo" class="text-break">Class ModsaberModInfo
  75.   </h1>
  76.   <div class="markdown level0 summary"><p>A class to provide information about a mod on ModSaber.ML</p>
  77. </div>
  78.   <div class="markdown level0 conceptual"></div>
  79.   <div class="inheritance">
  80.     <h5>Inheritance</h5>
  81.     <div class="level0"><span class="xref">System.Object</span></div>
  82.     <div class="level1"><span class="xref">ModsaberModInfo</span></div>
  83.   </div>
  84.   <div class="inheritedMembers">
  85.     <h5>Inherited Members</h5>
  86.     <div>
  87.       <span class="xref">System.Object.ToString()</span>
  88.     </div>
  89.     <div>
  90.       <span class="xref">System.Object.Equals(System.Object)</span>
  91.     </div>
  92.     <div>
  93.       <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  94.     </div>
  95.     <div>
  96.       <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  97.     </div>
  98.     <div>
  99.       <span class="xref">System.Object.GetHashCode()</span>
  100.     </div>
  101.     <div>
  102.       <span class="xref">System.Object.GetType()</span>
  103.     </div>
  104.     <div>
  105.       <span class="xref">System.Object.MemberwiseClone()</span>
  106.     </div>
  107.   </div>
  108.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>
  109.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  110.   <h5 id="IPA_ModsaberModInfo_syntax">Syntax</h5>
  111.   <div class="codewrapper">
  112.     <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;)]
  113. public class ModsaberModInfo</code></pre>
  114.   </div>
  115.   <h3 id="properties">Properties
  116.   </h3>
  117.   <span class="small pull-right mobile-hide">
  118.     <span class="divider">|</span>
  119.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  120.   </span>
  121.   <span class="small pull-right mobile-hide">
  122.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L38">View Source</a>
  123.   </span>
  124.   <a id="IPA_ModsaberModInfo_CurrentVersion_" data-uid="IPA.ModsaberModInfo.CurrentVersion*"></a>
  125.   <h4 id="IPA_ModsaberModInfo_CurrentVersion" data-uid="IPA.ModsaberModInfo.CurrentVersion">CurrentVersion</h4>
  126.   <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>
  127. </div>
  128.   <div class="markdown level1 conceptual"></div>
  129.   <h5 class="decalaration">Declaration</h5>
  130.   <div class="codewrapper">
  131.     <pre><code class="lang-csharp hljs">public string CurrentVersion { get; set; }</code></pre>
  132.   </div>
  133.   <h5 class="propertyValue">Property Value</h5>
  134.   <table class="table table-bordered table-striped table-condensed">
  135.     <thead>
  136.       <tr>
  137.         <th>Type</th>
  138.         <th>Description</th>
  139.       </tr>
  140.     </thead>
  141.     <tbody>
  142.       <tr>
  143.         <td><span class="xref">System.String</span></td>
  144.         <td></td>
  145.       </tr>
  146.     </tbody>
  147.   </table>
  148.   <span class="small pull-right mobile-hide">
  149.     <span class="divider">|</span>
  150.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  151.   </span>
  152.   <span class="small pull-right mobile-hide">
  153.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L18">View Source</a>
  154.   </span>
  155.   <a id="IPA_ModsaberModInfo_InternalName_" data-uid="IPA.ModsaberModInfo.InternalName*"></a>
  156.   <h4 id="IPA_ModsaberModInfo_InternalName" data-uid="IPA.ModsaberModInfo.InternalName">InternalName</h4>
  157.   <div class="markdown level1 summary"><p>The name the mod uses on ModSaber as an identifier.</p>
  158. </div>
  159.   <div class="markdown level1 conceptual"></div>
  160.   <h5 class="decalaration">Declaration</h5>
  161.   <div class="codewrapper">
  162.     <pre><code class="lang-csharp hljs">public string InternalName { get; set; }</code></pre>
  163.   </div>
  164.   <h5 class="propertyValue">Property Value</h5>
  165.   <table class="table table-bordered table-striped table-condensed">
  166.     <thead>
  167.       <tr>
  168.         <th>Type</th>
  169.         <th>Description</th>
  170.       </tr>
  171.     </thead>
  172.     <tbody>
  173.       <tr>
  174.         <td><span class="xref">System.String</span></td>
  175.         <td></td>
  176.       </tr>
  177.     </tbody>
  178.   </table>
  179.   <h3 id="extensionmethods">Extension Methods</h3>
  180.   <div>
  181.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  182.   </div>
  183.   <div>
  184.       <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>
  185.   </div>
  186.   <div>
  187.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  188.   </div>
  189.   <div>
  190.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  191.   </div>
  192.   <div>
  193.       <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>
  194.   </div>
  195. </article>
  196.           </div>
  197.           
  198.           <div class="hidden-sm col-md-2" role="complementary">
  199.             <div class="sideaffix">
  200.               <div class="contribution">
  201.                 <ul class="nav">
  202.                   <li>
  203.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  204.                   </li>
  205.                   <li>
  206.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/ModsaberModInfo.cs/#L12" class="contribution-link">View Source</a>
  207.                   </li>
  208.                 </ul>
  209.               </div>
  210.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  211.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  212.               </nav>
  213.             </div>
  214.           </div>
  215.         </div>
  216.       </div>
  217.       
  218.       <footer>
  219.         <div class="grad-bottom"></div>
  220.         <div class="footer">
  221.           <div class="container">
  222.             <span class="pull-right">
  223.               <a href="#top">Back to top</a>
  224.             </span>
  225.             
  226.             <span>Generated by <strong>DocFX</strong></span>
  227.           </div>
  228.         </div>
  229.       </footer>
  230.     </div>
  231.     
  232.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  233.     <script type="text/javascript" src="../styles/docfx.js"></script>
  234.     <script type="text/javascript" src="../styles/main.js"></script>
  235.   </body>
  236. </html>