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.

306 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 LogPrinter
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class LogPrinter
  11. ">
  12. <meta name="generator" content="docfx 2.42.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 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.LogPrinter">
  74. <h1 id="IPA_Logging_LogPrinter" data-uid="IPA.Logging.LogPrinter" class="text-break">Class LogPrinter
  75. </h1>
  76. <div class="markdown level0 summary"><p>The log printer&apos;s base class.</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"><span class="xref">LogPrinter</span></div>
  83. <div class="level2"><a class="xref" href="IPA.Logging.Printers.ColoredConsolePrinter.html">ColoredConsolePrinter</a></div>
  84. <div class="level2"><a class="xref" href="IPA.Logging.Printers.ColorlessConsolePrinter.html">ColorlessConsolePrinter</a></div>
  85. <div class="level2"><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html">GZFilePrinter</a></div>
  86. </div>
  87. <div class="inheritedMembers">
  88. <h5>Inherited Members</h5>
  89. <div>
  90. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  94. </div>
  95. <div>
  96. <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>
  97. </div>
  98. <div>
  99. <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>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  109. </div>
  110. </div>
  111. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.html">IPA.Logging</a></h6>
  112. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  113. <h5 id="IPA_Logging_LogPrinter_syntax">Syntax</h5>
  114. <div class="codewrapper">
  115. <pre><code class="lang-csharp hljs">public abstract class LogPrinter</code></pre>
  116. </div>
  117. <h3 id="properties">Properties
  118. </h3>
  119. <span class="small pull-right mobile-hide">
  120. <span class="divider">|</span>
  121. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter_Filter.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.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>
  122. </span>
  123. <span class="small pull-right mobile-hide">
  124. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ee55fb9ffdb7102004729b186c0269c09be9f6b7/IPA.Loader/Logging/LogPrinter.cs/#L14">View Source</a>
  125. </span>
  126. <a id="IPA_Logging_LogPrinter_Filter_" data-uid="IPA.Logging.LogPrinter.Filter*"></a>
  127. <h4 id="IPA_Logging_LogPrinter_Filter" data-uid="IPA.Logging.LogPrinter.Filter">Filter</h4>
  128. <div class="markdown level1 summary"><p>Provides a filter for which log levels to allow through.</p>
  129. </div>
  130. <div class="markdown level1 conceptual"></div>
  131. <h5 class="decalaration">Declaration</h5>
  132. <div class="codewrapper">
  133. <pre><code class="lang-csharp hljs">public abstract Logger.LogLevel Filter { get; set; }</code></pre>
  134. </div>
  135. <h5 class="propertyValue">Property Value</h5>
  136. <table class="table table-bordered table-striped table-condensed">
  137. <thead>
  138. <tr>
  139. <th>Type</th>
  140. <th>Description</th>
  141. </tr>
  142. </thead>
  143. <tbody>
  144. <tr>
  145. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  146. <td><p>the level to filter to</p>
  147. </td>
  148. </tr>
  149. </tbody>
  150. </table>
  151. <h3 id="methods">Methods
  152. </h3>
  153. <span class="small pull-right mobile-hide">
  154. <span class="divider">|</span>
  155. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter_EndPrint.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.EndPrint%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>
  156. </span>
  157. <span class="small pull-right mobile-hide">
  158. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ee55fb9ffdb7102004729b186c0269c09be9f6b7/IPA.Loader/Logging/LogPrinter.cs/#L35">View Source</a>
  159. </span>
  160. <a id="IPA_Logging_LogPrinter_EndPrint_" data-uid="IPA.Logging.LogPrinter.EndPrint*"></a>
  161. <h4 id="IPA_Logging_LogPrinter_EndPrint" data-uid="IPA.Logging.LogPrinter.EndPrint">EndPrint()</h4>
  162. <div class="markdown level1 summary"><p>Called after the last print in a group. May be called multiple times.
  163. Use this to dispose file handles and the like.</p>
  164. </div>
  165. <div class="markdown level1 conceptual"></div>
  166. <h5 class="decalaration">Declaration</h5>
  167. <div class="codewrapper">
  168. <pre><code class="lang-csharp hljs">public virtual void EndPrint()</code></pre>
  169. </div>
  170. <span class="small pull-right mobile-hide">
  171. <span class="divider">|</span>
  172. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.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>
  173. </span>
  174. <span class="small pull-right mobile-hide">
  175. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ee55fb9ffdb7102004729b186c0269c09be9f6b7/IPA.Loader/Logging/LogPrinter.cs/#L23">View Source</a>
  176. </span>
  177. <a id="IPA_Logging_LogPrinter_Print_" data-uid="IPA.Logging.LogPrinter.Print*"></a>
  178. <h4 id="IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_" data-uid="IPA.Logging.LogPrinter.Print(IPA.Logging.Logger.Level,System.DateTime,System.String,System.String)">Print(Logger.Level, DateTime, String, String)</h4>
  179. <div class="markdown level1 summary"><p>Prints a provided message from a given log at the specified time.</p>
  180. </div>
  181. <div class="markdown level1 conceptual"></div>
  182. <h5 class="decalaration">Declaration</h5>
  183. <div class="codewrapper">
  184. <pre><code class="lang-csharp hljs">public abstract void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  185. </div>
  186. <h5 class="parameters">Parameters</h5>
  187. <table class="table table-bordered table-striped table-condensed">
  188. <thead>
  189. <tr>
  190. <th>Type</th>
  191. <th>Name</th>
  192. <th>Description</th>
  193. </tr>
  194. </thead>
  195. <tbody>
  196. <tr>
  197. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  198. <td><span class="parametername">level</span></td>
  199. <td><p>the log level</p>
  200. </td>
  201. </tr>
  202. <tr>
  203. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.datetime">DateTime</a></td>
  204. <td><span class="parametername">time</span></td>
  205. <td><p>the time the message was composed</p>
  206. </td>
  207. </tr>
  208. <tr>
  209. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  210. <td><span class="parametername">logName</span></td>
  211. <td><p>the name of the log that created this message</p>
  212. </td>
  213. </tr>
  214. <tr>
  215. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  216. <td><span class="parametername">message</span></td>
  217. <td><p>the message</p>
  218. </td>
  219. </tr>
  220. </tbody>
  221. </table>
  222. <span class="small pull-right mobile-hide">
  223. <span class="divider">|</span>
  224. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter_StartPrint.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.StartPrint%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>
  225. </span>
  226. <span class="small pull-right mobile-hide">
  227. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ee55fb9ffdb7102004729b186c0269c09be9f6b7/IPA.Loader/Logging/LogPrinter.cs/#L29">View Source</a>
  228. </span>
  229. <a id="IPA_Logging_LogPrinter_StartPrint_" data-uid="IPA.Logging.LogPrinter.StartPrint*"></a>
  230. <h4 id="IPA_Logging_LogPrinter_StartPrint" data-uid="IPA.Logging.LogPrinter.StartPrint">StartPrint()</h4>
  231. <div class="markdown level1 summary"><p>Called before the first print in a group. May be called multiple times.
  232. Use this to create file handles and the like.</p>
  233. </div>
  234. <div class="markdown level1 conceptual"></div>
  235. <h5 class="decalaration">Declaration</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">public virtual void StartPrint()</code></pre>
  238. </div>
  239. <h3 id="extensionmethods">Extension Methods</h3>
  240. <div>
  241. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  242. </div>
  243. <div>
  244. <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>
  245. </div>
  246. <div>
  247. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  248. </div>
  249. <div>
  250. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  251. </div>
  252. <div>
  253. <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>
  254. </div>
  255. </article>
  256. </div>
  257. <div class="hidden-sm col-md-2" role="complementary">
  258. <div class="sideaffix">
  259. <div class="contribution">
  260. <ul class="nav">
  261. <li>
  262. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter%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>
  263. </li>
  264. <li>
  265. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ee55fb9ffdb7102004729b186c0269c09be9f6b7/IPA.Loader/Logging/LogPrinter.cs/#L8" class="contribution-link">View Source</a>
  266. </li>
  267. </ul>
  268. </div>
  269. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  270. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  271. </nav>
  272. </div>
  273. </div>
  274. </div>
  275. </div>
  276. <footer>
  277. <div class="grad-bottom"></div>
  278. <div class="footer">
  279. <div class="container">
  280. <span class="pull-right">
  281. <a href="#top">Back to top</a>
  282. </span>
  283. <span>Generated by <strong>DocFX</strong></span>
  284. </div>
  285. </div>
  286. </footer>
  287. </div>
  288. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  289. <script type="text/javascript" src="../styles/docfx.js"></script>
  290. <script type="text/javascript" src="../styles/main.js"></script>
  291. </body>
  292. </html>