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.

230 lines
11 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 Config.PreferAttribute
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Config.PreferAttribute
  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.Config.Config.PreferAttribute">
  75. <h1 id="IPA_Config_Config_PreferAttribute" data-uid="IPA.Config.Config.PreferAttribute" class="text-break">Class Config.PreferAttribute
  76. </h1>
  77. <div class="markdown level0 summary"><p>Specifies that a particular parameter is preferred to use a particular <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a>.
  78. If it is not available, also specifies backups. If none are available, the default is used.</p>
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  84. <div class="level1"><span class="xref">Config.PreferAttribute</span></div>
  85. </div>
  86. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  87. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  88. <h5 id="IPA_Config_Config_PreferAttribute_syntax">Syntax</h5>
  89. <div class="codewrapper">
  90. <pre><code class="lang-csharp hljs">public sealed class PreferAttribute : Attribute</code></pre>
  91. </div>
  92. <h3 id="constructors">Constructors
  93. </h3>
  94. <span class="small pull-right mobile-hide">
  95. <span class="divider">|</span>
  96. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_PreferAttribute__ctor_System_String___.md&amp;value=---%0Auid%3A%20IPA.Config.Config.PreferAttribute.%23ctor(System.String%5B%5D)%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>
  97. </span>
  98. <span class="small pull-right mobile-hide">
  99. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Config.cs/#L48">View Source</a>
  100. </span>
  101. <a id="IPA_Config_Config_PreferAttribute__ctor_" data-uid="IPA.Config.Config.PreferAttribute.#ctor*"></a>
  102. <h4 id="IPA_Config_Config_PreferAttribute__ctor_System_String___" data-uid="IPA.Config.Config.PreferAttribute.#ctor(System.String[])">PreferAttribute(String[])</h4>
  103. <div class="markdown level1 summary"><p>Constructs the attribute with a specific preference list. Each entry is the extension without a &apos;.&apos;</p>
  104. </div>
  105. <div class="markdown level1 conceptual"></div>
  106. <h5 class="decalaration">Declaration</h5>
  107. <div class="codewrapper">
  108. <pre><code class="lang-csharp hljs">public PreferAttribute(params string[] preference)</code></pre>
  109. </div>
  110. <h5 class="parameters">Parameters</h5>
  111. <table class="table table-bordered table-striped table-condensed">
  112. <thead>
  113. <tr>
  114. <th>Type</th>
  115. <th>Name</th>
  116. <th>Description</th>
  117. </tr>
  118. </thead>
  119. <tbody>
  120. <tr>
  121. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>[]</td>
  122. <td><span class="parametername">preference</span></td>
  123. <td><p>The preferences in order of preference.</p>
  124. </td>
  125. </tr>
  126. </tbody>
  127. </table>
  128. <h3 id="properties">Properties
  129. </h3>
  130. <span class="small pull-right mobile-hide">
  131. <span class="divider">|</span>
  132. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_PreferAttribute_PreferenceOrder.md&amp;value=---%0Auid%3A%20IPA.Config.Config.PreferAttribute.PreferenceOrder%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>
  133. </span>
  134. <span class="small pull-right mobile-hide">
  135. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Config.cs/#L41">View Source</a>
  136. </span>
  137. <a id="IPA_Config_Config_PreferAttribute_PreferenceOrder_" data-uid="IPA.Config.Config.PreferAttribute.PreferenceOrder*"></a>
  138. <h4 id="IPA_Config_Config_PreferAttribute_PreferenceOrder" data-uid="IPA.Config.Config.PreferAttribute.PreferenceOrder">PreferenceOrder</h4>
  139. <div class="markdown level1 summary"><p>The order of preference for the config type. </p>
  140. </div>
  141. <div class="markdown level1 conceptual"></div>
  142. <h5 class="decalaration">Declaration</h5>
  143. <div class="codewrapper">
  144. <pre><code class="lang-csharp hljs">public string[] PreferenceOrder { get; }</code></pre>
  145. </div>
  146. <h5 class="propertyValue">Property Value</h5>
  147. <table class="table table-bordered table-striped table-condensed">
  148. <thead>
  149. <tr>
  150. <th>Type</th>
  151. <th>Description</th>
  152. </tr>
  153. </thead>
  154. <tbody>
  155. <tr>
  156. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>[]</td>
  157. <td><p>the list of config extensions in order of preference</p>
  158. </td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <h3 id="extensionmethods">Extension Methods</h3>
  163. <div>
  164. <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>
  165. </div>
  166. <div>
  167. <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>
  168. </div>
  169. <div>
  170. <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>
  171. </div>
  172. <div>
  173. <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>
  174. </div>
  175. <div>
  176. <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>
  177. </div>
  178. </article>
  179. </div>
  180. <div class="hidden-sm col-md-2" role="complementary">
  181. <div class="sideaffix">
  182. <div class="contribution">
  183. <ul class="nav">
  184. <li>
  185. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Config_PreferAttribute.md&amp;value=---%0Auid%3A%20IPA.Config.Config.PreferAttribute%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>
  186. </li>
  187. <li>
  188. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Config.cs/#L33" class="contribution-link">View Source</a>
  189. </li>
  190. </ul>
  191. </div>
  192. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  193. <h5>In This Article</h5>
  194. <div></div>
  195. </nav>
  196. </div>
  197. </div>
  198. </div>
  199. </div>
  200. <footer>
  201. <div class="grad-bottom"></div>
  202. <div class="footer">
  203. <div class="container">
  204. <span class="pull-right">
  205. <a href="#top">Back to top</a>
  206. </span>
  207. <span>Generated by <strong>DocFX</strong></span>
  208. </div>
  209. </div>
  210. </footer>
  211. </div>
  212. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  213. <script type="text/javascript" src="../styles/docfx.js"></script>
  214. <script type="text/javascript" src="../styles/main.js"></script>
  215. </body>
  216. </html>