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.

642 lines
32 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 Map
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Map
  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.Data.Map">
  75. <h1 id="IPA_Config_Data_Map" data-uid="IPA.Config.Data.Map" class="text-break">Class Map
  76. </h1>
  77. <div class="markdown level0 summary"><p>A ordered map of <see cref="!:System.String"></see> to <a class="xref" href="IPA.Config.Data.Value.html">Value</a> for serialization by an <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a>.
  78. Use <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Map">Map()</a> or <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_IDictionary_System_String_IPA_Config_Data_Value__">From(IDictionary&lt;String, Value&gt;)</a> to create.</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"><a class="xref" href="IPA.Config.Data.Value.html">Value</a></div>
  85. <div class="level2"><span class="xref">Map</span></div>
  86. </div>
  87. <div class="implements">
  88. <h5>Implements</h5>
  89. <div><span class="xref">IDictionary</span>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, <a class="xref" href="IPA.Config.Data.Value.html">Value</a>&gt;</div>
  90. </div>
  91. <div class="inheritedMembers">
  92. <h5>Inherited Members</h5>
  93. <div>
  94. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Null">Value.Null()</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_List">Value.List()</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Map">Value.Map()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Nullable_System_String__">Value.From(Nullable&lt;String&gt;)</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Text_System_Nullable_System_String__">Value.Text(Nullable&lt;String&gt;)</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Int64_">Value.From(Int64)</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Integer_System_Int64_">Value.Integer(Int64)</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Decimal_">Value.From(Decimal)</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Float_System_Decimal_">Value.Float(Decimal)</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Boolean_">Value.From(Boolean)</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Bool_System_Boolean_">Value.Bool(Boolean)</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Nullable_IEnumerable_IPA_Config_Data_Value___">Value.From(Nullable&lt;IEnumerable&lt;Value&gt;&gt;)</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_IDictionary_System_String_IPA_Config_Data_Value__">Value.From(IDictionary&lt;String, Value&gt;)</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Nullable_IEnumerable_KeyValuePair_System_String_IPA_Config_Data_Value____">Value.From(Nullable&lt;IEnumerable&lt;KeyValuePair&lt;String, Value&gt;&gt;&gt;)</a>
  134. </div>
  135. </div>
  136. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Data.html">IPA.Config.Data</a></h6>
  137. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  138. <h5 id="IPA_Config_Data_Map_syntax">Syntax</h5>
  139. <div class="codewrapper">
  140. <pre><code class="lang-csharp hljs">public sealed class Map : Value</code></pre>
  141. </div>
  142. <h3 id="properties">Properties
  143. </h3>
  144. <span class="small pull-right mobile-hide">
  145. <span class="divider">|</span>
  146. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_Count.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.Count%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>
  147. </span>
  148. <span class="small pull-right mobile-hide">
  149. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L49">View Source</a>
  150. </span>
  151. <a id="IPA_Config_Data_Map_Count_" data-uid="IPA.Config.Data.Map.Count*"></a>
  152. <h4 id="IPA_Config_Data_Map_Count" data-uid="IPA.Config.Data.Map.Count">Count</h4>
  153. <div class="markdown level1 summary"><p>Gets the number of key-value pairs in this <a class="xref" href="IPA.Config.Data.Map.html">Map</a>.</p>
  154. </div>
  155. <div class="markdown level1 conceptual"></div>
  156. <h5 class="decalaration">Declaration</h5>
  157. <div class="codewrapper">
  158. <pre><code class="lang-csharp hljs">public int Count { get; }</code></pre>
  159. </div>
  160. <h5 class="propertyValue">Property Value</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
  171. <td></td>
  172. </tr>
  173. </tbody>
  174. </table>
  175. <span class="small pull-right mobile-hide">
  176. <span class="divider">|</span>
  177. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_Item_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.Item(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>
  178. </span>
  179. <span class="small pull-right mobile-hide">
  180. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L27">View Source</a>
  181. </span>
  182. <a id="IPA_Config_Data_Map_Item_" data-uid="IPA.Config.Data.Map.Item*"></a>
  183. <h4 id="IPA_Config_Data_Map_Item_System_String_" data-uid="IPA.Config.Data.Map.Item(System.String)">Item[String]</h4>
  184. <div class="markdown level1 summary"><p>Accesses the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> at <code data-dev-comment-type="paramref" class="paramref">key</code> in the map.</p>
  185. </div>
  186. <div class="markdown level1 conceptual"></div>
  187. <h5 class="decalaration">Declaration</h5>
  188. <div class="codewrapper">
  189. <pre><code class="lang-csharp hljs">public Value this[string key] { get; set; }</code></pre>
  190. </div>
  191. <h5 class="parameters">Parameters</h5>
  192. <table class="table table-bordered table-striped table-condensed">
  193. <thead>
  194. <tr>
  195. <th>Type</th>
  196. <th>Name</th>
  197. <th>Description</th>
  198. </tr>
  199. </thead>
  200. <tbody>
  201. <tr>
  202. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  203. <td><span class="parametername">key</span></td>
  204. <td><p>the key to get the value associated with</p>
  205. </td>
  206. </tr>
  207. </tbody>
  208. </table>
  209. <h5 class="propertyValue">Property Value</h5>
  210. <table class="table table-bordered table-striped table-condensed">
  211. <thead>
  212. <tr>
  213. <th>Type</th>
  214. <th>Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  220. <td><p>the value associated with the <code data-dev-comment-type="paramref" class="paramref">key</code></p>
  221. </td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. <span class="small pull-right mobile-hide">
  226. <span class="divider">|</span>
  227. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_Keys.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.Keys%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>
  228. </span>
  229. <span class="small pull-right mobile-hide">
  230. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L33">View Source</a>
  231. </span>
  232. <a id="IPA_Config_Data_Map_Keys_" data-uid="IPA.Config.Data.Map.Keys*"></a>
  233. <h4 id="IPA_Config_Data_Map_Keys" data-uid="IPA.Config.Data.Map.Keys">Keys</h4>
  234. <div class="markdown level1 summary"><p>Gets a collection of the keys for the <a class="xref" href="IPA.Config.Data.Map.html">Map</a>.</p>
  235. </div>
  236. <div class="markdown level1 conceptual"></div>
  237. <h5 class="decalaration">Declaration</h5>
  238. <div class="codewrapper">
  239. <pre><code class="lang-csharp hljs">public ICollection&lt;string&gt; Keys { get; }</code></pre>
  240. </div>
  241. <h5 class="propertyValue">Property Value</h5>
  242. <table class="table table-bordered table-striped table-condensed">
  243. <thead>
  244. <tr>
  245. <th>Type</th>
  246. <th>Description</th>
  247. </tr>
  248. </thead>
  249. <tbody>
  250. <tr>
  251. <td><span class="xref">ICollection</span>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>&gt;</td>
  252. <td></td>
  253. </tr>
  254. </tbody>
  255. </table>
  256. <span class="small pull-right mobile-hide">
  257. <span class="divider">|</span>
  258. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_Values.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.Values%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>
  259. </span>
  260. <span class="small pull-right mobile-hide">
  261. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L43">View Source</a>
  262. </span>
  263. <a id="IPA_Config_Data_Map_Values_" data-uid="IPA.Config.Data.Map.Values*"></a>
  264. <h4 id="IPA_Config_Data_Map_Values" data-uid="IPA.Config.Data.Map.Values">Values</h4>
  265. <div class="markdown level1 summary"><p>Gets a collection of the values in the <a class="xref" href="IPA.Config.Data.Map.html">Map</a>.</p>
  266. </div>
  267. <div class="markdown level1 conceptual"></div>
  268. <h5 class="decalaration">Declaration</h5>
  269. <div class="codewrapper">
  270. <pre><code class="lang-csharp hljs">public ICollection&lt;Value&gt; Values { get; }</code></pre>
  271. </div>
  272. <h5 class="propertyValue">Property Value</h5>
  273. <table class="table table-bordered table-striped table-condensed">
  274. <thead>
  275. <tr>
  276. <th>Type</th>
  277. <th>Description</th>
  278. </tr>
  279. </thead>
  280. <tbody>
  281. <tr>
  282. <td><span class="xref">ICollection</span>&lt;<a class="xref" href="IPA.Config.Data.Value.html">Value</a>&gt;</td>
  283. <td></td>
  284. </tr>
  285. </tbody>
  286. </table>
  287. <h5 id="IPA_Config_Data_Map_Values_remarks">Remarks</h5>
  288. <div class="markdown level1 remarks"><p>Unlike all other iterables given by <a class="xref" href="IPA.Config.Data.Map.html">Map</a>, this does <em>not</em>
  289. guarantee that order is maintained.</p>
  290. </div>
  291. <h3 id="methods">Methods
  292. </h3>
  293. <span class="small pull-right mobile-hide">
  294. <span class="divider">|</span>
  295. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_Add_System_String_IPA_Config_Data_Value_.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.Add(System.String%2CIPA.Config.Data.Value)%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>
  296. </span>
  297. <span class="small pull-right mobile-hide">
  298. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L59">View Source</a>
  299. </span>
  300. <a id="IPA_Config_Data_Map_Add_" data-uid="IPA.Config.Data.Map.Add*"></a>
  301. <h4 id="IPA_Config_Data_Map_Add_System_String_IPA_Config_Data_Value_" data-uid="IPA.Config.Data.Map.Add(System.String,IPA.Config.Data.Value)">Add(String, Value)</h4>
  302. <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="IPA.Config.Data.Value.html">Value</a> with a given key.</p>
  303. </div>
  304. <div class="markdown level1 conceptual"></div>
  305. <h5 class="decalaration">Declaration</h5>
  306. <div class="codewrapper">
  307. <pre><code class="lang-csharp hljs">public void Add(string key, Value value)</code></pre>
  308. </div>
  309. <h5 class="parameters">Parameters</h5>
  310. <table class="table table-bordered table-striped table-condensed">
  311. <thead>
  312. <tr>
  313. <th>Type</th>
  314. <th>Name</th>
  315. <th>Description</th>
  316. </tr>
  317. </thead>
  318. <tbody>
  319. <tr>
  320. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  321. <td><span class="parametername">key</span></td>
  322. <td><p>the key to put the value at</p>
  323. </td>
  324. </tr>
  325. <tr>
  326. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  327. <td><span class="parametername">value</span></td>
  328. <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to add</p>
  329. </td>
  330. </tr>
  331. </tbody>
  332. </table>
  333. <span class="small pull-right mobile-hide">
  334. <span class="divider">|</span>
  335. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_Clear.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.Clear%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>
  336. </span>
  337. <span class="small pull-right mobile-hide">
  338. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L72">View Source</a>
  339. </span>
  340. <a id="IPA_Config_Data_Map_Clear_" data-uid="IPA.Config.Data.Map.Clear*"></a>
  341. <h4 id="IPA_Config_Data_Map_Clear" data-uid="IPA.Config.Data.Map.Clear">Clear()</h4>
  342. <div class="markdown level1 summary"><p>Clears the <a class="xref" href="IPA.Config.Data.Map.html">Map</a> of its key-value pairs.</p>
  343. </div>
  344. <div class="markdown level1 conceptual"></div>
  345. <h5 class="decalaration">Declaration</h5>
  346. <div class="codewrapper">
  347. <pre><code class="lang-csharp hljs">public void Clear()</code></pre>
  348. </div>
  349. <span class="small pull-right mobile-hide">
  350. <span class="divider">|</span>
  351. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_ContainsKey_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.ContainsKey(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>
  352. </span>
  353. <span class="small pull-right mobile-hide">
  354. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L87">View Source</a>
  355. </span>
  356. <a id="IPA_Config_Data_Map_ContainsKey_" data-uid="IPA.Config.Data.Map.ContainsKey*"></a>
  357. <h4 id="IPA_Config_Data_Map_ContainsKey_System_String_" data-uid="IPA.Config.Data.Map.ContainsKey(System.String)">ContainsKey(String)</h4>
  358. <div class="markdown level1 summary"><p>Checks if the <a class="xref" href="IPA.Config.Data.Map.html">Map</a> contains a given <code data-dev-comment-type="paramref" class="paramref">key</code>.</p>
  359. </div>
  360. <div class="markdown level1 conceptual"></div>
  361. <h5 class="decalaration">Declaration</h5>
  362. <div class="codewrapper">
  363. <pre><code class="lang-csharp hljs">public bool ContainsKey(string key)</code></pre>
  364. </div>
  365. <h5 class="parameters">Parameters</h5>
  366. <table class="table table-bordered table-striped table-condensed">
  367. <thead>
  368. <tr>
  369. <th>Type</th>
  370. <th>Name</th>
  371. <th>Description</th>
  372. </tr>
  373. </thead>
  374. <tbody>
  375. <tr>
  376. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  377. <td><span class="parametername">key</span></td>
  378. <td><p>the key to check for</p>
  379. </td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <h5 class="returns">Returns</h5>
  384. <table class="table table-bordered table-striped table-condensed">
  385. <thead>
  386. <tr>
  387. <th>Type</th>
  388. <th>Description</th>
  389. </tr>
  390. </thead>
  391. <tbody>
  392. <tr>
  393. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  394. <td><span class="xref">true</span> if the key exists, otherwise <span class="xref">false</span></td>
  395. </tr>
  396. </tbody>
  397. </table>
  398. <span class="small pull-right mobile-hide">
  399. <span class="divider">|</span>
  400. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_GetEnumerator.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.GetEnumerator%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>
  401. </span>
  402. <span class="small pull-right mobile-hide">
  403. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L97">View Source</a>
  404. </span>
  405. <a id="IPA_Config_Data_Map_GetEnumerator_" data-uid="IPA.Config.Data.Map.GetEnumerator*"></a>
  406. <h4 id="IPA_Config_Data_Map_GetEnumerator" data-uid="IPA.Config.Data.Map.GetEnumerator">GetEnumerator()</h4>
  407. <div class="markdown level1 summary"><p>Enumerates the <a class="xref" href="IPA.Config.Data.Map.html">Map</a>&apos;s key-value pairs.</p>
  408. </div>
  409. <div class="markdown level1 conceptual"></div>
  410. <h5 class="decalaration">Declaration</h5>
  411. <div class="codewrapper">
  412. <pre><code class="lang-csharp hljs">public IEnumerator&lt;KeyValuePair&lt;string, Value&gt;&gt; GetEnumerator()</code></pre>
  413. </div>
  414. <h5 class="returns">Returns</h5>
  415. <table class="table table-bordered table-striped table-condensed">
  416. <thead>
  417. <tr>
  418. <th>Type</th>
  419. <th>Description</th>
  420. </tr>
  421. </thead>
  422. <tbody>
  423. <tr>
  424. <td><span class="xref">IEnumerator</span>&lt;<span class="xref">KeyValuePair</span>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, <a class="xref" href="IPA.Config.Data.Value.html">Value</a>&gt;&gt;</td>
  425. <td><p>an <see cref="!:IEnumerator&lt;T>"></see> of key-value pairs in this <a class="xref" href="IPA.Config.Data.Map.html">Map</a></p>
  426. </td>
  427. </tr>
  428. </tbody>
  429. </table>
  430. <span class="small pull-right mobile-hide">
  431. <span class="divider">|</span>
  432. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_Remove_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.Remove(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>
  433. </span>
  434. <span class="small pull-right mobile-hide">
  435. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L109">View Source</a>
  436. </span>
  437. <a id="IPA_Config_Data_Map_Remove_" data-uid="IPA.Config.Data.Map.Remove*"></a>
  438. <h4 id="IPA_Config_Data_Map_Remove_System_String_" data-uid="IPA.Config.Data.Map.Remove(System.String)">Remove(String)</h4>
  439. <div class="markdown level1 summary"><p>Removes the object associated with a key in this <a class="xref" href="IPA.Config.Data.Map.html">Map</a>.</p>
  440. </div>
  441. <div class="markdown level1 conceptual"></div>
  442. <h5 class="decalaration">Declaration</h5>
  443. <div class="codewrapper">
  444. <pre><code class="lang-csharp hljs">public bool Remove(string key)</code></pre>
  445. </div>
  446. <h5 class="parameters">Parameters</h5>
  447. <table class="table table-bordered table-striped table-condensed">
  448. <thead>
  449. <tr>
  450. <th>Type</th>
  451. <th>Name</th>
  452. <th>Description</th>
  453. </tr>
  454. </thead>
  455. <tbody>
  456. <tr>
  457. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  458. <td><span class="parametername">key</span></td>
  459. <td><p>the key to remove</p>
  460. </td>
  461. </tr>
  462. </tbody>
  463. </table>
  464. <h5 class="returns">Returns</h5>
  465. <table class="table table-bordered table-striped table-condensed">
  466. <thead>
  467. <tr>
  468. <th>Type</th>
  469. <th>Description</th>
  470. </tr>
  471. </thead>
  472. <tbody>
  473. <tr>
  474. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  475. <td><p><span class="xref">true</span> if the key existed, <span class="xref">false</span> otherwise</p>
  476. </td>
  477. </tr>
  478. </tbody>
  479. </table>
  480. <span class="small pull-right mobile-hide">
  481. <span class="divider">|</span>
  482. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_ToString.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.ToString%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>
  483. </span>
  484. <span class="small pull-right mobile-hide">
  485. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L129">View Source</a>
  486. </span>
  487. <a id="IPA_Config_Data_Map_ToString_" data-uid="IPA.Config.Data.Map.ToString*"></a>
  488. <h4 id="IPA_Config_Data_Map_ToString" data-uid="IPA.Config.Data.Map.ToString">ToString()</h4>
  489. <div class="markdown level1 summary"><p>Converts this <a class="xref" href="IPA.Config.Data.Value.html">Value</a> into a human-readable format.</p>
  490. </div>
  491. <div class="markdown level1 conceptual"></div>
  492. <h5 class="decalaration">Declaration</h5>
  493. <div class="codewrapper">
  494. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  495. </div>
  496. <h5 class="returns">Returns</h5>
  497. <table class="table table-bordered table-striped table-condensed">
  498. <thead>
  499. <tr>
  500. <th>Type</th>
  501. <th>Description</th>
  502. </tr>
  503. </thead>
  504. <tbody>
  505. <tr>
  506. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  507. <td><p>a JSON-like set of key-value pairs</p>
  508. </td>
  509. </tr>
  510. </tbody>
  511. </table>
  512. <h5 class="overrides">Overrides</h5>
  513. <div><a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_ToString">Value.ToString()</a></div>
  514. <span class="small pull-right mobile-hide">
  515. <span class="divider">|</span>
  516. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map_TryGetValue_System_String_IPA_Config_Data_Value__.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map.TryGetValue(System.String%2CIPA.Config.Data.Value%40)%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>
  517. </span>
  518. <span class="small pull-right mobile-hide">
  519. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L121">View Source</a>
  520. </span>
  521. <a id="IPA_Config_Data_Map_TryGetValue_" data-uid="IPA.Config.Data.Map.TryGetValue*"></a>
  522. <h4 id="IPA_Config_Data_Map_TryGetValue_System_String_IPA_Config_Data_Value__" data-uid="IPA.Config.Data.Map.TryGetValue(System.String,IPA.Config.Data.Value@)">TryGetValue(String, out Value)</h4>
  523. <div class="markdown level1 summary"><p>Gets the value associated with the specified key.</p>
  524. </div>
  525. <div class="markdown level1 conceptual"></div>
  526. <h5 class="decalaration">Declaration</h5>
  527. <div class="codewrapper">
  528. <pre><code class="lang-csharp hljs">public bool TryGetValue(string key, out Value value)</code></pre>
  529. </div>
  530. <h5 class="parameters">Parameters</h5>
  531. <table class="table table-bordered table-striped table-condensed">
  532. <thead>
  533. <tr>
  534. <th>Type</th>
  535. <th>Name</th>
  536. <th>Description</th>
  537. </tr>
  538. </thead>
  539. <tbody>
  540. <tr>
  541. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  542. <td><span class="parametername">key</span></td>
  543. <td><p>the key of the value to get</p>
  544. </td>
  545. </tr>
  546. <tr>
  547. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  548. <td><span class="parametername">value</span></td>
  549. <td><p>the target location of the retrieved object</p>
  550. </td>
  551. </tr>
  552. </tbody>
  553. </table>
  554. <h5 class="returns">Returns</h5>
  555. <table class="table table-bordered table-striped table-condensed">
  556. <thead>
  557. <tr>
  558. <th>Type</th>
  559. <th>Description</th>
  560. </tr>
  561. </thead>
  562. <tbody>
  563. <tr>
  564. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  565. <td><p><span class="xref">true</span> if the key was found and <code data-dev-comment-type="paramref" class="paramref">value</code> set, <span class="xref">false</span> otherwise</p>
  566. </td>
  567. </tr>
  568. </tbody>
  569. </table>
  570. <h3 id="implements">Implements</h3>
  571. <div>
  572. <span class="xref">IDictionary&lt;, &gt;</span>
  573. </div>
  574. <h3 id="extensionmethods">Extension Methods</h3>
  575. <div>
  576. <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>
  577. </div>
  578. <div>
  579. <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>
  580. </div>
  581. <div>
  582. <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>
  583. </div>
  584. <div>
  585. <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>
  586. </div>
  587. <div>
  588. <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>
  589. </div>
  590. </article>
  591. </div>
  592. <div class="hidden-sm col-md-2" role="complementary">
  593. <div class="sideaffix">
  594. <div class="contribution">
  595. <ul class="nav">
  596. <li>
  597. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Map.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Map%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>
  598. </li>
  599. <li>
  600. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Map.cs/#L14" class="contribution-link">View Source</a>
  601. </li>
  602. </ul>
  603. </div>
  604. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  605. <h5>In This Article</h5>
  606. <div></div>
  607. </nav>
  608. </div>
  609. </div>
  610. </div>
  611. </div>
  612. <footer>
  613. <div class="grad-bottom"></div>
  614. <div class="footer">
  615. <div class="container">
  616. <span class="pull-right">
  617. <a href="#top">Back to top</a>
  618. </span>
  619. <span>Generated by <strong>DocFX</strong></span>
  620. </div>
  621. </div>
  622. </footer>
  623. </div>
  624. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  625. <script type="text/javascript" src="../styles/docfx.js"></script>
  626. <script type="text/javascript" src="../styles/main.js"></script>
  627. </body>
  628. </html>