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.

332 lines
17 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.58.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">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. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  92. </div>
  93. <div>
  94. <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>
  95. </div>
  96. <div>
  97. <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>
  98. </div>
  99. <div>
  100. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  110. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  111. <h5 id="IPA_Loader_PluginInitInjector_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public static class PluginInitInjector</code></pre>
  114. </div>
  115. <h5 id="IPA_Loader_PluginInitInjector_remarks"><strong>Remarks</strong></h5>
  116. <div class="markdown level0 remarks"><p>The default injectors and what they provide are shown in this table.
  117. <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>
  118. <p>A <a class="xref" href="IPA.Config.Config.html">Config</a> object for the plugin being injected.</p>
  119. <p>
  120. 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
  121. how it is constructed.
  122. </p>
  123. </td></tr></tbody></table>
  124. 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>
  125. </div>
  126. <h3 id="methods">Methods
  127. </h3>
  128. <span class="small pull-right mobile-hide">
  129. <span class="divider">|</span>
  130. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginInitInjector_AddInjector_System_Type_IPA_Loader_PluginInitInjector_InjectParameter_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginInitInjector.AddInjector(System.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>
  131. </span>
  132. <span class="small pull-right mobile-hide">
  133. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L100">View Source</a>
  134. </span>
  135. <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>
  136. <h4 id="IPA_Loader_PluginInitInjector_AddInjector_System_Type_IPA_Loader_PluginInitInjector_InjectParameter_" data-uid="IPA.Loader.PluginInitInjector.AddInjector(System.Type,IPA.Loader.PluginInitInjector.InjectParameter)">AddInjector(Type, PluginInitInjector.InjectParameter)</h4>
  137. <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p>
  138. </div>
  139. <div class="markdown level1 conceptual"></div>
  140. <h5 class="decalaration">Declaration</h5>
  141. <div class="codewrapper">
  142. <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector)</code></pre>
  143. </div>
  144. <h5 class="parameters">Parameters</h5>
  145. <table class="table table-bordered table-striped table-condensed">
  146. <thead>
  147. <tr>
  148. <th>Type</th>
  149. <th>Name</th>
  150. <th>Description</th>
  151. </tr>
  152. </thead>
  153. <tbody>
  154. <tr>
  155. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>
  156. <td><span class="parametername">type</span></td>
  157. <td><p>the type of the parameter.</p>
  158. </td>
  159. </tr>
  160. <tr>
  161. <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameter.html">PluginInitInjector.InjectParameter</a></td>
  162. <td><span class="parametername">injector</span></td>
  163. <td><p>the function to call for injection.</p>
  164. </td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. <span class="small pull-right mobile-hide">
  169. <span class="divider">|</span>
  170. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginInitInjector_AddInjector_System_Type_IPA_Loader_PluginInitInjector_InjectParameterNested_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginInitInjector.AddInjector(System.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>
  171. </span>
  172. <span class="small pull-right mobile-hide">
  173. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L108">View Source</a>
  174. </span>
  175. <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>
  176. <h4 id="IPA_Loader_PluginInitInjector_AddInjector_System_Type_IPA_Loader_PluginInitInjector_InjectParameterNested_" data-uid="IPA.Loader.PluginInitInjector.AddInjector(System.Type,IPA.Loader.PluginInitInjector.InjectParameterNested)">AddInjector(Type, PluginInitInjector.InjectParameterNested)</h4>
  177. <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p>
  178. </div>
  179. <div class="markdown level1 conceptual"></div>
  180. <h5 class="decalaration">Declaration</h5>
  181. <div class="codewrapper">
  182. <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameterNested injector)</code></pre>
  183. </div>
  184. <h5 class="parameters">Parameters</h5>
  185. <table class="table table-bordered table-striped table-condensed">
  186. <thead>
  187. <tr>
  188. <th>Type</th>
  189. <th>Name</th>
  190. <th>Description</th>
  191. </tr>
  192. </thead>
  193. <tbody>
  194. <tr>
  195. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>
  196. <td><span class="parametername">type</span></td>
  197. <td><p>the type of the parameter.</p>
  198. </td>
  199. </tr>
  200. <tr>
  201. <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameterNested.html">PluginInitInjector.InjectParameterNested</a></td>
  202. <td><span class="parametername">injector</span></td>
  203. <td><p>the function to call for injection.</p>
  204. </td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <span class="small pull-right mobile-hide">
  209. <span class="divider">|</span>
  210. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Loader_PluginInitInjector_Inject__1_IPA_Loader_PluginInitInjector_InjectedValueProvider_System_Reflection_ParameterInfo_.md&amp;value=---%0Auid%3A%20IPA.Loader.PluginInitInjector.Inject%60%601(IPA.Loader.PluginInitInjector.InjectedValueProvider%2CSystem.Reflection.ParameterInfo)%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>
  211. </span>
  212. <span class="small pull-right mobile-hide">
  213. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L92">View Source</a>
  214. </span>
  215. <a id="IPA_Loader_PluginInitInjector_Inject_" data-uid="IPA.Loader.PluginInitInjector.Inject*"></a>
  216. <h4 id="IPA_Loader_PluginInitInjector_Inject__1_IPA_Loader_PluginInitInjector_InjectedValueProvider_System_Reflection_ParameterInfo_" data-uid="IPA.Loader.PluginInitInjector.Inject``1(IPA.Loader.PluginInitInjector.InjectedValueProvider,System.Reflection.ParameterInfo)">Inject&lt;T&gt;(PluginInitInjector.InjectedValueProvider, ParameterInfo)</h4>
  217. <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>
  218. </div>
  219. <div class="markdown level1 conceptual"></div>
  220. <h5 class="decalaration">Declaration</h5>
  221. <div class="codewrapper">
  222. <pre><code class="lang-csharp hljs">public static T Inject&lt;T&gt;(this PluginInitInjector.InjectedValueProvider provider, ParameterInfo param)</code></pre>
  223. </div>
  224. <h5 class="parameters">Parameters</h5>
  225. <table class="table table-bordered table-striped table-condensed">
  226. <thead>
  227. <tr>
  228. <th>Type</th>
  229. <th>Name</th>
  230. <th>Description</th>
  231. </tr>
  232. </thead>
  233. <tbody>
  234. <tr>
  235. <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectedValueProvider.html">PluginInitInjector.InjectedValueProvider</a></td>
  236. <td><span class="parametername">provider</span></td>
  237. <td><p>the provider to invoke.</p>
  238. </td>
  239. </tr>
  240. <tr>
  241. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.reflection.parameterinfo">ParameterInfo</a></td>
  242. <td><span class="parametername">param</span></td>
  243. <td><p>the parameter to provide for</p>
  244. </td>
  245. </tr>
  246. </tbody>
  247. </table>
  248. <h5 class="returns">Returns</h5>
  249. <table class="table table-bordered table-striped table-condensed">
  250. <thead>
  251. <tr>
  252. <th>Type</th>
  253. <th>Description</th>
  254. </tr>
  255. </thead>
  256. <tbody>
  257. <tr>
  258. <td><span class="xref">T</span></td>
  259. <td><p>the value requested, or <span class="xref">null</span>.</p>
  260. </td>
  261. </tr>
  262. </tbody>
  263. </table>
  264. <h5 class="typeParameters">Type Parameters</h5>
  265. <table class="table table-bordered table-striped table-condensed">
  266. <thead>
  267. <tr>
  268. <th>Name</th>
  269. <th>Description</th>
  270. </tr>
  271. </thead>
  272. <tbody>
  273. <tr>
  274. <td><span class="parametername">T</span></td>
  275. <td><p>the type of object to be injected</p>
  276. </td>
  277. </tr>
  278. </tbody>
  279. </table>
  280. </article>
  281. </div>
  282. <div class="hidden-sm col-md-2" role="complementary">
  283. <div class="sideaffix">
  284. <div class="contribution">
  285. <ul class="nav">
  286. <li>
  287. <a href="https://github.com/bsmg/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>
  288. </li>
  289. <li>
  290. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L50" class="contribution-link">View Source</a>
  291. </li>
  292. </ul>
  293. </div>
  294. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  295. <h5>In This Article</h5>
  296. <div></div>
  297. </nav>
  298. </div>
  299. </div>
  300. </div>
  301. </div>
  302. <footer>
  303. <div class="grad-bottom"></div>
  304. <div class="footer">
  305. <div class="container">
  306. <span class="pull-right">
  307. <a href="#top">Back to top</a>
  308. </span>
  309. <span>Generated by <strong>DocFX</strong></span>
  310. </div>
  311. </div>
  312. </footer>
  313. </div>
  314. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  315. <script type="text/javascript" src="../styles/docfx.js"></script>
  316. <script type="text/javascript" src="../styles/main.js"></script>
  317. </body>
  318. </html>