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.

204 lines
8.9 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>Enum RuntimeOptions
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Enum RuntimeOptions
  11. ">
  12. <meta name="generator" content="docfx 2.48.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 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.RuntimeOptions">
  75. <h1 id="IPA_RuntimeOptions" data-uid="IPA.RuntimeOptions" class="text-break">Enum RuntimeOptions
  76. </h1>
  77. <div class="markdown level0 summary"><p>Options that a plugin must specify to describe how it expects to be run.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>
  81. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  82. <h5 id="IPA_RuntimeOptions_syntax">Syntax</h5>
  83. <div class="codewrapper">
  84. <pre><code class="lang-csharp hljs">public enum RuntimeOptions</code></pre>
  85. </div>
  86. <h3 id="fields">Fields
  87. </h3>
  88. <table class="table table-bordered table-striped table-condensed">
  89. <thead>
  90. <tr>
  91. <th>Name</th>
  92. <th>Description</th>
  93. </tr>
  94. <thead>
  95. <tbody>
  96. <tr>
  97. <td id="IPA_RuntimeOptions_DynamicInit">DynamicInit</td>
  98. <td><p>
  99. Indicates that this plugin supports runtime enabling and disabling.
  100. </p>
  101. <p>
  102. When this is set, the plugin may be disabled at reasonable points during runtime. As with <a class="xref" href="IPA.RuntimeOptions.html#IPA_RuntimeOptions_SingleStartInit">SingleStartInit</a>,
  103. it will be initialized and enabled with the game if it is enabled on startup, and disabled with the game if it is enabled
  104. on shutdown.
  105. </p>
  106. <p>
  107. When a plugin with this set is enabled mid-game, the first time it is enabled, its initialization methods will be called,
  108. then its enable methods. All subsequent enables will <strong>NOT</strong> re-initialize, however the enable methods will be called.
  109. </p>
  110. <p>
  111. When a plugin with this set is disabled mid-game, the plugin instance will <strong>NOT</strong> be destroyed, and will instead be
  112. re-used for subsequent enables. The plugin is expected to handle this gracefully, and behave in a way that makes sense.
  113. </p>
  114. </td>
  115. </tr>
  116. <tr>
  117. <td id="IPA_RuntimeOptions_SingleStartInit">SingleStartInit</td>
  118. <td><p>
  119. Indicates that this plugin expects to be initialized and enabled with the game, and disabled with the game.
  120. </p>
  121. <p>
  122. With this option set, whether or not the plugin is disabled during a given run is constant for that entire run.
  123. </p>
  124. </td>
  125. </tr>
  126. </tbody>
  127. </thead></thead></table>
  128. <h5 id="IPA_RuntimeOptions_seealso">See Also</h5>
  129. <div class="seealso">
  130. <div><a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a></div>
  131. <div><a class="xref" href="IPA.InitAttribute.html">InitAttribute</a></div>
  132. <div><a class="xref" href="IPA.OnEnableAttribute.html">OnEnableAttribute</a></div>
  133. <div><a class="xref" href="IPA.OnDisableAttribute.html">OnDisableAttribute</a></div>
  134. <div><a class="xref" href="IPA.OnStartAttribute.html">OnStartAttribute</a></div>
  135. <div><a class="xref" href="IPA.OnExitAttribute.html">OnExitAttribute</a></div>
  136. </div>
  137. <h3 id="extensionmethods">Extension Methods</h3>
  138. <div>
  139. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;RuntimeOptions, U&gt;(String, U)</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, RuntimeOptions&gt;(String)</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;RuntimeOptions, U&gt;(String, U)</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, RuntimeOptions&gt;(String)</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, RuntimeOptions&gt;(String, Object[])</a>
  152. </div>
  153. </article>
  154. </div>
  155. <div class="hidden-sm col-md-2" role="complementary">
  156. <div class="sideaffix">
  157. <div class="contribution">
  158. <ul class="nav">
  159. <li>
  160. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_RuntimeOptions.md&amp;value=---%0Auid%3A%20IPA.RuntimeOptions%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>
  161. </li>
  162. <li>
  163. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ea7c533afed6ec09e4552f30fb5791a440c0420c/IPA.Loader/PluginInterfaces/Attributes/PluginAttribute.cs/#L43" class="contribution-link">View Source</a>
  164. </li>
  165. </ul>
  166. </div>
  167. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  168. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  169. </nav>
  170. </div>
  171. </div>
  172. </div>
  173. </div>
  174. <footer>
  175. <div class="grad-bottom"></div>
  176. <div class="footer">
  177. <div class="container">
  178. <span class="pull-right">
  179. <a href="#top">Back to top</a>
  180. </span>
  181. <span>Generated by <strong>DocFX</strong></span>
  182. </div>
  183. </div>
  184. </footer>
  185. </div>
  186. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  187. <script type="text/javascript" src="../styles/docfx.js"></script>
  188. <script type="text/javascript" src="../styles/main.js"></script>
  189. </body>
  190. </html>