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.

229 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.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.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.NameAttribute">
  75. <h1 id="IPA_Config_Config_NameAttribute" data-uid="IPA.Config.Config.NameAttribute" class="text-break">Class Config.NameAttribute
  76. </h1>
  77. <div class="markdown level0 summary"><p>Specifies a preferred config name, instead of using the plugin&apos;s name.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><span class="xref">Config.NameAttribute</span></div>
  84. </div>
  85. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  86. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  87. <h5 id="IPA_Config_Config_NameAttribute_syntax">Syntax</h5>
  88. <div class="codewrapper">
  89. <pre><code class="lang-csharp hljs">public sealed class NameAttribute : Attribute</code></pre>
  90. </div>
  91. <h3 id="constructors">Constructors
  92. </h3>
  93. <span class="small pull-right mobile-hide">
  94. <span class="divider">|</span>
  95. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  96. </span>
  97. <span class="small pull-right mobile-hide">
  98. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Config.cs/#L72">View Source</a>
  99. </span>
  100. <a id="IPA_Config_Config_NameAttribute__ctor_" data-uid="IPA.Config.Config.NameAttribute.#ctor*"></a>
  101. <h4 id="IPA_Config_Config_NameAttribute__ctor_System_String_" data-uid="IPA.Config.Config.NameAttribute.#ctor(System.String)">NameAttribute(String)</h4>
  102. <div class="markdown level1 summary"><p>Constructs the attribute with a specific name.</p>
  103. </div>
  104. <div class="markdown level1 conceptual"></div>
  105. <h5 class="decalaration">Declaration</h5>
  106. <div class="codewrapper">
  107. <pre><code class="lang-csharp hljs">public NameAttribute(string name)</code></pre>
  108. </div>
  109. <h5 class="parameters">Parameters</h5>
  110. <table class="table table-bordered table-striped table-condensed">
  111. <thead>
  112. <tr>
  113. <th>Type</th>
  114. <th>Name</th>
  115. <th>Description</th>
  116. </tr>
  117. </thead>
  118. <tbody>
  119. <tr>
  120. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  121. <td><span class="parametername">name</span></td>
  122. <td><p>the name to use for the config.</p>
  123. </td>
  124. </tr>
  125. </tbody>
  126. </table>
  127. <h3 id="properties">Properties
  128. </h3>
  129. <span class="small pull-right mobile-hide">
  130. <span class="divider">|</span>
  131. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  132. </span>
  133. <span class="small pull-right mobile-hide">
  134. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Config.cs/#L65">View Source</a>
  135. </span>
  136. <a id="IPA_Config_Config_NameAttribute_Name_" data-uid="IPA.Config.Config.NameAttribute.Name*"></a>
  137. <h4 id="IPA_Config_Config_NameAttribute_Name" data-uid="IPA.Config.Config.NameAttribute.Name">Name</h4>
  138. <div class="markdown level1 summary"><p>The name to use for the config.</p>
  139. </div>
  140. <div class="markdown level1 conceptual"></div>
  141. <h5 class="decalaration">Declaration</h5>
  142. <div class="codewrapper">
  143. <pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>
  144. </div>
  145. <h5 class="propertyValue">Property Value</h5>
  146. <table class="table table-bordered table-striped table-condensed">
  147. <thead>
  148. <tr>
  149. <th>Type</th>
  150. <th>Description</th>
  151. </tr>
  152. </thead>
  153. <tbody>
  154. <tr>
  155. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  156. <td><p>the name to use for the config</p>
  157. </td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <h3 id="extensionmethods">Extension Methods</h3>
  162. <div>
  163. <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>
  164. </div>
  165. <div>
  166. <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>
  167. </div>
  168. <div>
  169. <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>
  170. </div>
  171. <div>
  172. <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>
  173. </div>
  174. <div>
  175. <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>
  176. </div>
  177. </article>
  178. </div>
  179. <div class="hidden-sm col-md-2" role="complementary">
  180. <div class="sideaffix">
  181. <div class="contribution">
  182. <ul class="nav">
  183. <li>
  184. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/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>
  185. </li>
  186. <li>
  187. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Config/Config.cs/#L57" class="contribution-link">View Source</a>
  188. </li>
  189. </ul>
  190. </div>
  191. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  192. <h5>In This Article</h5>
  193. <div></div>
  194. </nav>
  195. </div>
  196. </div>
  197. </div>
  198. </div>
  199. <footer>
  200. <div class="grad-bottom"></div>
  201. <div class="footer">
  202. <div class="container">
  203. <span class="pull-right">
  204. <a href="#top">Back to top</a>
  205. </span>
  206. <span>Generated by <strong>DocFX</strong></span>
  207. </div>
  208. </div>
  209. </footer>
  210. </div>
  211. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  212. <script type="text/javascript" src="../styles/docfx.js"></script>
  213. <script type="text/javascript" src="../styles/main.js"></script>
  214. </body>
  215. </html>