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.

340 lines
18 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 IPlugin
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IPlugin
  11. ">
  12. <meta name="generator" content="docfx 2.42.4.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=Open+Sans" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../index.html">
  33. <img id="logo" class="svg" src="../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="IPA.Old.IPlugin">
  63. <h1 id="IPA_Old_IPlugin" data-uid="IPA.Old.IPlugin" class="text-break">Interface IPlugin
  64. </h1>
  65. <div class="markdown level0 summary"><p>Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed at
  66. data/Managed/Plugins.</p>
  67. </div>
  68. <div class="markdown level0 conceptual"></div>
  69. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Old.html">IPA.Old</a></h6>
  70. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  71. <h5 id="IPA_Old_IPlugin_syntax">Syntax</h5>
  72. <div class="codewrapper">
  73. <pre><code class="lang-csharp hljs">[Obsolete(&quot;When building plugins for Beat Saber, use IBeatSaberPlugin&quot;)]
  74. public interface IPlugin</code></pre>
  75. </div>
  76. <h3 id="properties">Properties
  77. </h3>
  78. <span class="small pull-right mobile-hide">
  79. <span class="divider">|</span>
  80. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin_Name.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.Name%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>
  81. </span>
  82. <span class="small pull-right mobile-hide">
  83. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L16">View Source</a>
  84. </span>
  85. <a id="IPA_Old_IPlugin_Name_" data-uid="IPA.Old.IPlugin.Name*"></a>
  86. <h4 id="IPA_Old_IPlugin_Name" data-uid="IPA.Old.IPlugin.Name">Name</h4>
  87. <div class="markdown level1 summary"><p>Gets the name of the plugin.</p>
  88. </div>
  89. <div class="markdown level1 conceptual"></div>
  90. <h5 class="decalaration">Declaration</h5>
  91. <div class="codewrapper">
  92. <pre><code class="lang-csharp hljs">string Name { get; }</code></pre>
  93. </div>
  94. <h5 class="propertyValue">Property Value</h5>
  95. <table class="table table-bordered table-striped table-condensed">
  96. <thead>
  97. <tr>
  98. <th>Type</th>
  99. <th>Description</th>
  100. </tr>
  101. </thead>
  102. <tbody>
  103. <tr>
  104. <td><span class="xref">System.String</span></td>
  105. <td></td>
  106. </tr>
  107. </tbody>
  108. </table>
  109. <span class="small pull-right mobile-hide">
  110. <span class="divider">|</span>
  111. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin_Version.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.Version%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>
  112. </span>
  113. <span class="small pull-right mobile-hide">
  114. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L21">View Source</a>
  115. </span>
  116. <a id="IPA_Old_IPlugin_Version_" data-uid="IPA.Old.IPlugin.Version*"></a>
  117. <h4 id="IPA_Old_IPlugin_Version" data-uid="IPA.Old.IPlugin.Version">Version</h4>
  118. <div class="markdown level1 summary"><p>Gets the version of the plugin.</p>
  119. </div>
  120. <div class="markdown level1 conceptual"></div>
  121. <h5 class="decalaration">Declaration</h5>
  122. <div class="codewrapper">
  123. <pre><code class="lang-csharp hljs">string Version { get; }</code></pre>
  124. </div>
  125. <h5 class="propertyValue">Property Value</h5>
  126. <table class="table table-bordered table-striped table-condensed">
  127. <thead>
  128. <tr>
  129. <th>Type</th>
  130. <th>Description</th>
  131. </tr>
  132. </thead>
  133. <tbody>
  134. <tr>
  135. <td><span class="xref">System.String</span></td>
  136. <td></td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. <h3 id="methods">Methods
  141. </h3>
  142. <span class="small pull-right mobile-hide">
  143. <span class="divider">|</span>
  144. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin_OnApplicationQuit.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.OnApplicationQuit%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>
  145. </span>
  146. <span class="small pull-right mobile-hide">
  147. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L31">View Source</a>
  148. </span>
  149. <a id="IPA_Old_IPlugin_OnApplicationQuit_" data-uid="IPA.Old.IPlugin.OnApplicationQuit*"></a>
  150. <h4 id="IPA_Old_IPlugin_OnApplicationQuit" data-uid="IPA.Old.IPlugin.OnApplicationQuit">OnApplicationQuit()</h4>
  151. <div class="markdown level1 summary"><p>Gets invoked when the application is closed.</p>
  152. </div>
  153. <div class="markdown level1 conceptual"></div>
  154. <h5 class="decalaration">Declaration</h5>
  155. <div class="codewrapper">
  156. <pre><code class="lang-csharp hljs">void OnApplicationQuit()</code></pre>
  157. </div>
  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/apiSpec/new?filename=IPA_Old_IPlugin_OnApplicationStart.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.OnApplicationStart%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/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L26">View Source</a>
  164. </span>
  165. <a id="IPA_Old_IPlugin_OnApplicationStart_" data-uid="IPA.Old.IPlugin.OnApplicationStart*"></a>
  166. <h4 id="IPA_Old_IPlugin_OnApplicationStart" data-uid="IPA.Old.IPlugin.OnApplicationStart">OnApplicationStart()</h4>
  167. <div class="markdown level1 summary"><p>Gets invoked when the application is started.</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">void OnApplicationStart()</code></pre>
  173. </div>
  174. <span class="small pull-right mobile-hide">
  175. <span class="divider">|</span>
  176. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin_OnFixedUpdate.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.OnFixedUpdate%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>
  177. </span>
  178. <span class="small pull-right mobile-hide">
  179. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L53">View Source</a>
  180. </span>
  181. <a id="IPA_Old_IPlugin_OnFixedUpdate_" data-uid="IPA.Old.IPlugin.OnFixedUpdate*"></a>
  182. <h4 id="IPA_Old_IPlugin_OnFixedUpdate" data-uid="IPA.Old.IPlugin.OnFixedUpdate">OnFixedUpdate()</h4>
  183. <div class="markdown level1 summary"><p>Gets invoked on ever physics update.</p>
  184. </div>
  185. <div class="markdown level1 conceptual"></div>
  186. <h5 class="decalaration">Declaration</h5>
  187. <div class="codewrapper">
  188. <pre><code class="lang-csharp hljs">void OnFixedUpdate()</code></pre>
  189. </div>
  190. <span class="small pull-right mobile-hide">
  191. <span class="divider">|</span>
  192. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin_OnLevelWasInitialized_System_Int32_.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.OnLevelWasInitialized(System.Int32)%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>
  193. </span>
  194. <span class="small pull-right mobile-hide">
  195. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L43">View Source</a>
  196. </span>
  197. <a id="IPA_Old_IPlugin_OnLevelWasInitialized_" data-uid="IPA.Old.IPlugin.OnLevelWasInitialized*"></a>
  198. <h4 id="IPA_Old_IPlugin_OnLevelWasInitialized_System_Int32_" data-uid="IPA.Old.IPlugin.OnLevelWasInitialized(System.Int32)">OnLevelWasInitialized(Int32)</h4>
  199. <div class="markdown level1 summary"><p>Gets invoked after the first update cycle after a level was loaded.</p>
  200. </div>
  201. <div class="markdown level1 conceptual"></div>
  202. <h5 class="decalaration">Declaration</h5>
  203. <div class="codewrapper">
  204. <pre><code class="lang-csharp hljs">void OnLevelWasInitialized(int level)</code></pre>
  205. </div>
  206. <h5 class="parameters">Parameters</h5>
  207. <table class="table table-bordered table-striped table-condensed">
  208. <thead>
  209. <tr>
  210. <th>Type</th>
  211. <th>Name</th>
  212. <th>Description</th>
  213. </tr>
  214. </thead>
  215. <tbody>
  216. <tr>
  217. <td><span class="xref">System.Int32</span></td>
  218. <td><span class="parametername">level</span></td>
  219. <td></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <span class="small pull-right mobile-hide">
  224. <span class="divider">|</span>
  225. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin_OnLevelWasLoaded_System_Int32_.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.OnLevelWasLoaded(System.Int32)%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>
  226. </span>
  227. <span class="small pull-right mobile-hide">
  228. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L37">View Source</a>
  229. </span>
  230. <a id="IPA_Old_IPlugin_OnLevelWasLoaded_" data-uid="IPA.Old.IPlugin.OnLevelWasLoaded*"></a>
  231. <h4 id="IPA_Old_IPlugin_OnLevelWasLoaded_System_Int32_" data-uid="IPA.Old.IPlugin.OnLevelWasLoaded(System.Int32)">OnLevelWasLoaded(Int32)</h4>
  232. <div class="markdown level1 summary"><p>Gets invoked whenever a level is loaded.</p>
  233. </div>
  234. <div class="markdown level1 conceptual"></div>
  235. <h5 class="decalaration">Declaration</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">void OnLevelWasLoaded(int level)</code></pre>
  238. </div>
  239. <h5 class="parameters">Parameters</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Type</th>
  244. <th>Name</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><span class="xref">System.Int32</span></td>
  251. <td><span class="parametername">level</span></td>
  252. <td></td>
  253. </tr>
  254. </tbody>
  255. </table>
  256. <span class="small pull-right mobile-hide">
  257. <span class="divider">|</span>
  258. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin_OnUpdate.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin.OnUpdate%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>
  259. </span>
  260. <span class="small pull-right mobile-hide">
  261. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L48">View Source</a>
  262. </span>
  263. <a id="IPA_Old_IPlugin_OnUpdate_" data-uid="IPA.Old.IPlugin.OnUpdate*"></a>
  264. <h4 id="IPA_Old_IPlugin_OnUpdate" data-uid="IPA.Old.IPlugin.OnUpdate">OnUpdate()</h4>
  265. <div class="markdown level1 summary"><p>Gets invoked on every graphic update.</p>
  266. </div>
  267. <div class="markdown level1 conceptual"></div>
  268. <h5 class="decalaration">Declaration</h5>
  269. <div class="codewrapper">
  270. <pre><code class="lang-csharp hljs">void OnUpdate()</code></pre>
  271. </div>
  272. <h3 id="extensionmethods">Extension Methods</h3>
  273. <div>
  274. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  275. </div>
  276. <div>
  277. <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>
  278. </div>
  279. <div>
  280. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  281. </div>
  282. <div>
  283. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  284. </div>
  285. <div>
  286. <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>
  287. </div>
  288. </article>
  289. </div>
  290. <div class="hidden-sm col-md-2" role="complementary">
  291. <div class="sideaffix">
  292. <div class="contribution">
  293. <ul class="nav">
  294. <li>
  295. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Old_IPlugin.md&amp;value=---%0Auid%3A%20IPA.Old.IPlugin%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>
  296. </li>
  297. <li>
  298. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L10" class="contribution-link">View Source</a>
  299. </li>
  300. </ul>
  301. </div>
  302. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  303. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  304. </nav>
  305. </div>
  306. </div>
  307. </div>
  308. </div>
  309. <footer>
  310. <div class="grad-bottom"></div>
  311. <div class="footer">
  312. <div class="container">
  313. <span class="pull-right">
  314. <a href="#top">Back to top</a>
  315. </span>
  316. <span>Generated by <strong>DocFX</strong></span>
  317. </div>
  318. </div>
  319. </footer>
  320. </div>
  321. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  322. <script type="text/javascript" src="../styles/docfx.js"></script>
  323. <script type="text/javascript" src="../styles/main.js"></script>
  324. </body>
  325. </html>