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.

313 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 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.56.2.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"></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination"></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://docs.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://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="https://docs.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://docs.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://docs.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://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="https://docs.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="properties">Properties
  123. </h3>
  124. <span class="small pull-right mobile-hide">
  125. <span class="divider">|</span>
  126. <a href="https://github.com/bsmg/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>
  127. </span>
  128. <span class="small pull-right mobile-hide">
  129. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/83e06645d5bfeafe8c4701ed4f05a0d1c2202bd9/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L23">View Source</a>
  130. </span>
  131. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Color_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Color*"></a>
  132. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter_Color" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Color">Color</h4>
  133. <div class="markdown level1 summary"><p>The color to print messages as.</p>
  134. </div>
  135. <div class="markdown level1 conceptual"></div>
  136. <h5 class="decalaration">Declaration</h5>
  137. <div class="codewrapper">
  138. <pre><code class="lang-csharp hljs">public ConsoleColor Color { get; set; }</code></pre>
  139. </div>
  140. <h5 class="propertyValue">Property Value</h5>
  141. <table class="table table-bordered table-striped table-condensed">
  142. <thead>
  143. <tr>
  144. <th>Type</th>
  145. <th>Description</th>
  146. </tr>
  147. </thead>
  148. <tbody>
  149. <tr>
  150. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.consolecolor">ConsoleColor</a></td>
  151. <td><p>the color to print this message as</p>
  152. </td>
  153. </tr>
  154. </tbody>
  155. </table>
  156. <span class="small pull-right mobile-hide">
  157. <span class="divider">|</span>
  158. <a href="https://github.com/bsmg/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>
  159. </span>
  160. <span class="small pull-right mobile-hide">
  161. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/83e06645d5bfeafe8c4701ed4f05a0d1c2202bd9/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L17">View Source</a>
  162. </span>
  163. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Filter_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Filter*"></a>
  164. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter_Filter" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Filter">Filter</h4>
  165. <div class="markdown level1 summary"><p>A filter for this specific printer.</p>
  166. </div>
  167. <div class="markdown level1 conceptual"></div>
  168. <h5 class="decalaration">Declaration</h5>
  169. <div class="codewrapper">
  170. <pre><code class="lang-csharp hljs">public override Logger.LogLevel Filter { get; set; }</code></pre>
  171. </div>
  172. <h5 class="propertyValue">Property Value</h5>
  173. <table class="table table-bordered table-striped table-condensed">
  174. <thead>
  175. <tr>
  176. <th>Type</th>
  177. <th>Description</th>
  178. </tr>
  179. </thead>
  180. <tbody>
  181. <tr>
  182. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  183. <td><p>the filter to apply to this printer</p>
  184. </td>
  185. </tr>
  186. </tbody>
  187. </table>
  188. <h5 class="overrides">Overrides</h5>
  189. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a></div>
  190. <h3 id="methods">Methods
  191. </h3>
  192. <span class="small pull-right mobile-hide">
  193. <span class="divider">|</span>
  194. <a href="https://github.com/bsmg/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>
  195. </span>
  196. <span class="small pull-right mobile-hide">
  197. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/83e06645d5bfeafe8c4701ed4f05a0d1c2202bd9/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L32">View Source</a>
  198. </span>
  199. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Print_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Print*"></a>
  200. <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>
  201. <div class="markdown level1 summary"><p>Prints an entry to the console window.</p>
  202. </div>
  203. <div class="markdown level1 conceptual"></div>
  204. <h5 class="decalaration">Declaration</h5>
  205. <div class="codewrapper">
  206. <pre><code class="lang-csharp hljs">public override void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  207. </div>
  208. <h5 class="parameters">Parameters</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Type</th>
  213. <th>Name</th>
  214. <th>Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  220. <td><span class="parametername">level</span></td>
  221. <td><p>the <a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a> of the message</p>
  222. </td>
  223. </tr>
  224. <tr>
  225. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.datetime">DateTime</a></td>
  226. <td><span class="parametername">time</span></td>
  227. <td><p>the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.datetime">DateTime</a> the message was recorded at</p>
  228. </td>
  229. </tr>
  230. <tr>
  231. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  232. <td><span class="parametername">logName</span></td>
  233. <td><p>the name of the log that sent the message</p>
  234. </td>
  235. </tr>
  236. <tr>
  237. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  238. <td><span class="parametername">message</span></td>
  239. <td><p>the message to print</p>
  240. </td>
  241. </tr>
  242. </tbody>
  243. </table>
  244. <h5 class="overrides">Overrides</h5>
  245. <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>
  246. <h3 id="extensionmethods">Extension Methods</h3>
  247. <div>
  248. <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>
  249. </div>
  250. <div>
  251. <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>
  252. </div>
  253. <div>
  254. <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>
  255. </div>
  256. <div>
  257. <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>
  258. </div>
  259. <div>
  260. <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>
  261. </div>
  262. </article>
  263. </div>
  264. <div class="hidden-sm col-md-2" role="complementary">
  265. <div class="sideaffix">
  266. <div class="contribution">
  267. <ul class="nav">
  268. <li>
  269. <a href="https://github.com/bsmg/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>
  270. </li>
  271. <li>
  272. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/83e06645d5bfeafe8c4701ed4f05a0d1c2202bd9/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L9" class="contribution-link">View Source</a>
  273. </li>
  274. </ul>
  275. </div>
  276. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  277. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  278. </nav>
  279. </div>
  280. </div>
  281. </div>
  282. </div>
  283. <footer>
  284. <div class="grad-bottom"></div>
  285. <div class="footer">
  286. <div class="container">
  287. <span class="pull-right">
  288. <a href="#top">Back to top</a>
  289. </span>
  290. <span>Generated by <strong>DocFX</strong></span>
  291. </div>
  292. </div>
  293. </footer>
  294. </div>
  295. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  296. <script type="text/javascript" src="../styles/docfx.js"></script>
  297. <script type="text/javascript" src="../styles/main.js"></script>
  298. </body>
  299. </html>