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.

296 lines
14 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. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../index.html">
  33. <img id="logo" class="svg" src="../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="IPA.Logging.LogPrinter">
  63. <h1 id="IPA_Logging_LogPrinter" data-uid="IPA.Logging.LogPrinter" class="text-break">Class LogPrinter
  64. </h1>
  65. <div class="markdown level0 summary"><p>The log printer's base class.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><span class="xref">LogPrinter</span></div>
  72. <div class="level2"><a class="xref" href="IPA.Logging.Printers.ColoredConsolePrinter.html">ColoredConsolePrinter</a></div>
  73. <div class="level2"><a class="xref" href="IPA.Logging.Printers.ColorlessConsolePrinter.html">ColorlessConsolePrinter</a></div>
  74. <div class="level2"><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html">GZFilePrinter</a></div>
  75. </div>
  76. <div class="inheritedMembers">
  77. <h5>Inherited Members</h5>
  78. <div>
  79. <span class="xref">System.Object.ToString()</span>
  80. </div>
  81. <div>
  82. <span class="xref">System.Object.Equals(System.Object)</span>
  83. </div>
  84. <div>
  85. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  86. </div>
  87. <div>
  88. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.GetHashCode()</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.GetType()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.MemberwiseClone()</span>
  98. </div>
  99. </div>
  100. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.html">IPA.Logging</a></h6>
  101. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  102. <h5 id="IPA_Logging_LogPrinter_syntax">Syntax</h5>
  103. <div class="codewrapper">
  104. <pre><code class="lang-csharp hljs">public abstract class LogPrinter</code></pre>
  105. </div>
  106. <h3 id="properties">Properties
  107. </h3>
  108. <span class="small pull-right mobile-hide">
  109. <span class="divider">|</span>
  110. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  111. </span>
  112. <span class="small pull-right mobile-hide">
  113. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/LogPrinter.cs/#L14">View Source</a>
  114. </span>
  115. <a id="IPA_Logging_LogPrinter_Filter_" data-uid="IPA.Logging.LogPrinter.Filter*"></a>
  116. <h4 id="IPA_Logging_LogPrinter_Filter" data-uid="IPA.Logging.LogPrinter.Filter">Filter</h4>
  117. <div class="markdown level1 summary"><p>Provides a filter for which log levels to allow through.</p>
  118. </div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="decalaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">public abstract Logger.LogLevel Filter { get; set; }</code></pre>
  123. </div>
  124. <h5 class="propertyValue">Property Value</h5>
  125. <table class="table table-bordered table-striped table-condensed">
  126. <thead>
  127. <tr>
  128. <th>Type</th>
  129. <th>Description</th>
  130. </tr>
  131. </thead>
  132. <tbody>
  133. <tr>
  134. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  135. <td><p>the level to filter to</p>
  136. </td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. <h3 id="methods">Methods
  141. </h3>
  142. <span class="small pull-right mobile-hide">
  143. <span class="divider">|</span>
  144. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  145. </span>
  146. <span class="small pull-right mobile-hide">
  147. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/LogPrinter.cs/#L35">View Source</a>
  148. </span>
  149. <a id="IPA_Logging_LogPrinter_EndPrint_" data-uid="IPA.Logging.LogPrinter.EndPrint*"></a>
  150. <h4 id="IPA_Logging_LogPrinter_EndPrint" data-uid="IPA.Logging.LogPrinter.EndPrint">EndPrint()</h4>
  151. <div class="markdown level1 summary"><p>Called after the last print in a group. May be called multiple times.
  152. Use this to dispose file handles and the like.</p>
  153. </div>
  154. <div class="markdown level1 conceptual"></div>
  155. <h5 class="decalaration">Declaration</h5>
  156. <div class="codewrapper">
  157. <pre><code class="lang-csharp hljs">public virtual void EndPrint()</code></pre>
  158. </div>
  159. <span class="small pull-right mobile-hide">
  160. <span class="divider">|</span>
  161. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  162. </span>
  163. <span class="small pull-right mobile-hide">
  164. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/LogPrinter.cs/#L23">View Source</a>
  165. </span>
  166. <a id="IPA_Logging_LogPrinter_Print_" data-uid="IPA.Logging.LogPrinter.Print*"></a>
  167. <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>
  168. <div class="markdown level1 summary"><p>Prints a provided message from a given log at the specified time.</p>
  169. </div>
  170. <div class="markdown level1 conceptual"></div>
  171. <h5 class="decalaration">Declaration</h5>
  172. <div class="codewrapper">
  173. <pre><code class="lang-csharp hljs">public abstract void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  174. </div>
  175. <h5 class="parameters">Parameters</h5>
  176. <table class="table table-bordered table-striped table-condensed">
  177. <thead>
  178. <tr>
  179. <th>Type</th>
  180. <th>Name</th>
  181. <th>Description</th>
  182. </tr>
  183. </thead>
  184. <tbody>
  185. <tr>
  186. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  187. <td><span class="parametername">level</span></td>
  188. <td><p>the log level</p>
  189. </td>
  190. </tr>
  191. <tr>
  192. <td><span class="xref">System.DateTime</span></td>
  193. <td><span class="parametername">time</span></td>
  194. <td><p>the time the message was composed</p>
  195. </td>
  196. </tr>
  197. <tr>
  198. <td><span class="xref">System.String</span></td>
  199. <td><span class="parametername">logName</span></td>
  200. <td><p>the name of the log that created this message</p>
  201. </td>
  202. </tr>
  203. <tr>
  204. <td><span class="xref">System.String</span></td>
  205. <td><span class="parametername">message</span></td>
  206. <td><p>the message</p>
  207. </td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <span class="small pull-right mobile-hide">
  212. <span class="divider">|</span>
  213. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  214. </span>
  215. <span class="small pull-right mobile-hide">
  216. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/LogPrinter.cs/#L29">View Source</a>
  217. </span>
  218. <a id="IPA_Logging_LogPrinter_StartPrint_" data-uid="IPA.Logging.LogPrinter.StartPrint*"></a>
  219. <h4 id="IPA_Logging_LogPrinter_StartPrint" data-uid="IPA.Logging.LogPrinter.StartPrint">StartPrint()</h4>
  220. <div class="markdown level1 summary"><p>Called before the first print in a group. May be called multiple times.
  221. Use this to create file handles and the like.</p>
  222. </div>
  223. <div class="markdown level1 conceptual"></div>
  224. <h5 class="decalaration">Declaration</h5>
  225. <div class="codewrapper">
  226. <pre><code class="lang-csharp hljs">public virtual void StartPrint()</code></pre>
  227. </div>
  228. <h3 id="extensionmethods">Extension Methods</h3>
  229. <div>
  230. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  231. </div>
  232. <div>
  233. <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>
  234. </div>
  235. <div>
  236. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  240. </div>
  241. <div>
  242. <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>
  243. </div>
  244. </article>
  245. </div>
  246. <div class="hidden-sm col-md-2" role="complementary">
  247. <div class="sideaffix">
  248. <div class="contribution">
  249. <ul class="nav">
  250. <li>
  251. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/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>
  252. </li>
  253. <li>
  254. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/LogPrinter.cs/#L8" class="contribution-link">View Source</a>
  255. </li>
  256. </ul>
  257. </div>
  258. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  259. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  260. </nav>
  261. </div>
  262. </div>
  263. </div>
  264. </div>
  265. <footer>
  266. <div class="grad-bottom"></div>
  267. <div class="footer">
  268. <div class="container">
  269. <span class="pull-right">
  270. <a href="#top">Back to top</a>
  271. </span>
  272. <span>Generated by <strong>DocFX</strong></span>
  273. </div>
  274. </div>
  275. </footer>
  276. </div>
  277. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  278. <script type="text/javascript" src="../styles/docfx.js"></script>
  279. <script type="text/javascript" src="../styles/main.js"></script>
  280. </body>
  281. </html>