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.

552 lines
29 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>Class StateTransitionTransaction
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class StateTransitionTransaction
  11. ">
  12. <meta name="generator" content="docfx 2.48.1.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.Loader.StateTransitionTransaction">
  75. <h1 id="IPA_Loader_StateTransitionTransaction" data-uid="IPA.Loader.StateTransitionTransaction" class="text-break">Class StateTransitionTransaction
  76. </h1>
  77. <div class="markdown level0 summary"><p>A class to represent a transaction for changing the state of loaded mods.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><span class="xref">StateTransitionTransaction</span></div>
  84. </div>
  85. <div classs="implements">
  86. <h5>Implements</h5>
  87. <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  88. </div>
  89. <div class="inheritedMembers">
  90. <h5>Inherited Members</h5>
  91. <div>
  92. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  93. </div>
  94. <div>
  95. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  111. </div>
  112. </div>
  113. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  114. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  115. <h5 id="IPA_Loader_StateTransitionTransaction_syntax">Syntax</h5>
  116. <div class="codewrapper">
  117. <pre><code class="lang-csharp hljs">public sealed class StateTransitionTransaction : IDisposable</code></pre>
  118. </div>
  119. <h3 id="properties">Properties
  120. </h3>
  121. <span class="small pull-right mobile-hide">
  122. <span class="divider">|</span>
  123. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_DisabledPlugins.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.DisabledPlugins%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/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L43">View Source</a>
  127. </span>
  128. <a id="IPA_Loader_StateTransitionTransaction_DisabledPlugins_" data-uid="IPA.Loader.StateTransitionTransaction.DisabledPlugins*"></a>
  129. <h4 id="IPA_Loader_StateTransitionTransaction_DisabledPlugins" data-uid="IPA.Loader.StateTransitionTransaction.DisabledPlugins">DisabledPlugins</h4>
  130. <div class="markdown level1 summary"><p>Gets a list of plugins that are disabled according to this transaction&apos;s current state.</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">public IEnumerable&lt;PluginMetadata&gt; DisabledPlugins { 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.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
  148. <td></td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. <span class="small pull-right mobile-hide">
  153. <span class="divider">|</span>
  154. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_EnabledPlugins.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.EnabledPlugins%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>
  155. </span>
  156. <span class="small pull-right mobile-hide">
  157. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L37">View Source</a>
  158. </span>
  159. <a id="IPA_Loader_StateTransitionTransaction_EnabledPlugins_" data-uid="IPA.Loader.StateTransitionTransaction.EnabledPlugins*"></a>
  160. <h4 id="IPA_Loader_StateTransitionTransaction_EnabledPlugins" data-uid="IPA.Loader.StateTransitionTransaction.EnabledPlugins">EnabledPlugins</h4>
  161. <div class="markdown level1 summary"><p>Gets a list of plugins that are enabled according to this transaction&apos;s current state.</p>
  162. </div>
  163. <div class="markdown level1 conceptual"></div>
  164. <h5 class="decalaration">Declaration</h5>
  165. <div class="codewrapper">
  166. <pre><code class="lang-csharp hljs">public IEnumerable&lt;PluginMetadata&gt; EnabledPlugins { get; }</code></pre>
  167. </div>
  168. <h5 class="propertyValue">Property Value</h5>
  169. <table class="table table-bordered table-striped table-condensed">
  170. <thead>
  171. <tr>
  172. <th>Type</th>
  173. <th>Description</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. <tr>
  178. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a>&gt;</td>
  179. <td></td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. <span class="small pull-right mobile-hide">
  184. <span class="divider">|</span>
  185. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_WillNeedRestart.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.WillNeedRestart%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>
  186. </span>
  187. <span class="small pull-right mobile-hide">
  188. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L29">View Source</a>
  189. </span>
  190. <a id="IPA_Loader_StateTransitionTransaction_WillNeedRestart_" data-uid="IPA.Loader.StateTransitionTransaction.WillNeedRestart*"></a>
  191. <h4 id="IPA_Loader_StateTransitionTransaction_WillNeedRestart" data-uid="IPA.Loader.StateTransitionTransaction.WillNeedRestart">WillNeedRestart</h4>
  192. <div class="markdown level1 summary"><p>Gets whether or not a game restart will be necessary to fully apply this transaction.</p>
  193. </div>
  194. <div class="markdown level1 conceptual"></div>
  195. <h5 class="decalaration">Declaration</h5>
  196. <div class="codewrapper">
  197. <pre><code class="lang-csharp hljs">public bool WillNeedRestart { get; }</code></pre>
  198. </div>
  199. <h5 class="propertyValue">Property Value</h5>
  200. <table class="table table-bordered table-striped table-condensed">
  201. <thead>
  202. <tr>
  203. <th>Type</th>
  204. <th>Description</th>
  205. </tr>
  206. </thead>
  207. <tbody>
  208. <tr>
  209. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  210. <td><p><span class="xref">true</span> if any mod who&apos;s state is changed cannot be changed at runtime, <span class="xref">false</span> otherwise</p>
  211. </td>
  212. </tr>
  213. </tbody>
  214. </table>
  215. <h3 id="methods">Methods
  216. </h3>
  217. <span class="small pull-right mobile-hide">
  218. <span class="divider">|</span>
  219. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_Commit.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.Commit%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>
  220. </span>
  221. <span class="small pull-right mobile-hide">
  222. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L118">View Source</a>
  223. </span>
  224. <a id="IPA_Loader_StateTransitionTransaction_Commit_" data-uid="IPA.Loader.StateTransitionTransaction.Commit*"></a>
  225. <h4 id="IPA_Loader_StateTransitionTransaction_Commit" data-uid="IPA.Loader.StateTransitionTransaction.Commit">Commit()</h4>
  226. <div class="markdown level1 summary"><p>Commits this transaction to actual state, enabling and disabling plugins as necessary.</p>
  227. </div>
  228. <div class="markdown level1 conceptual"></div>
  229. <h5 class="decalaration">Declaration</h5>
  230. <div class="codewrapper">
  231. <pre><code class="lang-csharp hljs">public Task Commit()</code></pre>
  232. </div>
  233. <h5 class="returns">Returns</h5>
  234. <table class="table table-bordered table-striped table-condensed">
  235. <thead>
  236. <tr>
  237. <th>Type</th>
  238. <th>Description</th>
  239. </tr>
  240. </thead>
  241. <tbody>
  242. <tr>
  243. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>
  244. <td><p>a <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> which completes whenever all disables complete</p>
  245. </td>
  246. </tr>
  247. </tbody>
  248. </table>
  249. <span class="small pull-right mobile-hide">
  250. <span class="divider">|</span>
  251. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_Disable_IPA_Loader_PluginMetadata_.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.Disable(IPA.Loader.PluginMetadata)%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>
  252. </span>
  253. <span class="small pull-right mobile-hide">
  254. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L101">View Source</a>
  255. </span>
  256. <a id="IPA_Loader_StateTransitionTransaction_Disable_" data-uid="IPA.Loader.StateTransitionTransaction.Disable*"></a>
  257. <h4 id="IPA_Loader_StateTransitionTransaction_Disable_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.StateTransitionTransaction.Disable(IPA.Loader.PluginMetadata)">Disable(PluginMetadata)</h4>
  258. <div class="markdown level1 summary"><p>Disables a plugin in this transaction.</p>
  259. </div>
  260. <div class="markdown level1 conceptual"></div>
  261. <h5 class="decalaration">Declaration</h5>
  262. <div class="codewrapper">
  263. <pre><code class="lang-csharp hljs">public bool Disable(PluginMetadata meta)</code></pre>
  264. </div>
  265. <h5 class="parameters">Parameters</h5>
  266. <table class="table table-bordered table-striped table-condensed">
  267. <thead>
  268. <tr>
  269. <th>Type</th>
  270. <th>Name</th>
  271. <th>Description</th>
  272. </tr>
  273. </thead>
  274. <tbody>
  275. <tr>
  276. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  277. <td><span class="parametername">meta</span></td>
  278. <td><p>the plugin to disable</p>
  279. </td>
  280. </tr>
  281. </tbody>
  282. </table>
  283. <h5 class="returns">Returns</h5>
  284. <table class="table table-bordered table-striped table-condensed">
  285. <thead>
  286. <tr>
  287. <th>Type</th>
  288. <th>Description</th>
  289. </tr>
  290. </thead>
  291. <tbody>
  292. <tr>
  293. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  294. <td><p><span class="xref">true</span> if the transaction&apos;s state was changed, <span class="xref">false</span> otherwise</p>
  295. </td>
  296. </tr>
  297. </tbody>
  298. </table>
  299. <span class="small pull-right mobile-hide">
  300. <span class="divider">|</span>
  301. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_Dispose.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.Dispose%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>
  302. </span>
  303. <span class="small pull-right mobile-hide">
  304. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L132">View Source</a>
  305. </span>
  306. <a id="IPA_Loader_StateTransitionTransaction_Dispose_" data-uid="IPA.Loader.StateTransitionTransaction.Dispose*"></a>
  307. <h4 id="IPA_Loader_StateTransitionTransaction_Dispose" data-uid="IPA.Loader.StateTransitionTransaction.Dispose">Dispose()</h4>
  308. <div class="markdown level1 summary"><p>Disposes and discards this transaction without committing it.</p>
  309. </div>
  310. <div class="markdown level1 conceptual"></div>
  311. <h5 class="decalaration">Declaration</h5>
  312. <div class="codewrapper">
  313. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  314. </div>
  315. <span class="small pull-right mobile-hide">
  316. <span class="divider">|</span>
  317. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_Enable_IPA_Loader_PluginMetadata_.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.Enable(IPA.Loader.PluginMetadata)%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>
  318. </span>
  319. <span class="small pull-right mobile-hide">
  320. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L83">View Source</a>
  321. </span>
  322. <a id="IPA_Loader_StateTransitionTransaction_Enable_" data-uid="IPA.Loader.StateTransitionTransaction.Enable*"></a>
  323. <h4 id="IPA_Loader_StateTransitionTransaction_Enable_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.StateTransitionTransaction.Enable(IPA.Loader.PluginMetadata)">Enable(PluginMetadata)</h4>
  324. <div class="markdown level1 summary"><p>Enables a plugin in this transaction.</p>
  325. </div>
  326. <div class="markdown level1 conceptual"></div>
  327. <h5 class="decalaration">Declaration</h5>
  328. <div class="codewrapper">
  329. <pre><code class="lang-csharp hljs">public bool Enable(PluginMetadata meta)</code></pre>
  330. </div>
  331. <h5 class="parameters">Parameters</h5>
  332. <table class="table table-bordered table-striped table-condensed">
  333. <thead>
  334. <tr>
  335. <th>Type</th>
  336. <th>Name</th>
  337. <th>Description</th>
  338. </tr>
  339. </thead>
  340. <tbody>
  341. <tr>
  342. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  343. <td><span class="parametername">meta</span></td>
  344. <td><p>the plugin to enable</p>
  345. </td>
  346. </tr>
  347. </tbody>
  348. </table>
  349. <h5 class="returns">Returns</h5>
  350. <table class="table table-bordered table-striped table-condensed">
  351. <thead>
  352. <tr>
  353. <th>Type</th>
  354. <th>Description</th>
  355. </tr>
  356. </thead>
  357. <tbody>
  358. <tr>
  359. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  360. <td><p><span class="xref">true</span> if the transaction&apos;s state was changed, <span class="xref">false</span> otherwise</p>
  361. </td>
  362. </tr>
  363. </tbody>
  364. </table>
  365. <span class="small pull-right mobile-hide">
  366. <span class="divider">|</span>
  367. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_IsDisabled_IPA_Loader_PluginMetadata_.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.IsDisabled(IPA.Loader.PluginMetadata)%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>
  368. </span>
  369. <span class="small pull-right mobile-hide">
  370. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L73">View Source</a>
  371. </span>
  372. <a id="IPA_Loader_StateTransitionTransaction_IsDisabled_" data-uid="IPA.Loader.StateTransitionTransaction.IsDisabled*"></a>
  373. <h4 id="IPA_Loader_StateTransitionTransaction_IsDisabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.StateTransitionTransaction.IsDisabled(IPA.Loader.PluginMetadata)">IsDisabled(PluginMetadata)</h4>
  374. <div class="markdown level1 summary"><p>Checks if a plugin is disabled according to this transaction&apos;s current state.</p>
  375. </div>
  376. <div class="markdown level1 conceptual"></div>
  377. <h5 class="decalaration">Declaration</h5>
  378. <div class="codewrapper">
  379. <pre><code class="lang-csharp hljs">public bool IsDisabled(PluginMetadata meta)</code></pre>
  380. </div>
  381. <h5 class="parameters">Parameters</h5>
  382. <table class="table table-bordered table-striped table-condensed">
  383. <thead>
  384. <tr>
  385. <th>Type</th>
  386. <th>Name</th>
  387. <th>Description</th>
  388. </tr>
  389. </thead>
  390. <tbody>
  391. <tr>
  392. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  393. <td><span class="parametername">meta</span></td>
  394. <td><p>the plugin to check</p>
  395. </td>
  396. </tr>
  397. </tbody>
  398. </table>
  399. <h5 class="returns">Returns</h5>
  400. <table class="table table-bordered table-striped table-condensed">
  401. <thead>
  402. <tr>
  403. <th>Type</th>
  404. <th>Description</th>
  405. </tr>
  406. </thead>
  407. <tbody>
  408. <tr>
  409. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  410. <td><p><span class="xref">true</span> if the plugin is disabled, <span class="xref">false</span> otherwise</p>
  411. </td>
  412. </tr>
  413. </tbody>
  414. </table>
  415. <h5 id="IPA_Loader_StateTransitionTransaction_IsDisabled_IPA_Loader_PluginMetadata__remarks">Remarks</h5>
  416. <div class="markdown level1 remarks"><p>This should be roughly equivalent to <code>DisabledPlugins.Contains(meta)</code>, but more performant.</p>
  417. <p>This should also always return the inverse of <a class="xref" href="IPA.Loader.StateTransitionTransaction.html#IPA_Loader_StateTransitionTransaction_IsEnabled_IPA_Loader_PluginMetadata_">IsEnabled(PluginMetadata)</a> for valid plugins.</p>
  418. </div>
  419. <h5 id="IPA_Loader_StateTransitionTransaction_IsDisabled_IPA_Loader_PluginMetadata__seealso">See Also</h5>
  420. <div class="seealso">
  421. <div><a class="xref" href="IPA.Loader.StateTransitionTransaction.html#IPA_Loader_StateTransitionTransaction_DisabledPlugins">DisabledPlugins</a></div>
  422. </div>
  423. <span class="small pull-right mobile-hide">
  424. <span class="divider">|</span>
  425. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction_IsEnabled_IPA_Loader_PluginMetadata_.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction.IsEnabled(IPA.Loader.PluginMetadata)%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>
  426. </span>
  427. <span class="small pull-right mobile-hide">
  428. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L58">View Source</a>
  429. </span>
  430. <a id="IPA_Loader_StateTransitionTransaction_IsEnabled_" data-uid="IPA.Loader.StateTransitionTransaction.IsEnabled*"></a>
  431. <h4 id="IPA_Loader_StateTransitionTransaction_IsEnabled_IPA_Loader_PluginMetadata_" data-uid="IPA.Loader.StateTransitionTransaction.IsEnabled(IPA.Loader.PluginMetadata)">IsEnabled(PluginMetadata)</h4>
  432. <div class="markdown level1 summary"><p>Checks if a plugin is enabled according to this transaction&apos;s current state.</p>
  433. </div>
  434. <div class="markdown level1 conceptual"></div>
  435. <h5 class="decalaration">Declaration</h5>
  436. <div class="codewrapper">
  437. <pre><code class="lang-csharp hljs">public bool IsEnabled(PluginMetadata meta)</code></pre>
  438. </div>
  439. <h5 class="parameters">Parameters</h5>
  440. <table class="table table-bordered table-striped table-condensed">
  441. <thead>
  442. <tr>
  443. <th>Type</th>
  444. <th>Name</th>
  445. <th>Description</th>
  446. </tr>
  447. </thead>
  448. <tbody>
  449. <tr>
  450. <td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td>
  451. <td><span class="parametername">meta</span></td>
  452. <td><p>the plugin to check</p>
  453. </td>
  454. </tr>
  455. </tbody>
  456. </table>
  457. <h5 class="returns">Returns</h5>
  458. <table class="table table-bordered table-striped table-condensed">
  459. <thead>
  460. <tr>
  461. <th>Type</th>
  462. <th>Description</th>
  463. </tr>
  464. </thead>
  465. <tbody>
  466. <tr>
  467. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  468. <td><p><span class="xref">true</span> if the plugin is enabled, <span class="xref">false</span> otherwise</p>
  469. </td>
  470. </tr>
  471. </tbody>
  472. </table>
  473. <h5 id="IPA_Loader_StateTransitionTransaction_IsEnabled_IPA_Loader_PluginMetadata__remarks">Remarks</h5>
  474. <div class="markdown level1 remarks"><p>This should be roughly equivalent to <code>EnabledPlugins.Contains(meta)</code>, but more performant.</p>
  475. <p>This should also always return the inverse of <a class="xref" href="IPA.Loader.StateTransitionTransaction.html#IPA_Loader_StateTransitionTransaction_IsDisabled_IPA_Loader_PluginMetadata_">IsDisabled(PluginMetadata)</a> for valid plugins.</p>
  476. </div>
  477. <h5 id="IPA_Loader_StateTransitionTransaction_IsEnabled_IPA_Loader_PluginMetadata__seealso">See Also</h5>
  478. <div class="seealso">
  479. <div><a class="xref" href="IPA.Loader.StateTransitionTransaction.html#IPA_Loader_StateTransitionTransaction_EnabledPlugins">EnabledPlugins</a></div>
  480. </div>
  481. <h3 id="implements">Implements</h3>
  482. <div>
  483. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
  484. </div>
  485. <h3 id="extensionmethods">Extension Methods</h3>
  486. <div>
  487. <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>
  488. </div>
  489. <div>
  490. <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>
  491. </div>
  492. <div>
  493. <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>
  494. </div>
  495. <div>
  496. <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>
  497. </div>
  498. <div>
  499. <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>
  500. </div>
  501. </article>
  502. </div>
  503. <div class="hidden-sm col-md-2" role="complementary">
  504. <div class="sideaffix">
  505. <div class="contribution">
  506. <ul class="nav">
  507. <li>
  508. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Loader_StateTransitionTransaction.md&amp;value=---%0Auid%3A%20IPA.Loader.StateTransitionTransaction%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>
  509. </li>
  510. <li>
  511. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/45cdc3f83d01e28055b2a55bd314c77d04230bb8/IPA.Loader/Loader/StateTransitionTransaction.cs/#L12" class="contribution-link">View Source</a>
  512. </li>
  513. </ul>
  514. </div>
  515. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  516. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  517. </nav>
  518. </div>
  519. </div>
  520. </div>
  521. </div>
  522. <footer>
  523. <div class="grad-bottom"></div>
  524. <div class="footer">
  525. <div class="container">
  526. <span class="pull-right">
  527. <a href="#top">Back to top</a>
  528. </span>
  529. <span>Generated by <strong>DocFX</strong></span>
  530. </div>
  531. </div>
  532. </footer>
  533. </div>
  534. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  535. <script type="text/javascript" src="../styles/docfx.js"></script>
  536. <script type="text/javascript" src="../styles/main.js"></script>
  537. </body>
  538. </html>