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

209 lines
10 KiB
Raw Normal View History

Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- Allowed failures building .NET 3 in CI
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- ReflectionUtil documentation
4 years ago
​
​
Generated Docs (4.0.0-beta) -- Changed working dir
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs (4.0.0-beta) -- Allowed failures building .NET 3 in CI
4 years ago
Generated Docs (4.0.0-beta) -- Changed working dir
4 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.48.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.IDisablablePlugin">
  82.   
  83.   
  84.   <h1 id="IPA_IDisablablePlugin" data-uid="IPA.IDisablablePlugin" class="text-break">Interface IDisablablePlugin
  85.   </h1>
  86.   <div class="markdown level0 summary"><p>Provides methods to allow runtime disabling of a plugin.</p>
  87. </div>
  88.   <div class="markdown level0 conceptual"></div>
  89.   <div class="inheritedMembers">
  90.     <h5>Inherited Members</h5>
  91.     <div>
  92.       <a class="xref" href="IPA.IPlugin.html#IPA_IPlugin_OnEnable">IPlugin.OnEnable()</a>
  93.     </div>
  94.     <div>
  95.       <a class="xref" href="IPA.IPlugin.html#IPA_IPlugin_OnApplicationQuit">IPlugin.OnApplicationQuit()</a>
  96.     </div>
  97.     <div>
  98.       <a class="xref" href="IPA.IPlugin.html#IPA_IPlugin_OnSceneLoaded_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_LoadSceneMode_">IPlugin.OnSceneLoaded(Scene, LoadSceneMode)</a>
  99.     </div>
  100.     <div>
  101.       <a class="xref" href="IPA.IPlugin.html#IPA_IPlugin_OnSceneUnloaded_UnityEngine_SceneManagement_Scene_">IPlugin.OnSceneUnloaded(Scene)</a>
  102.     </div>
  103.     <div>
  104.       <a class="xref" href="IPA.IPlugin.html#IPA_IPlugin_OnActiveSceneChanged_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_Scene_">IPlugin.OnActiveSceneChanged(Scene, Scene)</a>
  105.     </div>
  106.   </div>
  107.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>
  108.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  109.   <h5 id="IPA_IDisablablePlugin_syntax">Syntax</h5>
  110.   <div class="codewrapper">
  111.     <pre><code class="lang-csharp hljs">[Obsolete(&quot;Use the attribute-based system instead.&quot;)]
  112. public interface IDisablablePlugin : IPlugin</code></pre>
  113.   </div>
  114.   <h3 id="methods">Methods
  115.   </h3>
  116.   <span class="small pull-right mobile-hide">
  117.     <span class="divider">|</span>
  118.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/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>
  119.   </span>
  120.   <span class="small pull-right mobile-hide">
  121.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/674742a4156d8375ece0cb7bf8a48df6d5ebc7de/IPA.Loader/PluginInterfaces/BeatSaber/IDisablablePlugin.cs/#L20">View Source</a>
  122.   </span>
  123.   <a id="IPA_IDisablablePlugin_OnDisable_" data-uid="IPA.IDisablablePlugin.OnDisable*"></a>
  124.   <h4 id="IPA_IDisablablePlugin_OnDisable" data-uid="IPA.IDisablablePlugin.OnDisable">OnDisable()</h4>
  125.   <div class="markdown level1 summary"><p>Called when a plugin is disabled at runtime. This should disable things like Harmony patches and unsubscribe
  126. from events. After this is called there should be no lingering effects of the mod.</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">void OnDisable()</code></pre>
  132.   </div>
  133.   <h5 id="IPA_IDisablablePlugin_OnDisable_remarks">Remarks</h5>
  134.   <div class="markdown level1 remarks"><p>This will get called at shutdown, after <a class="xref" href="IPA.IPlugin.html#IPA_IPlugin_OnApplicationQuit">OnApplicationQuit()</a>, as well as when the
  135. plugin is disabled at runtime.</p>
  136. </div>
  137.   <h3 id="extensionmethods">Extension Methods</h3>
  138.   <div>
  139.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField_System_Object_System_String_System_Object_">ReflectionUtil.SetField(Object, String, Object)</a>
  140.   </div>
  141.   <div>
  142.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__1___0_System_String_System_Object_">ReflectionUtil.SetField&lt;T&gt;(T, String, Object)</a>
  143.   </div>
  144.   <div>
  145.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__1_System_Object_System_String_">ReflectionUtil.GetField&lt;T&gt;(Object, String)</a>
  146.   </div>
  147.   <div>
  148.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;T, U&gt;(U, String)</a>
  149.   </div>
  150.   <div>
  151.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetProperty(Object, String, Object)</a>
  152.   </div>
  153.   <div>
  154.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__1___0_System_String_System_Object_">ReflectionUtil.SetProperty&lt;T&gt;(T, String, Object)</a>
  155.   </div>
  156.   <div>
  157.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod(Object, String, Object[])</a>
  158.   </div>
  159.   <div>
  160.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1___0_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(T, String, Object[])</a>
  161.   </div>
  162.   <div>
  163.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(Object, String, Object[])</a>
  164.   </div>
  165.   <div>
  166.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T, U&gt;(U, String, Object[])</a>
  167.   </div>
  168. </article>
  169.           </div>
  170.           
  171.           <div class="hidden-sm col-md-2" role="complementary">
  172.             <div class="sideaffix">
  173.               <div class="contribution">
  174.                 <ul class="nav">
  175.                   <li>
  176.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/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>
  177.                   </li>
  178.                   <li>
  179.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/674742a4156d8375ece0cb7bf8a48df6d5ebc7de/IPA.Loader/PluginInterfaces/BeatSaber/IDisablablePlugin.cs/#L8" class="contribution-link">View Source</a>
  180.                   </li>
  181.                 </ul>
  182.               </div>
  183.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  184.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  185.               </nav>
  186.             </div>
  187.           </div>
  188.         </div>
  189.       </div>
  190.       
  191.       <footer>
  192.         <div class="grad-bottom"></div>
  193.         <div class="footer">
  194.           <div class="container">
  195.             <span class="pull-right">
  196.               <a href="#top">Back to top</a>
  197.             </span>
  198.             
  199.             <span>Generated by <strong>DocFX</strong></span>
  200.           </div>
  201.         </div>
  202.       </footer>
  203.     </div>
  204.     
  205.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  206.     <script type="text/javascript" src="../styles/docfx.js"></script>
  207.     <script type="text/javascript" src="../styles/main.js"></script>
  208.   </body>
  209. </html>