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.

234 lines
11 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Interface IEnhancedPlugin
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IEnhancedPlugin
  11. ">
  12. <meta name="generator" content="docfx 2.43.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../">
  21. <meta property="docfx:newtab" content="true">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../index.html">
  35. <img id="logo" class="svg" src="../logo.svg" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list"></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="IPA.Old.IEnhancedPlugin">
  74. <h1 id="IPA_Old_IEnhancedPlugin" data-uid="IPA.Old.IEnhancedPlugin" class="text-break">Interface IEnhancedPlugin
  75. </h1>
  76. <div class="markdown level0 summary"><p>An enhanced version of the standard IPA plugin.</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritedMembers">
  80. <h5>Inherited Members</h5>
  81. <div>
  82. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_Name">IPlugin.Name</a>
  83. </div>
  84. <div>
  85. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_Version">IPlugin.Version</a>
  86. </div>
  87. <div>
  88. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_OnApplicationStart">IPlugin.OnApplicationStart()</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_OnApplicationQuit">IPlugin.OnApplicationQuit()</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_OnLevelWasLoaded_System_Int32_">IPlugin.OnLevelWasLoaded(Int32)</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_OnLevelWasInitialized_System_Int32_">IPlugin.OnLevelWasInitialized(Int32)</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_OnUpdate">IPlugin.OnUpdate()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="IPA.Old.IPlugin.html#IPA_Old_IPlugin_OnFixedUpdate">IPlugin.OnFixedUpdate()</a>
  104. </div>
  105. </div>
  106. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Old.html">IPA.Old</a></h6>
  107. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  108. <h5 id="IPA_Old_IEnhancedPlugin_syntax">Syntax</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">[Obsolete(&quot;When building plugins for Beat Saber, use IEnhancedBeatSaberPlugin&quot;)]
  111. public interface IEnhancedPlugin : IPlugin</code></pre>
  112. </div>
  113. <h3 id="properties">Properties
  114. </h3>
  115. <span class="small pull-right mobile-hide">
  116. <span class="divider">|</span>
  117. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Old_IEnhancedPlugin_Filter.md&amp;value=---%0Auid%3A%20IPA.Old.IEnhancedPlugin.Filter%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>
  118. </span>
  119. <span class="small pull-right mobile-hide">
  120. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/57cdcd2b85cf3ef32f94212de7d633c305442393/IPA.Loader/PluginInterfaces/IPA/IEnhancedPlugin.cs/#L17">View Source</a>
  121. </span>
  122. <a id="IPA_Old_IEnhancedPlugin_Filter_" data-uid="IPA.Old.IEnhancedPlugin.Filter*"></a>
  123. <h4 id="IPA_Old_IEnhancedPlugin_Filter" data-uid="IPA.Old.IEnhancedPlugin.Filter">Filter</h4>
  124. <div class="markdown level1 summary"><p>Gets a list of executables this plugin should be executed on (without the file ending)</p>
  125. </div>
  126. <div class="markdown level1 conceptual"></div>
  127. <h5 class="decalaration">Declaration</h5>
  128. <div class="codewrapper">
  129. <pre><code class="lang-csharp hljs">string[] Filter { get; }</code></pre>
  130. </div>
  131. <h5 class="propertyValue">Property Value</h5>
  132. <table class="table table-bordered table-striped table-condensed">
  133. <thead>
  134. <tr>
  135. <th>Type</th>
  136. <th>Description</th>
  137. </tr>
  138. </thead>
  139. <tbody>
  140. <tr>
  141. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>[]</td>
  142. <td></td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <h5 id="IPA_Old_IEnhancedPlugin_Filter_examples">Examples</h5>
  147. <p>{ &quot;PlayClub&quot;, &quot;PlayClubStudio&quot; }</p>
  148. <h3 id="methods">Methods
  149. </h3>
  150. <span class="small pull-right mobile-hide">
  151. <span class="divider">|</span>
  152. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Old_IEnhancedPlugin_OnLateUpdate.md&amp;value=---%0Auid%3A%20IPA.Old.IEnhancedPlugin.OnLateUpdate%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>
  153. </span>
  154. <span class="small pull-right mobile-hide">
  155. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/57cdcd2b85cf3ef32f94212de7d633c305442393/IPA.Loader/PluginInterfaces/IPA/IEnhancedPlugin.cs/#L22">View Source</a>
  156. </span>
  157. <a id="IPA_Old_IEnhancedPlugin_OnLateUpdate_" data-uid="IPA.Old.IEnhancedPlugin.OnLateUpdate*"></a>
  158. <h4 id="IPA_Old_IEnhancedPlugin_OnLateUpdate" data-uid="IPA.Old.IEnhancedPlugin.OnLateUpdate">OnLateUpdate()</h4>
  159. <div class="markdown level1 summary"><p>Called after Update.</p>
  160. </div>
  161. <div class="markdown level1 conceptual"></div>
  162. <h5 class="decalaration">Declaration</h5>
  163. <div class="codewrapper">
  164. <pre><code class="lang-csharp hljs">void OnLateUpdate()</code></pre>
  165. </div>
  166. <h3 id="extensionmethods">Extension Methods</h3>
  167. <div>
  168. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  169. </div>
  170. <div>
  171. <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>
  172. </div>
  173. <div>
  174. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  178. </div>
  179. <div>
  180. <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>
  181. </div>
  182. </article>
  183. </div>
  184. <div class="hidden-sm col-md-2" role="complementary">
  185. <div class="sideaffix">
  186. <div class="contribution">
  187. <ul class="nav">
  188. <li>
  189. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Old_IEnhancedPlugin.md&amp;value=---%0Auid%3A%20IPA.Old.IEnhancedPlugin%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>
  190. </li>
  191. <li>
  192. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/57cdcd2b85cf3ef32f94212de7d633c305442393/IPA.Loader/PluginInterfaces/IPA/IEnhancedPlugin.cs/#L10" class="contribution-link">View Source</a>
  193. </li>
  194. </ul>
  195. </div>
  196. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  197. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  198. </nav>
  199. </div>
  200. </div>
  201. </div>
  202. </div>
  203. <footer>
  204. <div class="grad-bottom"></div>
  205. <div class="footer">
  206. <div class="container">
  207. <span class="pull-right">
  208. <a href="#top">Back to top</a>
  209. </span>
  210. <span>Generated by <strong>DocFX</strong></span>
  211. </div>
  212. </div>
  213. </footer>
  214. </div>
  215. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  216. <script type="text/javascript" src="../styles/docfx.js"></script>
  217. <script type="text/javascript" src="../styles/main.js"></script>
  218. </body>
  219. </html>