DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Class PluginInitInjector   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Class PluginInitInjector   ">    <meta name="generator" content="docfx 2.58.9.0">        <link rel="shortcut icon" href="../favicon.ico">    <link rel="stylesheet" href="../styles/docfx.vendor.css">    <link rel="stylesheet" href="../styles/docfx.css">    <link rel="stylesheet" href="../styles/main.css">    <link rel="stylesheet" href="../styles/fix.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="../index.html">                <img id="logo" class="svg" src="../logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list">Search Results for <span></span></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid="IPA.Loader.PluginInitInjector">      <h1 id="IPA_Loader_PluginInitInjector" data-uid="IPA.Loader.PluginInitInjector" class="text-break">Class PluginInitInjector  </h1>  <div class="markdown level0 summary"><p>The type that handles value injecting into a plugin&apos;s initialization methods.</p></div>  <div class="markdown level0 conceptual"></div>  <div class="inheritance">    <h5>Inheritance</h5>    <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>    <div class="level1"><span class="xref">PluginInitInjector</span></div>  </div>  <div class="inheritedMembers">    <h5>Inherited Members</h5>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>    </div>    <div>      <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>    </div>    <div>      <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>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>    </div>    <div>      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>    </div>  </div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Loader.html">IPA.Loader</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Loader_PluginInitInjector_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static class PluginInitInjector</code></pre>  </div>  <h5 id="IPA_Loader_PluginInitInjector_remarks"><strong>Remarks</strong></h5>  <div class="markdown level0 remarks"><p>The default injectors and what they provide are shown in this table.<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><p>A <a class="xref" href="IPA.Config.Config.html">Config</a> object for the plugin being injected.</p><p>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 controlhow it is constructed.</p></td></tr></tbody></table>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></div>  <h3 id="methods">Methods  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/f6e80c44fe95a60b40ff85033e44507eb51ffe6c/IPA.Loader/Loader/PluginInitInjector.cs/#L100">View Source</a>  </span>  <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>  <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>  <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>        <td><span class="parametername">type</span></td>        <td><p>the type of the parameter.</p></td>      </tr>      <tr>        <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameter.html">PluginInitInjector.InjectParameter</a></td>        <td><span class="parametername">injector</span></td>        <td><p>the function to call for injection.</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/f6e80c44fe95a60b40ff85033e44507eb51ffe6c/IPA.Loader/Loader/PluginInitInjector.cs/#L108">View Source</a>  </span>  <a id="IPA_Loader_PluginInitInjector_AddInjector_" data-uid="IPA.Loader.PluginInitInjector.AddInjector*"></a>  <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>  <div class="markdown level1 summary"><p>Adds an injector to be used when calling future plugins&apos; Init methods.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static void AddInjector(Type type, PluginInitInjector.InjectParameterNested injector)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.type">Type</a></td>        <td><span class="parametername">type</span></td>        <td><p>the type of the parameter.</p></td>      </tr>      <tr>        <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectParameterNested.html">PluginInitInjector.InjectParameterNested</a></td>        <td><span class="parametername">injector</span></td>        <td><p>the function to call for injection.</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <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>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/f6e80c44fe95a60b40ff85033e44507eb51ffe6c/IPA.Loader/Loader/PluginInitInjector.cs/#L92">View Source</a>  </span>  <a id="IPA_Loader_PluginInitInjector_Inject_" data-uid="IPA.Loader.PluginInitInjector.Inject*"></a>  <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>  <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></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static T Inject&lt;T&gt;(this PluginInitInjector.InjectedValueProvider provider, ParameterInfo param)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Loader.PluginInitInjector.InjectedValueProvider.html">PluginInitInjector.InjectedValueProvider</a></td>        <td><span class="parametername">provider</span></td>        <td><p>the provider to invoke.</p></td>      </tr>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.reflection.parameterinfo">ParameterInfo</a></td>        <td><span class="parametername">param</span></td>        <td><p>the parameter to provide for</p></td>      </tr>    </tbody>  </table>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="xref">T</span></td>        <td><p>the value requested, or <span class="xref">null</span>.</p></td>      </tr>    </tbody>  </table>  <h5 class="typeParameters">Type Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="parametername">T</span></td>        <td><p>the type of object to be injected</p></td>      </tr>    </tbody>  </table></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <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>                  </li>                  <li>                    <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/f6e80c44fe95a60b40ff85033e44507eb51ffe6c/IPA.Loader/Loader/PluginInitInjector.cs/#L50" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">                <h5>In This Article</h5>                <div></div>              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="../styles/docfx.vendor.js"></script>    <script type="text/javascript" src="../styles/docfx.js"></script>    <script type="text/javascript" src="../styles/main.js"></script>  </body></html>