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.

363 lines
19 KiB

11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 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 ColoredConsolePrinter
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ColoredConsolePrinter
  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.Logging.Printers.ColoredConsolePrinter">
  75. <h1 id="IPA_Logging_Printers_ColoredConsolePrinter" data-uid="IPA.Logging.Printers.ColoredConsolePrinter" class="text-break">Class ColoredConsolePrinter
  76. </h1>
  77. <div class="markdown level0 summary"><p>Prints a pretty message to the console.</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://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><a class="xref" href="IPA.Logging.LogPrinter.html">LogPrinter</a></div>
  84. <div class="level2"><span class="xref">ColoredConsolePrinter</span></div>
  85. </div>
  86. <div class="inheritedMembers">
  87. <h5>Inherited Members</h5>
  88. <div>
  89. <a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_StartPrint">LogPrinter.StartPrint()</a>
  90. </div>
  91. <div>
  92. <a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_EndPrint">LogPrinter.EndPrint()</a>
  93. </div>
  94. <div>
  95. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
  114. </div>
  115. </div>
  116. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.Printers.html">IPA.Logging.Printers</a></h6>
  117. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  118. <h5 id="IPA_Logging_Printers_ColoredConsolePrinter_syntax">Syntax</h5>
  119. <div class="codewrapper">
  120. <pre><code class="lang-csharp hljs">public class ColoredConsolePrinter : LogPrinter</code></pre>
  121. </div>
  122. <h3 id="constructors">Constructors
  123. </h3>
  124. <span class="small pull-right mobile-hide">
  125. <span class="divider">|</span>
  126. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_ColoredConsolePrinter__ctor.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.ColoredConsolePrinter.%23ctor%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>
  127. </span>
  128. <span class="small pull-right mobile-hide">
  129. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/145879a186f99170142886b7ed04f5660fada830/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L44">View Source</a>
  130. </span>
  131. <a id="IPA_Logging_Printers_ColoredConsolePrinter__ctor_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.#ctor*"></a>
  132. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter__ctor" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.#ctor">ColoredConsolePrinter()</h4>
  133. <div class="markdown level1 summary"></div>
  134. <div class="markdown level1 conceptual"></div>
  135. <h5 class="decalaration">Declaration</h5>
  136. <div class="codewrapper">
  137. <pre><code class="lang-csharp hljs">public ColoredConsolePrinter()</code></pre>
  138. </div>
  139. <span class="small pull-right mobile-hide">
  140. <span class="divider">|</span>
  141. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_ColoredConsolePrinter__ctor_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.ColoredConsolePrinter.%23ctor(System.Boolean)%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>
  142. </span>
  143. <span class="small pull-right mobile-hide">
  144. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/145879a186f99170142886b7ed04f5660fada830/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L49">View Source</a>
  145. </span>
  146. <a id="IPA_Logging_Printers_ColoredConsolePrinter__ctor_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.#ctor*"></a>
  147. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter__ctor_System_Boolean_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.#ctor(System.Boolean)">ColoredConsolePrinter(Boolean)</h4>
  148. <div class="markdown level1 summary"></div>
  149. <div class="markdown level1 conceptual"></div>
  150. <h5 class="decalaration">Declaration</h5>
  151. <div class="codewrapper">
  152. <pre><code class="lang-csharp hljs">public ColoredConsolePrinter(bool darkenMessages)</code></pre>
  153. </div>
  154. <h5 class="parameters">Parameters</h5>
  155. <table class="table table-bordered table-striped table-condensed">
  156. <thead>
  157. <tr>
  158. <th>Type</th>
  159. <th>Name</th>
  160. <th>Description</th>
  161. </tr>
  162. </thead>
  163. <tbody>
  164. <tr>
  165. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  166. <td><span class="parametername">darkenMessages</span></td>
  167. <td></td>
  168. </tr>
  169. </tbody>
  170. </table>
  171. <h3 id="properties">Properties
  172. </h3>
  173. <span class="small pull-right mobile-hide">
  174. <span class="divider">|</span>
  175. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_ColoredConsolePrinter_Color.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.ColoredConsolePrinter.Color%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>
  176. </span>
  177. <span class="small pull-right mobile-hide">
  178. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/145879a186f99170142886b7ed04f5660fada830/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L24">View Source</a>
  179. </span>
  180. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Color_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Color*"></a>
  181. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter_Color" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Color">Color</h4>
  182. <div class="markdown level1 summary"><p>The color to print messages as.</p>
  183. </div>
  184. <div class="markdown level1 conceptual"></div>
  185. <h5 class="decalaration">Declaration</h5>
  186. <div class="codewrapper">
  187. <pre><code class="lang-csharp hljs">public ConsoleColor Color { get; set; }</code></pre>
  188. </div>
  189. <h5 class="propertyValue">Property Value</h5>
  190. <table class="table table-bordered table-striped table-condensed">
  191. <thead>
  192. <tr>
  193. <th>Type</th>
  194. <th>Description</th>
  195. </tr>
  196. </thead>
  197. <tbody>
  198. <tr>
  199. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.consolecolor">ConsoleColor</a></td>
  200. <td><p>the color to print this message as</p>
  201. </td>
  202. </tr>
  203. </tbody>
  204. </table>
  205. <span class="small pull-right mobile-hide">
  206. <span class="divider">|</span>
  207. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_ColoredConsolePrinter_Filter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.ColoredConsolePrinter.Filter%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>
  208. </span>
  209. <span class="small pull-right mobile-hide">
  210. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/145879a186f99170142886b7ed04f5660fada830/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L18">View Source</a>
  211. </span>
  212. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Filter_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Filter*"></a>
  213. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter_Filter" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Filter">Filter</h4>
  214. <div class="markdown level1 summary"><p>A filter for this specific printer.</p>
  215. </div>
  216. <div class="markdown level1 conceptual"></div>
  217. <h5 class="decalaration">Declaration</h5>
  218. <div class="codewrapper">
  219. <pre><code class="lang-csharp hljs">public override Logger.LogLevel Filter { get; set; }</code></pre>
  220. </div>
  221. <h5 class="propertyValue">Property Value</h5>
  222. <table class="table table-bordered table-striped table-condensed">
  223. <thead>
  224. <tr>
  225. <th>Type</th>
  226. <th>Description</th>
  227. </tr>
  228. </thead>
  229. <tbody>
  230. <tr>
  231. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  232. <td><p>the filter to apply to this printer</p>
  233. </td>
  234. </tr>
  235. </tbody>
  236. </table>
  237. <h5 class="overrides">Overrides</h5>
  238. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a></div>
  239. <h3 id="methods">Methods
  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_Logging_Printers_ColoredConsolePrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.ColoredConsolePrinter.Print(IPA.Logging.Logger.Level%2CSystem.DateTime%2CSystem.String%2CSystem.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>
  244. </span>
  245. <span class="small pull-right mobile-hide">
  246. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/145879a186f99170142886b7ed04f5660fada830/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L62">View Source</a>
  247. </span>
  248. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Print_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Print*"></a>
  249. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Print(IPA.Logging.Logger.Level,System.DateTime,System.String,System.String)">Print(Logger.Level, DateTime, String, String)</h4>
  250. <div class="markdown level1 summary"><p>Prints an entry to the console window.</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 override void Print(Logger.Level level, DateTime time, string logName, string message)</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><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  269. <td><span class="parametername">level</span></td>
  270. <td><p>the <a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a> of the message</p>
  271. </td>
  272. </tr>
  273. <tr>
  274. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetime">DateTime</a></td>
  275. <td><span class="parametername">time</span></td>
  276. <td><p>the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetime">DateTime</a> the message was recorded at</p>
  277. </td>
  278. </tr>
  279. <tr>
  280. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
  281. <td><span class="parametername">logName</span></td>
  282. <td><p>the name of the log that sent the message</p>
  283. </td>
  284. </tr>
  285. <tr>
  286. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
  287. <td><span class="parametername">message</span></td>
  288. <td><p>the message to print</p>
  289. </td>
  290. </tr>
  291. </tbody>
  292. </table>
  293. <h5 class="overrides">Overrides</h5>
  294. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_">LogPrinter.Print(Logger.Level, DateTime, String, String)</a></div>
  295. <h3 id="extensionmethods">Extension Methods</h3>
  296. <div>
  297. <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>
  298. </div>
  299. <div>
  300. <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>
  301. </div>
  302. <div>
  303. <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>
  304. </div>
  305. <div>
  306. <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>
  307. </div>
  308. <div>
  309. <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>
  310. </div>
  311. </article>
  312. </div>
  313. <div class="hidden-sm col-md-2" role="complementary">
  314. <div class="sideaffix">
  315. <div class="contribution">
  316. <ul class="nav">
  317. <li>
  318. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_ColoredConsolePrinter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.ColoredConsolePrinter%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>
  319. </li>
  320. <li>
  321. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/145879a186f99170142886b7ed04f5660fada830/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L10" class="contribution-link">View Source</a>
  322. </li>
  323. </ul>
  324. </div>
  325. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  326. <h5>In This Article</h5>
  327. <div></div>
  328. </nav>
  329. </div>
  330. </div>
  331. </div>
  332. </div>
  333. <footer>
  334. <div class="grad-bottom"></div>
  335. <div class="footer">
  336. <div class="container">
  337. <span class="pull-right">
  338. <a href="#top">Back to top</a>
  339. </span>
  340. <span>Generated by <strong>DocFX</strong></span>
  341. </div>
  342. </div>
  343. </footer>
  344. </div>
  345. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  346. <script type="text/javascript" src="../styles/docfx.js"></script>
  347. <script type="text/javascript" src="../styles/main.js"></script>
  348. </body>
  349. </html>