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.

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