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.
4 Commits
9 Branches
355 MiB
Tree: 5cd77a9f4f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '5cd77a9f4f'
${ noResults }
BeatSaber-IPA-Reloaded/api/IPA.IDisablablePlugin.html

186 lines
9.6 KiB
Raw Normal View History

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>Interface IDisablablePlugin
  9.    </title>
  10.     <meta name="viewport" content="width=device-width">
  11.     <meta name="title" content="Interface IDisablablePlugin
  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.     <meta property="docfx:navrel" content="../toc.html">
  20.     <meta property="docfx:tocrel" content="toc.html">
  21.     
  22.     
  23.     
  24.   </head>
  25.   <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.IDisablablePlugin">
  72.   
  73.   
  74.   <h1 id="IPA_IDisablablePlugin" data-uid="IPA.IDisablablePlugin" class="text-break">Interface IDisablablePlugin
  75.   </h1>
  76.   <div class="markdown level0 summary"><p>Provides methods to allow runtime enabling and disabling of a plugin.</p>
  77. </div>
  78.   <div class="markdown level0 conceptual"></div>
  79.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>
  80.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  81.   <h5 id="IPA_IDisablablePlugin_syntax">Syntax</h5>
  82.   <div class="codewrapper">
  83.     <pre><code class="lang-csharp hljs">public interface IDisablablePlugin</code></pre>
  84.   </div>
  85.   <h3 id="methods">Methods
  86.   </h3>
  87.   <span class="small pull-right mobile-hide">
  88.     <span class="divider">|</span>
  89.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_IDisablablePlugin_OnDisable.md&amp;value=---%0Auid%3A%20IPA.IDisablablePlugin.OnDisable%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>
  90.   </span>
  91.   <span class="small pull-right mobile-hide">
  92.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/IDisablablePlugin.cs/#L27">View Source</a>
  93.   </span>
  94.   <a id="IPA_IDisablablePlugin_OnDisable_" data-uid="IPA.IDisablablePlugin.OnDisable*"></a>
  95.   <h4 id="IPA_IDisablablePlugin_OnDisable" data-uid="IPA.IDisablablePlugin.OnDisable">OnDisable()</h4>
  96.   <div class="markdown level1 summary"><p>Called when a plugin is disabled at runtime. This should disable things like Harmony patches and unsubscribe
  97. from events. After this is called there should be no lingering effects of the mod.</p>
  98. </div>
  99.   <div class="markdown level1 conceptual"></div>
  100.   <h5 class="decalaration">Declaration</h5>
  101.   <div class="codewrapper">
  102.     <pre><code class="lang-csharp hljs">void OnDisable()</code></pre>
  103.   </div>
  104.   <h5 id="IPA_IDisablablePlugin_OnDisable_remarks">Remarks</h5>
  105.   <div class="markdown level1 remarks"><p>This will get called at shutdown, after <a class="xref" href="IPA.IBeatSaberPlugin.html#IPA_IBeatSaberPlugin_OnApplicationQuit">OnApplicationQuit()</a>, as well as when the
  106. plugin is disabled at runtime.</p>
  107. </div>
  108.   <span class="small pull-right mobile-hide">
  109.     <span class="divider">|</span>
  110.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_IDisablablePlugin_OnEnable.md&amp;value=---%0Auid%3A%20IPA.IDisablablePlugin.OnEnable%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>
  111.   </span>
  112.   <span class="small pull-right mobile-hide">
  113.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/IDisablablePlugin.cs/#L17">View Source</a>
  114.   </span>
  115.   <a id="IPA_IDisablablePlugin_OnEnable_" data-uid="IPA.IDisablablePlugin.OnEnable*"></a>
  116.   <h4 id="IPA_IDisablablePlugin_OnEnable" data-uid="IPA.IDisablablePlugin.OnEnable">OnEnable()</h4>
  117.   <div class="markdown level1 summary"><p>Called when a plugin is enabled. This is where you should set up Harmony patches and the like.</p>
  118. </div>
  119.   <div class="markdown level1 conceptual"></div>
  120.   <h5 class="decalaration">Declaration</h5>
  121.   <div class="codewrapper">
  122.     <pre><code class="lang-csharp hljs">void OnEnable()</code></pre>
  123.   </div>
  124.   <h5 id="IPA_IDisablablePlugin_OnEnable_remarks">Remarks</h5>
  125.   <div class="markdown level1 remarks"><p>This will be called after Init, and will be called when the plugin loads normally too.
  126. When a plugin is disabled at startup, neither this nor Init will be called until it is enabled.</p>
  127. <p>Init will only ever be called once.</p>
  128. </div>
  129.   <h3 id="extensionmethods">Extension Methods</h3>
  130.   <div>
  131.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  132.   </div>
  133.   <div>
  134.       <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>
  135.   </div>
  136.   <div>
  137.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  138.   </div>
  139.   <div>
  140.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  141.   </div>
  142.   <div>
  143.       <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>
  144.   </div>
  145. </article>
  146.           </div>
  147.           
  148.           <div class="hidden-sm col-md-2" role="complementary">
  149.             <div class="sideaffix">
  150.               <div class="contribution">
  151.                 <ul class="nav">
  152.                   <li>
  153.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_IDisablablePlugin.md&amp;value=---%0Auid%3A%20IPA.IDisablablePlugin%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>
  154.                   </li>
  155.                   <li>
  156.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/BeatSaber/IDisablablePlugin.cs/#L6" class="contribution-link">View Source</a>
  157.                   </li>
  158.                 </ul>
  159.               </div>
  160.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  161.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  162.               </nav>
  163.             </div>
  164.           </div>
  165.         </div>
  166.       </div>
  167.       
  168.       <footer>
  169.         <div class="grad-bottom"></div>
  170.         <div class="footer">
  171.           <div class="container">
  172.             <span class="pull-right">
  173.               <a href="#top">Back to top</a>
  174.             </span>
  175.             
  176.             <span>Generated by <strong>DocFX</strong></span>
  177.           </div>
  178.         </div>
  179.       </footer>
  180.     </div>
  181.     
  182.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  183.     <script type="text/javascript" src="../styles/docfx.js"></script>
  184.     <script type="text/javascript" src="../styles/main.js"></script>
  185.   </body>
  186. </html>