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.

312 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.43.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 href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../">
  21. <meta property="docfx:newtab" content="true">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../index.html">
  35. <img id="logo" class="svg" src="../logo.svg" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list"></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="IPA.Logging.Printers.ColoredConsolePrinter">
  74. <h1 id="IPA_Logging_Printers_ColoredConsolePrinter" data-uid="IPA.Logging.Printers.ColoredConsolePrinter" class="text-break">Class ColoredConsolePrinter
  75. </h1>
  76. <div class="markdown level0 summary"><p>Prints a pretty message to the console.</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  82. <div class="level1"><a class="xref" href="IPA.Logging.LogPrinter.html">LogPrinter</a></div>
  83. <div class="level2"><span class="xref">ColoredConsolePrinter</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_StartPrint">LogPrinter.StartPrint()</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_EndPrint">LogPrinter.EndPrint()</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  98. </div>
  99. <div>
  100. <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>
  101. </div>
  102. <div>
  103. <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>
  104. </div>
  105. <div>
  106. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  113. </div>
  114. </div>
  115. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.Printers.html">IPA.Logging.Printers</a></h6>
  116. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  117. <h5 id="IPA_Logging_Printers_ColoredConsolePrinter_syntax">Syntax</h5>
  118. <div class="codewrapper">
  119. <pre><code class="lang-csharp hljs">public class ColoredConsolePrinter : LogPrinter</code></pre>
  120. </div>
  121. <h3 id="properties">Properties
  122. </h3>
  123. <span class="small pull-right mobile-hide">
  124. <span class="divider">|</span>
  125. <a href="https://github.com/beat-saber-modding-group/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>
  126. </span>
  127. <span class="small pull-right mobile-hide">
  128. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L22">View Source</a>
  129. </span>
  130. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Color_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Color*"></a>
  131. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter_Color" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Color">Color</h4>
  132. <div class="markdown level1 summary"><p>The color to print messages as.</p>
  133. </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 ConsoleColor Color { get; set; }</code></pre>
  138. </div>
  139. <h5 class="propertyValue">Property Value</h5>
  140. <table class="table table-bordered table-striped table-condensed">
  141. <thead>
  142. <tr>
  143. <th>Type</th>
  144. <th>Description</th>
  145. </tr>
  146. </thead>
  147. <tbody>
  148. <tr>
  149. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.consolecolor">ConsoleColor</a></td>
  150. <td><p>the color to print this message as</p>
  151. </td>
  152. </tr>
  153. </tbody>
  154. </table>
  155. <span class="small pull-right mobile-hide">
  156. <span class="divider">|</span>
  157. <a href="https://github.com/beat-saber-modding-group/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>
  158. </span>
  159. <span class="small pull-right mobile-hide">
  160. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L17">View Source</a>
  161. </span>
  162. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Filter_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Filter*"></a>
  163. <h4 id="IPA_Logging_Printers_ColoredConsolePrinter_Filter" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Filter">Filter</h4>
  164. <div class="markdown level1 summary"><p>A filter for this specific printer.</p>
  165. </div>
  166. <div class="markdown level1 conceptual"></div>
  167. <h5 class="decalaration">Declaration</h5>
  168. <div class="codewrapper">
  169. <pre><code class="lang-csharp hljs">public override Logger.LogLevel Filter { get; set; }</code></pre>
  170. </div>
  171. <h5 class="propertyValue">Property Value</h5>
  172. <table class="table table-bordered table-striped table-condensed">
  173. <thead>
  174. <tr>
  175. <th>Type</th>
  176. <th>Description</th>
  177. </tr>
  178. </thead>
  179. <tbody>
  180. <tr>
  181. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  182. <td><p>the filter to apply to this printer</p>
  183. </td>
  184. </tr>
  185. </tbody>
  186. </table>
  187. <h5 class="overrides">Overrides</h5>
  188. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a></div>
  189. <h3 id="methods">Methods
  190. </h3>
  191. <span class="small pull-right mobile-hide">
  192. <span class="divider">|</span>
  193. <a href="https://github.com/beat-saber-modding-group/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>
  194. </span>
  195. <span class="small pull-right mobile-hide">
  196. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L31">View Source</a>
  197. </span>
  198. <a id="IPA_Logging_Printers_ColoredConsolePrinter_Print_" data-uid="IPA.Logging.Printers.ColoredConsolePrinter.Print*"></a>
  199. <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>
  200. <div class="markdown level1 summary"><p>Prints an entry to the console window.</p>
  201. </div>
  202. <div class="markdown level1 conceptual"></div>
  203. <h5 class="decalaration">Declaration</h5>
  204. <div class="codewrapper">
  205. <pre><code class="lang-csharp hljs">public override void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  206. </div>
  207. <h5 class="parameters">Parameters</h5>
  208. <table class="table table-bordered table-striped table-condensed">
  209. <thead>
  210. <tr>
  211. <th>Type</th>
  212. <th>Name</th>
  213. <th>Description</th>
  214. </tr>
  215. </thead>
  216. <tbody>
  217. <tr>
  218. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  219. <td><span class="parametername">level</span></td>
  220. <td><p>the <a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a> of the message</p>
  221. </td>
  222. </tr>
  223. <tr>
  224. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.datetime">DateTime</a></td>
  225. <td><span class="parametername">time</span></td>
  226. <td><p>the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.datetime">DateTime</a> the message was recorded at</p>
  227. </td>
  228. </tr>
  229. <tr>
  230. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  231. <td><span class="parametername">logName</span></td>
  232. <td><p>the name of the log that sent the message</p>
  233. </td>
  234. </tr>
  235. <tr>
  236. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  237. <td><span class="parametername">message</span></td>
  238. <td><p>the message to print</p>
  239. </td>
  240. </tr>
  241. </tbody>
  242. </table>
  243. <h5 class="overrides">Overrides</h5>
  244. <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>
  245. <h3 id="extensionmethods">Extension Methods</h3>
  246. <div>
  247. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  248. </div>
  249. <div>
  250. <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>
  251. </div>
  252. <div>
  253. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  254. </div>
  255. <div>
  256. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  257. </div>
  258. <div>
  259. <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>
  260. </div>
  261. </article>
  262. </div>
  263. <div class="hidden-sm col-md-2" role="complementary">
  264. <div class="sideaffix">
  265. <div class="contribution">
  266. <ul class="nav">
  267. <li>
  268. <a href="https://github.com/beat-saber-modding-group/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>
  269. </li>
  270. <li>
  271. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/ColoredConsolePrinter.cs/#L9" class="contribution-link">View Source</a>
  272. </li>
  273. </ul>
  274. </div>
  275. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  276. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  277. </nav>
  278. </div>
  279. </div>
  280. </div>
  281. </div>
  282. <footer>
  283. <div class="grad-bottom"></div>
  284. <div class="footer">
  285. <div class="container">
  286. <span class="pull-right">
  287. <a href="#top">Back to top</a>
  288. </span>
  289. <span>Generated by <strong>DocFX</strong></span>
  290. </div>
  291. </div>
  292. </footer>
  293. </div>
  294. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  295. <script type="text/javascript" src="../styles/docfx.js"></script>
  296. <script type="text/javascript" src="../styles/main.js"></script>
  297. </body>
  298. </html>