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.

381 lines
17 KiB

4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
  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.4.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"><span class="xref">System.Object</span></div>
  84. <div class="level1"><span class="xref">System.Attribute</span></div>
  85. <div class="level2"><span class="xref">Config.PreferAttribute</span></div>
  86. </div>
  87. <div class="implements">
  88. <h5>Implements</h5>
  89. <div><span class="xref">System.Runtime.InteropServices._Attribute</span></div>
  90. </div>
  91. <div class="inheritedMembers">
  92. <h5>Inherited Members</h5>
  93. <div>
  94. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  110. </div>
  111. <div>
  112. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)</span>
  113. </div>
  114. <div>
  115. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  116. </div>
  117. <div>
  118. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)</span>
  119. </div>
  120. <div>
  121. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)</span>
  122. </div>
  123. <div>
  124. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  125. </div>
  126. <div>
  127. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)</span>
  128. </div>
  129. <div>
  130. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)</span>
  131. </div>
  132. <div>
  133. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  134. </div>
  135. <div>
  136. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)</span>
  137. </div>
  138. <div>
  139. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  140. </div>
  141. <div>
  142. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)</span>
  143. </div>
  144. <div>
  145. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module)</span>
  146. </div>
  147. <div>
  148. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)</span>
  149. </div>
  150. <div>
  151. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)</span>
  152. </div>
  153. <div>
  154. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type)</span>
  155. </div>
  156. <div>
  157. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)</span>
  158. </div>
  159. <div>
  160. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)</span>
  161. </div>
  162. <div>
  163. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)</span>
  164. </div>
  165. <div>
  166. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)</span>
  167. </div>
  168. <div>
  169. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  170. </div>
  171. <div>
  172. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly)</span>
  173. </div>
  174. <div>
  175. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)</span>
  176. </div>
  177. <div>
  178. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)</span>
  179. </div>
  180. <div>
  181. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  182. </div>
  183. <div>
  184. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)</span>
  185. </div>
  186. <div>
  187. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  188. </div>
  189. <div>
  190. <span class="xref">System.Attribute.Equals(System.Object)</span>
  191. </div>
  192. <div>
  193. <span class="xref">System.Attribute.GetHashCode()</span>
  194. </div>
  195. <div>
  196. <span class="xref">System.Attribute.Match(System.Object)</span>
  197. </div>
  198. <div>
  199. <span class="xref">System.Attribute.IsDefaultAttribute()</span>
  200. </div>
  201. <div>
  202. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfoCount(System.UInt32)</span>
  203. </div>
  204. <div>
  205. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfo(System.UInt32, System.UInt32, System.IntPtr)</span>
  206. </div>
  207. <div>
  208. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetIDsOfNames(System.Guid, System.IntPtr, System.UInt32, System.UInt32, System.IntPtr)</span>
  209. </div>
  210. <div>
  211. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.Invoke(System.UInt32, System.Guid, System.UInt32, System.Int16, System.IntPtr, System.IntPtr, System.IntPtr, System.IntPtr)</span>
  212. </div>
  213. <div>
  214. <span class="xref">System.Attribute.TypeId</span>
  215. </div>
  216. <div>
  217. <span class="xref">System.Object.ToString()</span>
  218. </div>
  219. <div>
  220. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  221. </div>
  222. <div>
  223. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  224. </div>
  225. <div>
  226. <span class="xref">System.Object.GetType()</span>
  227. </div>
  228. <div>
  229. <span class="xref">System.Object.MemberwiseClone()</span>
  230. </div>
  231. </div>
  232. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  233. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  234. <h5 id="IPA_Config_Config_PreferAttribute_syntax">Syntax</h5>
  235. <div class="codewrapper">
  236. <pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Parameter)]
  237. public sealed class PreferAttribute : Attribute, _Attribute</code></pre>
  238. </div>
  239. <h3 id="constructors">Constructors
  240. </h3>
  241. <span class="small pull-right mobile-hide">
  242. <span class="divider">|</span>
  243. <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>
  244. </span>
  245. <span class="small pull-right mobile-hide">
  246. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Config/Config.cs/#L48">View Source</a>
  247. </span>
  248. <a id="IPA_Config_Config_PreferAttribute__ctor_" data-uid="IPA.Config.Config.PreferAttribute.#ctor*"></a>
  249. <h4 id="IPA_Config_Config_PreferAttribute__ctor_System_String___" data-uid="IPA.Config.Config.PreferAttribute.#ctor(System.String[])">PreferAttribute(String[])</h4>
  250. <div class="markdown level1 summary"><p>Constructs the attribute with a specific preference list. Each entry is the extension without a &apos;.&apos;</p>
  251. </div>
  252. <div class="markdown level1 conceptual"></div>
  253. <h5 class="decalaration">Declaration</h5>
  254. <div class="codewrapper">
  255. <pre><code class="lang-csharp hljs">public PreferAttribute(params string[] preference)</code></pre>
  256. </div>
  257. <h5 class="parameters">Parameters</h5>
  258. <table class="table table-bordered table-striped table-condensed">
  259. <thead>
  260. <tr>
  261. <th>Type</th>
  262. <th>Name</th>
  263. <th>Description</th>
  264. </tr>
  265. </thead>
  266. <tbody>
  267. <tr>
  268. <td><span class="xref">System.String</span>[]</td>
  269. <td><span class="parametername">preference</span></td>
  270. <td><p>The preferences in order of preference.</p>
  271. </td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <h3 id="properties">Properties
  276. </h3>
  277. <span class="small pull-right mobile-hide">
  278. <span class="divider">|</span>
  279. <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>
  280. </span>
  281. <span class="small pull-right mobile-hide">
  282. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Config/Config.cs/#L41">View Source</a>
  283. </span>
  284. <a id="IPA_Config_Config_PreferAttribute_PreferenceOrder_" data-uid="IPA.Config.Config.PreferAttribute.PreferenceOrder*"></a>
  285. <h4 id="IPA_Config_Config_PreferAttribute_PreferenceOrder" data-uid="IPA.Config.Config.PreferAttribute.PreferenceOrder">PreferenceOrder</h4>
  286. <div class="markdown level1 summary"><p>The order of preference for the config type. </p>
  287. </div>
  288. <div class="markdown level1 conceptual"></div>
  289. <h5 class="decalaration">Declaration</h5>
  290. <div class="codewrapper">
  291. <pre><code class="lang-csharp hljs">public string[] PreferenceOrder { get; }</code></pre>
  292. </div>
  293. <h5 class="propertyValue">Property Value</h5>
  294. <table class="table table-bordered table-striped table-condensed">
  295. <thead>
  296. <tr>
  297. <th>Type</th>
  298. <th>Description</th>
  299. </tr>
  300. </thead>
  301. <tbody>
  302. <tr>
  303. <td><span class="xref">System.String</span>[]</td>
  304. <td><p>the list of config extensions in order of preference</p>
  305. </td>
  306. </tr>
  307. </tbody>
  308. </table>
  309. <h3 id="implements">Implements</h3>
  310. <div>
  311. <span class="xref">System.Runtime.InteropServices._Attribute</span>
  312. </div>
  313. <h3 id="extensionmethods">Extension Methods</h3>
  314. <div>
  315. <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>
  316. </div>
  317. <div>
  318. <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>
  319. </div>
  320. <div>
  321. <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>
  322. </div>
  323. <div>
  324. <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>
  325. </div>
  326. <div>
  327. <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>
  328. </div>
  329. </article>
  330. </div>
  331. <div class="hidden-sm col-md-2" role="complementary">
  332. <div class="sideaffix">
  333. <div class="contribution">
  334. <ul class="nav">
  335. <li>
  336. <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>
  337. </li>
  338. <li>
  339. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Config/Config.cs/#L33" class="contribution-link">View Source</a>
  340. </li>
  341. </ul>
  342. </div>
  343. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  344. <h5>In This Article</h5>
  345. <div></div>
  346. </nav>
  347. </div>
  348. </div>
  349. </div>
  350. </div>
  351. <footer>
  352. <div class="grad-bottom"></div>
  353. <div class="footer">
  354. <div class="container">
  355. <span class="pull-right">
  356. <a href="#top">Back to top</a>
  357. </span>
  358. <span>Generated by <strong>DocFX</strong></span>
  359. </div>
  360. </div>
  361. </footer>
  362. </div>
  363. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  364. <script type="text/javascript" src="../styles/docfx.js"></script>
  365. <script type="text/javascript" src="../styles/main.js"></script>
  366. </body>
  367. </html>