DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git
1
1
Fork 0
Code Issues 0 Projects 0 Releases 78 Wiki Activity
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.
323 Commits
9 Branches
188 MiB
Tree: 6324055eb0
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '6324055eb0'
${ noResults }
BeatSaber-IPA-Reloaded/api/IPA.Loader.PluginInitInject...

332 lines
17 KiB
Raw Normal View History

Generated Docs --
3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
3 years ago
Generated Docs --
3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
3 years ago
Generated Docs --
3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
3 years ago
Generated Docs --
3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Generated Docs --
3 years ago
Generated Docs --
3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4.   
  5.   <head>
  6.     <meta charset="utf-8">
  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  8.     <title>Class PluginInitInjector
  9.    </title>
  10.     <meta name="viewport" content="width=device-width">
  11.     <meta name="title" content="Class PluginInitInjector
  12.    ">
  13.     <meta name="generator" content="docfx 2.58.0.0">
  14.     
  15.     <link rel="shortcut icon" href="../favicon.ico">
  16.     <link rel="stylesheet" href="../styles/docfx.vendor.css">
  17.     <link rel="stylesheet" href="../styles/docfx.css">
  18.     <link rel="stylesheet" href="../styles/main.css">
  19.     <link rel="stylesheet" href="../styles/fix.css">
  20.     <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
  21.     <meta property="docfx:navrel" content="../toc.html">
  22.     <meta property="docfx:tocrel" content="toc.html">
  23.     
  24.     <meta property="docfx:rel" content="../">
  25.     <meta property="docfx:newtab" content="true">
  26.   </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
  27.     <div id="wrapper">
  28.       <header>
  29.         
  30.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  31.           <div class="container">
  32.             <div class="navbar-header">
  33.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  34.                 <span class="sr-only">Toggle navigation</span>
  35.                 <span class="icon-bar"></span>
  36.                 <span class="icon-bar"></span>
  37.                 <span class="icon-bar"></span>
  38.               </button>
  39.               
  40.               <a class="navbar-brand" href="../index.html">
  41.                 <img id="logo" class="svg" src="../logo.svg" alt="">
  42.               </a>
  43.             </div>
  44.             <div class="collapse navbar-collapse" id="navbar">
  45.               <form class="navbar-form navbar-right" role="search" id="search">
  46.                 <div class="form-group">
  47.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  48.                 </div>
  49.               </form>
  50.             </div>
  51.           </div>
  52.         </nav>
  53.         
  54.         <div class="subnav navbar navbar-default">
  55.           <div class="container hide-when-search" id="breadcrumb">
  56.             <ul class="breadcrumb">
  57.               <li></li>
  58.             </ul>
  59.           </div>
  60.         </div>
  61.       </header>
  62.       <div class="container body-content">
  63.         
  64.         <div id="search-results">
  65.           <div class="search-list">Search Results for <span></span></div>
  66.           <div class="sr-items">
  67.             <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  68.           </div>
  69.           <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  70.         </div>
  71.       </div>
  72.       <div role="main" class="container body-content hide-when-search">
  73.         
  74.         <div class="sidenav hide-when-search">
  75.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  76.           <div class="sidetoggle collapse" id="sidetoggle">
  77.             <div id="sidetoc"></div>
  78.           </div>
  79.         </div>
  80.         <div class="article row grid-right">
  81.           <div class="col-md-10">
  82.             <article class="content wrap" id="_content" data-uid="IPA.Loader.PluginInitInjector">
  83.   
  84.   
  85.   <h1 id="IPA_Loader_PluginInitInjector" data-uid="IPA.Loader.PluginInitInjector" class="text-break">Class PluginInitInjector
  86.   </h1>
  87.   <div class="markdown level0 summary"><p>The type that handles value injecting into a plugin&apos;s initialization methods.</p>
  88. </div>
  89.   <div class="markdown level0 conceptual"></div>
  90.   <div class="inheritance">
  91.     <h5>Inheritance</h5>
  92.     <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  93.     <div class="level1"><span class="xref">PluginInitInjector</span></div>
  94.   </div>
  95.   <div class="inheritedMembers">
  96.     <h5>Inherited Members</h5>
  97.     <div>
  98.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  99.     </div>
  100.     <div>
  101.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  102.     </div>
  103.     <div>
  104.       <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>
  105.     </div>
  106.     <div>
  107.       <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>
  108.     </div>
  109.     <div>
  110.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  111.     </div>
  112.     <div>
  113.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  114.     </div>
  115.     <div>
  116.       <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  117.     </div>
  118.   </div>
  119.   <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>
  120.   <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  121.   <h5 id="IPA_Loader_PluginInitInjector_syntax">Syntax</h5>
  122.   <div class="codewrapper">
  123.     <pre><code class="lang-csharp hljs">public static class PluginInitInjector</code></pre>
  124.   </div>
  125.   <h5 id="IPA_Loader_PluginInitInjector_remarks"><strong>Remarks</strong></h5>
  126.   <div class="markdown level0 remarks"><p>The default injectors and what they provide are shown in this table.
  127. <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>
  128. <p>A <a class="xref" href="IPA.Config.Config.html">Config</a> object for the plugin being injected.</p>
  129. <p>
  130. 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
  131. how it is constructed.
  132. </p>
  133. </td></tr></tbody></table>
  134. 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>
  135. </div>
  136.   <h3 id="methods">Methods
  137.   </h3>
  138.   <span class="small pull-right mobile-hide">
  139.     <span class="divider">|</span>
  140.     <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>
  141.   </span>
  142.   <span class="small pull-right mobile-hide">
  143.     <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L100">View Source</a>
  144.   </span>
  145.   <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>
  146.   <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>
  147.   <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p>
  148. </div>
  149.   <div class="markdown level1 conceptual"></div>
  150.   <h5 class="decalaration">Declaration</h5>
  151.   <div class="codewrapper">
  152.     <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector)</code></pre>
  153.   </div>
  154.   <h5 class="parameters">Parameters</h5>
  155.   <table class="table table-bordered table-striped table-condensed">
  156.     <thead>
  157.       <tr>
  158.         <th>Type</th>
  159.         <th>Name</th>
  160.         <th>Description</th>
  161.       </tr>
  162.     </thead>
  163.     <tbody>
  164.       <tr>
  165.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>
  166.         <td><span class="parametername">type</span></td>
  167.         <td><p>the type of the parameter.</p>
  168. </td>
  169.       </tr>
  170.       <tr>
  171.         <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameter.html">PluginInitInjector.InjectParameter</a></td>
  172.         <td><span class="parametername">injector</span></td>
  173.         <td><p>the function to call for injection.</p>
  174. </td>
  175.       </tr>
  176.     </tbody>
  177.   </table>
  178.   <span class="small pull-right mobile-hide">
  179.     <span class="divider">|</span>
  180.     <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>
  181.   </span>
  182.   <span class="small pull-right mobile-hide">
  183.     <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L108">View Source</a>
  184.   </span>
  185.   <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>
  186.   <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>
  187.   <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p>
  188. </div>
  189.   <div class="markdown level1 conceptual"></div>
  190.   <h5 class="decalaration">Declaration</h5>
  191.   <div class="codewrapper">
  192.     <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameterNested injector)</code></pre>
  193.   </div>
  194.   <h5 class="parameters">Parameters</h5>
  195.   <table class="table table-bordered table-striped table-condensed">
  196.     <thead>
  197.       <tr>
  198.         <th>Type</th>
  199.         <th>Name</th>
  200.         <th>Description</th>
  201.       </tr>
  202.     </thead>
  203.     <tbody>
  204.       <tr>
  205.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>
  206.         <td><span class="parametername">type</span></td>
  207.         <td><p>the type of the parameter.</p>
  208. </td>
  209.       </tr>
  210.       <tr>
  211.         <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameterNested.html">PluginInitInjector.InjectParameterNested</a></td>
  212.         <td><span class="parametername">injector</span></td>
  213.         <td><p>the function to call for injection.</p>
  214. </td>
  215.       </tr>
  216.     </tbody>
  217.   </table>
  218.   <span class="small pull-right mobile-hide">
  219.     <span class="divider">|</span>
  220.     <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>
  221.   </span>
  222.   <span class="small pull-right mobile-hide">
  223.     <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L92">View Source</a>
  224.   </span>
  225.   <a id="IPA_Loader_PluginInitInjector_Inject_" data-uid="IPA.Loader.PluginInitInjector.Inject*"></a>
  226.   <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>
  227.   <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>
  228. </div>
  229.   <div class="markdown level1 conceptual"></div>
  230.   <h5 class="decalaration">Declaration</h5>
  231.   <div class="codewrapper">
  232.     <pre><code class="lang-csharp hljs">public static T Inject&lt;T&gt;(this PluginInitInjector.InjectedValueProvider provider, ParameterInfo param)</code></pre>
  233.   </div>
  234.   <h5 class="parameters">Parameters</h5>
  235.   <table class="table table-bordered table-striped table-condensed">
  236.     <thead>
  237.       <tr>
  238.         <th>Type</th>
  239.         <th>Name</th>
  240.         <th>Description</th>
  241.       </tr>
  242.     </thead>
  243.     <tbody>
  244.       <tr>
  245.         <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectedValueProvider.html">PluginInitInjector.InjectedValueProvider</a></td>
  246.         <td><span class="parametername">provider</span></td>
  247.         <td><p>the provider to invoke.</p>
  248. </td>
  249.       </tr>
  250.       <tr>
  251.         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.reflection.parameterinfo">ParameterInfo</a></td>
  252.         <td><span class="parametername">param</span></td>
  253.         <td><p>the parameter to provide for</p>
  254. </td>
  255.       </tr>
  256.     </tbody>
  257.   </table>
  258.   <h5 class="returns">Returns</h5>
  259.   <table class="table table-bordered table-striped table-condensed">
  260.     <thead>
  261.       <tr>
  262.         <th>Type</th>
  263.         <th>Description</th>
  264.       </tr>
  265.     </thead>
  266.     <tbody>
  267.       <tr>
  268.         <td><span class="xref">T</span></td>
  269.         <td><p>the value requested, or <span class="xref">null</span>.</p>
  270. </td>
  271.       </tr>
  272.     </tbody>
  273.   </table>
  274.   <h5 class="typeParameters">Type Parameters</h5>
  275.   <table class="table table-bordered table-striped table-condensed">
  276.     <thead>
  277.       <tr>
  278.         <th>Name</th>
  279.         <th>Description</th>
  280.       </tr>
  281.     </thead>
  282.     <tbody>
  283.       <tr>
  284.         <td><span class="parametername">T</span></td>
  285.         <td><p>the type of object to be injected</p>
  286. </td>
  287.       </tr>
  288.     </tbody>
  289.   </table>
  290. </article>
  291.           </div>
  292.           
  293.           <div class="hidden-sm col-md-2" role="complementary">
  294.             <div class="sideaffix">
  295.               <div class="contribution">
  296.                 <ul class="nav">
  297.                   <li>
  298.                     <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>
  299.                   </li>
  300.                   <li>
  301.                     <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/7b6a755dcc8549f0e6f8e36b9ebdb2e7fc1647ff/IPA.Loader/Loader/PluginInitInjector.cs/#L50" class="contribution-link">View Source</a>
  302.                   </li>
  303.                 </ul>
  304.               </div>
  305.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  306.                 <h5>In This Article</h5>
  307.                 <div></div>
  308.               </nav>
  309.             </div>
  310.           </div>
  311.         </div>
  312.       </div>
  313.       
  314.       <footer>
  315.         <div class="grad-bottom"></div>
  316.         <div class="footer">
  317.           <div class="container">
  318.             <span class="pull-right">
  319.               <a href="#top">Back to top</a>
  320.             </span>
  321.             
  322.             <span>Generated by <strong>DocFX</strong></span>
  323.           </div>
  324.         </div>
  325.       </footer>
  326.     </div>
  327.     
  328.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  329.     <script type="text/javascript" src="../styles/docfx.js"></script>
  330.     <script type="text/javascript" src="../styles/main.js"></script>
  331.   </body>
  332. </html>