mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
711 lines
34 KiB
HTML
711 lines
34 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class ModuleLog
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ModuleLog
|
|
">
|
|
<meta name="generator" content="docfx 2.59.4.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Logging.Internal.ModuleLog">
|
|
|
|
|
|
<h1 id="Dalamud_Logging_Internal_ModuleLog" data-uid="Dalamud.Logging.Internal.ModuleLog" class="text-break">Class ModuleLog
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Class offering various methods to allow for logging in Dalamud modules.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">ModuleLog</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Logging.Internal.html">Dalamud.Logging.Internal</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Logging_Internal_ModuleLog_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class ModuleLog</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog__ctor_System_String_.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.%23ctor(System.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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L21">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog__ctor_" data-uid="Dalamud.Logging.Internal.ModuleLog.#ctor*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog__ctor_System_String_" data-uid="Dalamud.Logging.Internal.ModuleLog.#ctor(System.String)">ModuleLog(String)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Logging.Internal.ModuleLog.html">ModuleLog</a> class.
|
|
This class can be used to prefix logging messages with a Dalamud module name prefix. For example, "[PLUGINR] ...".</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ModuleLog(string moduleName)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">moduleName</span></td>
|
|
<td><p>The module name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Debug_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Debug(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L60">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Debug_" data-uid="Dalamud.Logging.Internal.ModuleLog.Debug*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Debug_System_Exception_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Debug(System.Exception,System.String,System.Object[])">Debug(Exception, String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated debug message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Debug(Exception exception, string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Exception</span></td>
|
|
<td><span class="parametername">exception</span></td>
|
|
<td><p>The exception that caused the error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Debug_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Debug(System.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L51">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Debug_" data-uid="Dalamud.Logging.Internal.ModuleLog.Debug*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Debug_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Debug(System.String,System.Object[])">Debug(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated debug message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Debug(string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Error_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Error(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L111">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Error_" data-uid="Dalamud.Logging.Internal.ModuleLog.Error*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Error_System_Exception_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Error(System.Exception,System.String,System.Object[])">Error(Exception, String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated error message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Error(Exception exception, string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Exception</span></td>
|
|
<td><span class="parametername">exception</span></td>
|
|
<td><p>The exception that caused the error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Error_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Error(System.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L102">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Error_" data-uid="Dalamud.Logging.Internal.ModuleLog.Error*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Error_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Error(System.String,System.Object[])">Error(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated error message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Error(string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Fatal_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Fatal(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L128">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Fatal_" data-uid="Dalamud.Logging.Internal.ModuleLog.Fatal*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Fatal_System_Exception_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Fatal(System.Exception,System.String,System.Object[])">Fatal(Exception, String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated fatal message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Fatal(Exception exception, string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Exception</span></td>
|
|
<td><span class="parametername">exception</span></td>
|
|
<td><p>The exception that caused the error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Fatal_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Fatal(System.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L119">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Fatal_" data-uid="Dalamud.Logging.Internal.ModuleLog.Fatal*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Fatal_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Fatal(System.String,System.Object[])">Fatal(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated fatal message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Fatal(string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Information_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Information(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L77">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Information_" data-uid="Dalamud.Logging.Internal.ModuleLog.Information*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Information_System_Exception_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Information(System.Exception,System.String,System.Object[])">Information(Exception, String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated information message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Information(Exception exception, string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Exception</span></td>
|
|
<td><span class="parametername">exception</span></td>
|
|
<td><p>The exception that caused the error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Information_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Information(System.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L68">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Information_" data-uid="Dalamud.Logging.Internal.ModuleLog.Information*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Information_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Information(System.String,System.Object[])">Information(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated information message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Information(string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Verbose_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Verbose(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L43">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Verbose_" data-uid="Dalamud.Logging.Internal.ModuleLog.Verbose*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Verbose_System_Exception_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Verbose(System.Exception,System.String,System.Object[])">Verbose(Exception, String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated verbose message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Verbose(Exception exception, string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Exception</span></td>
|
|
<td><span class="parametername">exception</span></td>
|
|
<td><p>The exception that caused the error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Verbose_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Verbose(System.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L34">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Verbose_" data-uid="Dalamud.Logging.Internal.ModuleLog.Verbose*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Verbose_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Verbose(System.String,System.Object[])">Verbose(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated verbose message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Verbose(string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Warning_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Warning(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L94">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Warning_" data-uid="Dalamud.Logging.Internal.ModuleLog.Warning*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Warning_System_Exception_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Warning(System.Exception,System.String,System.Object[])">Warning(Exception, String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated warning message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Warning(Exception exception, string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Exception</span></td>
|
|
<td><span class="parametername">exception</span></td>
|
|
<td><p>The exception that caused the error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog_Warning_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog.Warning(System.String%2CSystem.Object%5B%5D)%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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L85">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Logging_Internal_ModuleLog_Warning_" data-uid="Dalamud.Logging.Internal.ModuleLog.Warning*"></a>
|
|
<h4 id="Dalamud_Logging_Internal_ModuleLog_Warning_System_String_System_Object___" data-uid="Dalamud.Logging.Internal.ModuleLog.Warning(System.String,System.Object[])">Warning(String, Object[])</h4>
|
|
<div class="markdown level1 summary"><p>Log a templated warning message to the in-game debug log.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Warning(string messageTemplate, params object[] values)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">messageTemplate</span></td>
|
|
<td><p>The message template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span>[]</td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>Values to log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Logging_Internal_ModuleLog.md&value=---%0Auid%3A%20Dalamud.Logging.Internal.ModuleLog%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>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Logging/Internal/ModuleLog.cs/#L11" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|