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.

366 lines
16 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.NameAttribute
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Config.NameAttribute
  11. ">
  12. <meta name="generator" content="docfx 2.42.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. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../index.html">
  33. <img id="logo" class="svg" src="../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="IPA.Config.Config.NameAttribute">
  63. <h1 id="IPA_Config_Config_NameAttribute" data-uid="IPA.Config.Config.NameAttribute" class="text-break">Class Config.NameAttribute
  64. </h1>
  65. <div class="markdown level0 summary"><p>Specifies a preferred config name, instead of using the plugin's name.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><span class="xref">System.Attribute</span></div>
  72. <div class="level2"><span class="xref">Config.NameAttribute</span></div>
  73. </div>
  74. <div classs="implements">
  75. <h5>Implements</h5>
  76. <div><span class="xref">System.Runtime.InteropServices._Attribute</span></div>
  77. </div>
  78. <div class="inheritedMembers">
  79. <h5>Inherited Members</h5>
  80. <div>
  81. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)</span>
  82. </div>
  83. <div>
  84. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  85. </div>
  86. <div>
  87. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)</span>
  106. </div>
  107. <div>
  108. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)</span>
  109. </div>
  110. <div>
  111. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  112. </div>
  113. <div>
  114. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)</span>
  115. </div>
  116. <div>
  117. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)</span>
  118. </div>
  119. <div>
  120. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  121. </div>
  122. <div>
  123. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)</span>
  124. </div>
  125. <div>
  126. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  127. </div>
  128. <div>
  129. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)</span>
  130. </div>
  131. <div>
  132. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module)</span>
  133. </div>
  134. <div>
  135. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)</span>
  136. </div>
  137. <div>
  138. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)</span>
  139. </div>
  140. <div>
  141. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type)</span>
  142. </div>
  143. <div>
  144. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)</span>
  145. </div>
  146. <div>
  147. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)</span>
  148. </div>
  149. <div>
  150. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)</span>
  151. </div>
  152. <div>
  153. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)</span>
  154. </div>
  155. <div>
  156. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  157. </div>
  158. <div>
  159. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly)</span>
  160. </div>
  161. <div>
  162. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)</span>
  163. </div>
  164. <div>
  165. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)</span>
  166. </div>
  167. <div>
  168. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  169. </div>
  170. <div>
  171. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)</span>
  172. </div>
  173. <div>
  174. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  175. </div>
  176. <div>
  177. <span class="xref">System.Attribute.Equals(System.Object)</span>
  178. </div>
  179. <div>
  180. <span class="xref">System.Attribute.GetHashCode()</span>
  181. </div>
  182. <div>
  183. <span class="xref">System.Attribute.Match(System.Object)</span>
  184. </div>
  185. <div>
  186. <span class="xref">System.Attribute.IsDefaultAttribute()</span>
  187. </div>
  188. <div>
  189. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfoCount(System.UInt32)</span>
  190. </div>
  191. <div>
  192. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfo(System.UInt32, System.UInt32, System.IntPtr)</span>
  193. </div>
  194. <div>
  195. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetIDsOfNames(System.Guid, System.IntPtr, System.UInt32, System.UInt32, System.IntPtr)</span>
  196. </div>
  197. <div>
  198. <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>
  199. </div>
  200. <div>
  201. <span class="xref">System.Attribute.TypeId</span>
  202. </div>
  203. <div>
  204. <span class="xref">System.Object.ToString()</span>
  205. </div>
  206. <div>
  207. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  208. </div>
  209. <div>
  210. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  211. </div>
  212. <div>
  213. <span class="xref">System.Object.GetType()</span>
  214. </div>
  215. <div>
  216. <span class="xref">System.Object.MemberwiseClone()</span>
  217. </div>
  218. </div>
  219. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  220. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  221. <h5 id="IPA_Config_Config_NameAttribute_syntax">Syntax</h5>
  222. <div class="codewrapper">
  223. <pre><code class="lang-csharp hljs">public class NameAttribute : Attribute, _Attribute</code></pre>
  224. </div>
  225. <h3 id="constructors">Constructors
  226. </h3>
  227. <span class="small pull-right mobile-hide">
  228. <span class="divider">|</span>
  229. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_Config_NameAttribute__ctor_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.Config.NameAttribute.%23ctor(System.String)%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>
  230. </span>
  231. <span class="small pull-right mobile-hide">
  232. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/Config.cs/#L86">View Source</a>
  233. </span>
  234. <a id="IPA_Config_Config_NameAttribute__ctor_" data-uid="IPA.Config.Config.NameAttribute.#ctor*"></a>
  235. <h4 id="IPA_Config_Config_NameAttribute__ctor_System_String_" data-uid="IPA.Config.Config.NameAttribute.#ctor(System.String)">NameAttribute(String)</h4>
  236. <div class="markdown level1 summary"><p>Constructs the attribute with a specific name.</p>
  237. </div>
  238. <div class="markdown level1 conceptual"></div>
  239. <h5 class="decalaration">Declaration</h5>
  240. <div class="codewrapper">
  241. <pre><code class="lang-csharp hljs">public NameAttribute(string name)</code></pre>
  242. </div>
  243. <h5 class="parameters">Parameters</h5>
  244. <table class="table table-bordered table-striped table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Type</th>
  248. <th>Name</th>
  249. <th>Description</th>
  250. </tr>
  251. </thead>
  252. <tbody>
  253. <tr>
  254. <td><span class="xref">System.String</span></td>
  255. <td><span class="parametername">name</span></td>
  256. <td><p>the name to use for the config.</p>
  257. </td>
  258. </tr>
  259. </tbody>
  260. </table>
  261. <h3 id="properties">Properties
  262. </h3>
  263. <span class="small pull-right mobile-hide">
  264. <span class="divider">|</span>
  265. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_Config_NameAttribute_Name.md&amp;value=---%0Auid%3A%20IPA.Config.Config.NameAttribute.Name%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>
  266. </span>
  267. <span class="small pull-right mobile-hide">
  268. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/Config.cs/#L79">View Source</a>
  269. </span>
  270. <a id="IPA_Config_Config_NameAttribute_Name_" data-uid="IPA.Config.Config.NameAttribute.Name*"></a>
  271. <h4 id="IPA_Config_Config_NameAttribute_Name" data-uid="IPA.Config.Config.NameAttribute.Name">Name</h4>
  272. <div class="markdown level1 summary"><p>The name to use for the config.</p>
  273. </div>
  274. <div class="markdown level1 conceptual"></div>
  275. <h5 class="decalaration">Declaration</h5>
  276. <div class="codewrapper">
  277. <pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>
  278. </div>
  279. <h5 class="propertyValue">Property Value</h5>
  280. <table class="table table-bordered table-striped table-condensed">
  281. <thead>
  282. <tr>
  283. <th>Type</th>
  284. <th>Description</th>
  285. </tr>
  286. </thead>
  287. <tbody>
  288. <tr>
  289. <td><span class="xref">System.String</span></td>
  290. <td></td>
  291. </tr>
  292. </tbody>
  293. </table>
  294. <h3 id="implements">Implements</h3>
  295. <div>
  296. <span class="xref">System.Runtime.InteropServices._Attribute</span>
  297. </div>
  298. <h3 id="extensionmethods">Extension Methods</h3>
  299. <div>
  300. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetPrivateField__1_System_Object_System_String_">ReflectionUtil.GetPrivateField&lt;T&gt;(Object, String)</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  307. </div>
  308. <div>
  309. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  310. </div>
  311. <div>
  312. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod&lt;T&gt;(Object, String, Object[])</a>
  313. </div>
  314. </article>
  315. </div>
  316. <div class="hidden-sm col-md-2" role="complementary">
  317. <div class="sideaffix">
  318. <div class="contribution">
  319. <ul class="nav">
  320. <li>
  321. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Config_Config_NameAttribute.md&amp;value=---%0Auid%3A%20IPA.Config.Config.NameAttribute%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>
  322. </li>
  323. <li>
  324. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Config/Config.cs/#L73" class="contribution-link">View Source</a>
  325. </li>
  326. </ul>
  327. </div>
  328. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  329. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  330. </nav>
  331. </div>
  332. </div>
  333. </div>
  334. </div>
  335. <footer>
  336. <div class="grad-bottom"></div>
  337. <div class="footer">
  338. <div class="container">
  339. <span class="pull-right">
  340. <a href="#top">Back to top</a>
  341. </span>
  342. <span>Generated by <strong>DocFX</strong></span>
  343. </div>
  344. </div>
  345. </footer>
  346. </div>
  347. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  348. <script type="text/javascript" src="../styles/docfx.js"></script>
  349. <script type="text/javascript" src="../styles/main.js"></script>
  350. </body>
  351. </html>