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.

307 lines
16 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 PluginInitInjector
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class PluginInitInjector
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.PluginInitInjector">
  75. <h1 id="IPA_Loader_PluginInitInjector" data-uid="IPA.Loader.PluginInitInjector" class="text-break">Class PluginInitInjector
  76. </h1>
  77. <div class="markdown level0 summary"><p>The type that handles value injecting into a plugin&apos;s initialization methods.</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">PluginInitInjector</span></div>
  84. </div>
  85. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  86. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  87. <h5 id="IPA_Loader_PluginInitInjector_syntax">Syntax</h5>
  88. <div class="codewrapper">
  89. <pre><code class="lang-csharp hljs">public static class PluginInitInjector : object</code></pre>
  90. </div>
  91. <h5 id="IPA_Loader_PluginInitInjector_remarks"><strong>Remarks</strong></h5>
  92. <div class="markdown level0 remarks"><p>The default injectors and what they provide are shown in this table.
  93. <table><thead><tr><th>Parameter Type</th><th>Injected Value</th></tr></thead><tbody><tr><td><a class="xref" href="IPA.Logging.Logger.html">Logger</a></td><td>A <a class="xref" href="IPA.Logging.StandardLogger.html">StandardLogger</a> specialized for the plugin being injected</td></tr><tr><td><a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a></td><td>The <a class="xref" href="IPA.Loader.PluginMetadata.html">PluginMetadata</a> of the plugin being injected</td></tr><tr><td><a class="xref" href="IPA.Config.Config.html">Config</a></td><td>A <a class="xref" href="IPA.Config.Config.html">Config</a> object for the plugin being injected.
  94. <p>
  95. These parameters may have <a class="xref" href="IPA.Config.Config.NameAttribute.html">Config.NameAttribute</a> and <a class="xref" href="IPA.Config.Config.PreferAttribute.html">Config.PreferAttribute</a> to control
  96. how it is constructed.
  97. </p>
  98. </td></tr><tr><td><a class="xref" href="IPA.AntiMalware.IAntiMalware.html">IAntiMalware</a></td><td>The <a class="xref" href="IPA.AntiMalware.IAntiMalware.html">IAntiMalware</a> instance which should be used for any potentially dangerous files.</td></tr></tbody></table>
  99. For all of the default injectors, only one of each will be generated, and any later parameters will recieve the same value as the first one.</p>
  100. </div>
  101. <h3 id="methods">Methods
  102. </h3>
  103. <span class="small pull-right mobile-hide">
  104. <span class="divider">|</span>
  105. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginInitInjector_AddInjector_Type_IPA_Loader_PluginInitInjector_InjectParameter_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginInitInjector.AddInjector(Type%2CIPA.Loader.PluginInitInjector.InjectParameter)%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>
  106. </span>
  107. <span class="small pull-right mobile-hide">
  108. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginInitInjector.cs/#L103">View Source</a>
  109. </span>
  110. <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>
  111. <h4 id="IPA_Loader_PluginInitInjector_AddInjector_Type_IPA_Loader_PluginInitInjector_InjectParameter_" data-uid="IPA.Loader.PluginInitInjector.AddInjector(Type,IPA.Loader.PluginInitInjector.InjectParameter)">AddInjector(Type, PluginInitInjector.InjectParameter)</h4>
  112. <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p>
  113. </div>
  114. <div class="markdown level1 conceptual"></div>
  115. <h5 class="decalaration">Declaration</h5>
  116. <div class="codewrapper">
  117. <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector)</code></pre>
  118. </div>
  119. <h5 class="parameters">Parameters</h5>
  120. <table class="table table-bordered table-striped table-condensed">
  121. <thead>
  122. <tr>
  123. <th>Type</th>
  124. <th>Name</th>
  125. <th>Description</th>
  126. </tr>
  127. </thead>
  128. <tbody>
  129. <tr>
  130. <td><span class="xref">Type</span></td>
  131. <td><span class="parametername">type</span></td>
  132. <td><p>the type of the parameter.</p>
  133. </td>
  134. </tr>
  135. <tr>
  136. <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameter.html">PluginInitInjector.InjectParameter</a></td>
  137. <td><span class="parametername">injector</span></td>
  138. <td><p>the function to call for injection.</p>
  139. </td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. <span class="small pull-right mobile-hide">
  144. <span class="divider">|</span>
  145. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginInitInjector_AddInjector_Type_IPA_Loader_PluginInitInjector_InjectParameterNested_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginInitInjector.AddInjector(Type%2CIPA.Loader.PluginInitInjector.InjectParameterNested)%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>
  146. </span>
  147. <span class="small pull-right mobile-hide">
  148. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginInitInjector.cs/#L111">View Source</a>
  149. </span>
  150. <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>
  151. <h4 id="IPA_Loader_PluginInitInjector_AddInjector_Type_IPA_Loader_PluginInitInjector_InjectParameterNested_" data-uid="IPA.Loader.PluginInitInjector.AddInjector(Type,IPA.Loader.PluginInitInjector.InjectParameterNested)">AddInjector(Type, PluginInitInjector.InjectParameterNested)</h4>
  152. <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p>
  153. </div>
  154. <div class="markdown level1 conceptual"></div>
  155. <h5 class="decalaration">Declaration</h5>
  156. <div class="codewrapper">
  157. <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameterNested injector)</code></pre>
  158. </div>
  159. <h5 class="parameters">Parameters</h5>
  160. <table class="table table-bordered table-striped table-condensed">
  161. <thead>
  162. <tr>
  163. <th>Type</th>
  164. <th>Name</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><span class="xref">Type</span></td>
  171. <td><span class="parametername">type</span></td>
  172. <td><p>the type of the parameter.</p>
  173. </td>
  174. </tr>
  175. <tr>
  176. <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameterNested.html">PluginInitInjector.InjectParameterNested</a></td>
  177. <td><span class="parametername">injector</span></td>
  178. <td><p>the function to call for injection.</p>
  179. </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/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginInitInjector_Inject__1_IPA_Loader_PluginInitInjector_InjectedValueProvider_ParameterInfo_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginInitInjector.Inject%60%601(IPA.Loader.PluginInitInjector.InjectedValueProvider%2CParameterInfo)%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/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginInitInjector.cs/#L95">View Source</a>
  189. </span>
  190. <a id="IPA_Loader_PluginInitInjector_Inject_" data-uid="IPA.Loader.PluginInitInjector.Inject*"></a>
  191. <h4 id="IPA_Loader_PluginInitInjector_Inject__1_IPA_Loader_PluginInitInjector_InjectedValueProvider_ParameterInfo_" data-uid="IPA.Loader.PluginInitInjector.Inject``1(IPA.Loader.PluginInitInjector.InjectedValueProvider,ParameterInfo)">Inject&lt;T&gt;(PluginInitInjector.InjectedValueProvider, ParameterInfo)</h4>
  192. <div class="markdown level1 summary"><p>Invokes the provider with <code data-dev-comment-type="paramref" class="paramref">param</code> and <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> and casts the result to <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>.</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 static T Inject&lt;T&gt;(this PluginInitInjector.InjectedValueProvider provider, ParameterInfo param)</code></pre>
  198. </div>
  199. <h5 class="parameters">Parameters</h5>
  200. <table class="table table-bordered table-striped table-condensed">
  201. <thead>
  202. <tr>
  203. <th>Type</th>
  204. <th>Name</th>
  205. <th>Description</th>
  206. </tr>
  207. </thead>
  208. <tbody>
  209. <tr>
  210. <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectedValueProvider.html">PluginInitInjector.InjectedValueProvider</a></td>
  211. <td><span class="parametername">provider</span></td>
  212. <td><p>the provider to invoke.</p>
  213. </td>
  214. </tr>
  215. <tr>
  216. <td><span class="xref">ParameterInfo</span></td>
  217. <td><span class="parametername">param</span></td>
  218. <td><p>the parameter to provide for</p>
  219. </td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <h5 class="returns">Returns</h5>
  224. <table class="table table-bordered table-striped table-condensed">
  225. <thead>
  226. <tr>
  227. <th>Type</th>
  228. <th>Description</th>
  229. </tr>
  230. </thead>
  231. <tbody>
  232. <tr>
  233. <td><span class="xref">T</span></td>
  234. <td><p>the value requested, or <span class="xref">null</span>.</p>
  235. </td>
  236. </tr>
  237. </tbody>
  238. </table>
  239. <h5 class="typeParameters">Type Parameters</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Name</th>
  244. <th>Description</th>
  245. </tr>
  246. </thead>
  247. <tbody>
  248. <tr>
  249. <td><span class="parametername">T</span></td>
  250. <td><p>the type of object to be injected</p>
  251. </td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. </article>
  256. </div>
  257. <div class="hidden-sm col-md-2" role="complementary">
  258. <div class="sideaffix">
  259. <div class="contribution">
  260. <ul class="nav">
  261. <li>
  262. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginInitInjector.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginInitInjector%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>
  263. </li>
  264. <li>
  265. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Loader/PluginInitInjector.cs/#L53" class="contribution-link">View Source</a>
  266. </li>
  267. </ul>
  268. </div>
  269. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  270. <h5>In This Article</h5>
  271. <div></div>
  272. </nav>
  273. </div>
  274. </div>
  275. </div>
  276. </div>
  277. <footer>
  278. <div class="grad-bottom"></div>
  279. <div class="footer">
  280. <div class="container">
  281. <span class="pull-right">
  282. <a href="#top">Back to top</a>
  283. </span>
  284. <span>Generated by <strong>DocFX</strong></span>
  285. </div>
  286. </div>
  287. </footer>
  288. </div>
  289. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  290. <script type="text/javascript" src="../styles/docfx.js"></script>
  291. <script type="text/javascript" src="../styles/main.js"></script>
  292. </body>
  293. </html>