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.

350 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.45.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.IPlugin">
  74. <h1 id="IPA_Old_IPlugin" data-uid="IPA.Old.IPlugin" class="text-break">Interface IPlugin
  75. </h1>
  76. <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
  77. data/Managed/Plugins.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Old.html">IPA.Old</a></h6>
  81. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  82. <h5 id="IPA_Old_IPlugin_syntax">Syntax</h5>
  83. <div class="codewrapper">
  84. <pre><code class="lang-csharp hljs">[Obsolete(&quot;When building plugins for Beat Saber, use IBeatSaberPlugin&quot;)]
  85. public interface IPlugin</code></pre>
  86. </div>
  87. <h3 id="properties">Properties
  88. </h3>
  89. <span class="small pull-right mobile-hide">
  90. <span class="divider">|</span>
  91. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  92. </span>
  93. <span class="small pull-right mobile-hide">
  94. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L16">View Source</a>
  95. </span>
  96. <a id="IPA_Old_IPlugin_Name_" data-uid="IPA.Old.IPlugin.Name*"></a>
  97. <h4 id="IPA_Old_IPlugin_Name" data-uid="IPA.Old.IPlugin.Name">Name</h4>
  98. <div class="markdown level1 summary"><p>Gets the name of the plugin.</p>
  99. </div>
  100. <div class="markdown level1 conceptual"></div>
  101. <h5 class="decalaration">Declaration</h5>
  102. <div class="codewrapper">
  103. <pre><code class="lang-csharp hljs">string Name { get; }</code></pre>
  104. </div>
  105. <h5 class="propertyValue">Property Value</h5>
  106. <table class="table table-bordered table-striped table-condensed">
  107. <thead>
  108. <tr>
  109. <th>Type</th>
  110. <th>Description</th>
  111. </tr>
  112. </thead>
  113. <tbody>
  114. <tr>
  115. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  116. <td></td>
  117. </tr>
  118. </tbody>
  119. </table>
  120. <span class="small pull-right mobile-hide">
  121. <span class="divider">|</span>
  122. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  123. </span>
  124. <span class="small pull-right mobile-hide">
  125. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L21">View Source</a>
  126. </span>
  127. <a id="IPA_Old_IPlugin_Version_" data-uid="IPA.Old.IPlugin.Version*"></a>
  128. <h4 id="IPA_Old_IPlugin_Version" data-uid="IPA.Old.IPlugin.Version">Version</h4>
  129. <div class="markdown level1 summary"><p>Gets the version of the plugin.</p>
  130. </div>
  131. <div class="markdown level1 conceptual"></div>
  132. <h5 class="decalaration">Declaration</h5>
  133. <div class="codewrapper">
  134. <pre><code class="lang-csharp hljs">string Version { get; }</code></pre>
  135. </div>
  136. <h5 class="propertyValue">Property Value</h5>
  137. <table class="table table-bordered table-striped table-condensed">
  138. <thead>
  139. <tr>
  140. <th>Type</th>
  141. <th>Description</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  147. <td></td>
  148. </tr>
  149. </tbody>
  150. </table>
  151. <h3 id="methods">Methods
  152. </h3>
  153. <span class="small pull-right mobile-hide">
  154. <span class="divider">|</span>
  155. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  156. </span>
  157. <span class="small pull-right mobile-hide">
  158. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L31">View Source</a>
  159. </span>
  160. <a id="IPA_Old_IPlugin_OnApplicationQuit_" data-uid="IPA.Old.IPlugin.OnApplicationQuit*"></a>
  161. <h4 id="IPA_Old_IPlugin_OnApplicationQuit" data-uid="IPA.Old.IPlugin.OnApplicationQuit">OnApplicationQuit()</h4>
  162. <div class="markdown level1 summary"><p>Gets invoked when the application is closed.</p>
  163. </div>
  164. <div class="markdown level1 conceptual"></div>
  165. <h5 class="decalaration">Declaration</h5>
  166. <div class="codewrapper">
  167. <pre><code class="lang-csharp hljs">void OnApplicationQuit()</code></pre>
  168. </div>
  169. <span class="small pull-right mobile-hide">
  170. <span class="divider">|</span>
  171. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  172. </span>
  173. <span class="small pull-right mobile-hide">
  174. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L26">View Source</a>
  175. </span>
  176. <a id="IPA_Old_IPlugin_OnApplicationStart_" data-uid="IPA.Old.IPlugin.OnApplicationStart*"></a>
  177. <h4 id="IPA_Old_IPlugin_OnApplicationStart" data-uid="IPA.Old.IPlugin.OnApplicationStart">OnApplicationStart()</h4>
  178. <div class="markdown level1 summary"><p>Gets invoked when the application is started.</p>
  179. </div>
  180. <div class="markdown level1 conceptual"></div>
  181. <h5 class="decalaration">Declaration</h5>
  182. <div class="codewrapper">
  183. <pre><code class="lang-csharp hljs">void OnApplicationStart()</code></pre>
  184. </div>
  185. <span class="small pull-right mobile-hide">
  186. <span class="divider">|</span>
  187. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  188. </span>
  189. <span class="small pull-right mobile-hide">
  190. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L53">View Source</a>
  191. </span>
  192. <a id="IPA_Old_IPlugin_OnFixedUpdate_" data-uid="IPA.Old.IPlugin.OnFixedUpdate*"></a>
  193. <h4 id="IPA_Old_IPlugin_OnFixedUpdate" data-uid="IPA.Old.IPlugin.OnFixedUpdate">OnFixedUpdate()</h4>
  194. <div class="markdown level1 summary"><p>Gets invoked on ever physics update.</p>
  195. </div>
  196. <div class="markdown level1 conceptual"></div>
  197. <h5 class="decalaration">Declaration</h5>
  198. <div class="codewrapper">
  199. <pre><code class="lang-csharp hljs">void OnFixedUpdate()</code></pre>
  200. </div>
  201. <span class="small pull-right mobile-hide">
  202. <span class="divider">|</span>
  203. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  204. </span>
  205. <span class="small pull-right mobile-hide">
  206. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L43">View Source</a>
  207. </span>
  208. <a id="IPA_Old_IPlugin_OnLevelWasInitialized_" data-uid="IPA.Old.IPlugin.OnLevelWasInitialized*"></a>
  209. <h4 id="IPA_Old_IPlugin_OnLevelWasInitialized_System_Int32_" data-uid="IPA.Old.IPlugin.OnLevelWasInitialized(System.Int32)">OnLevelWasInitialized(Int32)</h4>
  210. <div class="markdown level1 summary"><p>Gets invoked after the first update cycle after a level was loaded.</p>
  211. </div>
  212. <div class="markdown level1 conceptual"></div>
  213. <h5 class="decalaration">Declaration</h5>
  214. <div class="codewrapper">
  215. <pre><code class="lang-csharp hljs">void OnLevelWasInitialized(int level)</code></pre>
  216. </div>
  217. <h5 class="parameters">Parameters</h5>
  218. <table class="table table-bordered table-striped table-condensed">
  219. <thead>
  220. <tr>
  221. <th>Type</th>
  222. <th>Name</th>
  223. <th>Description</th>
  224. </tr>
  225. </thead>
  226. <tbody>
  227. <tr>
  228. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
  229. <td><span class="parametername">level</span></td>
  230. <td></td>
  231. </tr>
  232. </tbody>
  233. </table>
  234. <span class="small pull-right mobile-hide">
  235. <span class="divider">|</span>
  236. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  237. </span>
  238. <span class="small pull-right mobile-hide">
  239. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L37">View Source</a>
  240. </span>
  241. <a id="IPA_Old_IPlugin_OnLevelWasLoaded_" data-uid="IPA.Old.IPlugin.OnLevelWasLoaded*"></a>
  242. <h4 id="IPA_Old_IPlugin_OnLevelWasLoaded_System_Int32_" data-uid="IPA.Old.IPlugin.OnLevelWasLoaded(System.Int32)">OnLevelWasLoaded(Int32)</h4>
  243. <div class="markdown level1 summary"><p>Gets invoked whenever a level is loaded.</p>
  244. </div>
  245. <div class="markdown level1 conceptual"></div>
  246. <h5 class="decalaration">Declaration</h5>
  247. <div class="codewrapper">
  248. <pre><code class="lang-csharp hljs">void OnLevelWasLoaded(int level)</code></pre>
  249. </div>
  250. <h5 class="parameters">Parameters</h5>
  251. <table class="table table-bordered table-striped table-condensed">
  252. <thead>
  253. <tr>
  254. <th>Type</th>
  255. <th>Name</th>
  256. <th>Description</th>
  257. </tr>
  258. </thead>
  259. <tbody>
  260. <tr>
  261. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
  262. <td><span class="parametername">level</span></td>
  263. <td></td>
  264. </tr>
  265. </tbody>
  266. </table>
  267. <span class="small pull-right mobile-hide">
  268. <span class="divider">|</span>
  269. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  270. </span>
  271. <span class="small pull-right mobile-hide">
  272. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L48">View Source</a>
  273. </span>
  274. <a id="IPA_Old_IPlugin_OnUpdate_" data-uid="IPA.Old.IPlugin.OnUpdate*"></a>
  275. <h4 id="IPA_Old_IPlugin_OnUpdate" data-uid="IPA.Old.IPlugin.OnUpdate">OnUpdate()</h4>
  276. <div class="markdown level1 summary"><p>Gets invoked on every graphic update.</p>
  277. </div>
  278. <div class="markdown level1 conceptual"></div>
  279. <h5 class="decalaration">Declaration</h5>
  280. <div class="codewrapper">
  281. <pre><code class="lang-csharp hljs">void OnUpdate()</code></pre>
  282. </div>
  283. <h3 id="extensionmethods">Extension Methods</h3>
  284. <div>
  285. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  286. </div>
  287. <div>
  288. <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>
  289. </div>
  290. <div>
  291. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  295. </div>
  296. <div>
  297. <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>
  298. </div>
  299. </article>
  300. </div>
  301. <div class="hidden-sm col-md-2" role="complementary">
  302. <div class="sideaffix">
  303. <div class="contribution">
  304. <ul class="nav">
  305. <li>
  306. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  307. </li>
  308. <li>
  309. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/f589a41d823111d4d3b15886f753e83fcecf7aa4/IPA.Loader/PluginInterfaces/IPA/IPlugin.cs/#L10" class="contribution-link">View Source</a>
  310. </li>
  311. </ul>
  312. </div>
  313. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  314. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  315. </nav>
  316. </div>
  317. </div>
  318. </div>
  319. </div>
  320. <footer>
  321. <div class="grad-bottom"></div>
  322. <div class="footer">
  323. <div class="container">
  324. <span class="pull-right">
  325. <a href="#top">Back to top</a>
  326. </span>
  327. <span>Generated by <strong>DocFX</strong></span>
  328. </div>
  329. </div>
  330. </footer>
  331. </div>
  332. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  333. <script type="text/javascript" src="../styles/docfx.js"></script>
  334. <script type="text/javascript" src="../styles/main.js"></script>
  335. </body>
  336. </html>