ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-13 12:14:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: regenerate

Browse source
This commit is contained in:
goat 2021-10-20 03:28:08 +02:00
parent dd72261893
commit c050e83210
No known key found for this signature in database
GPG key ID: 7773BB5B43BA52E5
997 changed files with 51585 additions and 22166 deletions
Download patch file Download diff file Expand all files Collapse all files

180
docs/api/Dalamud.Utility.Util.html
View file

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Util
">
<meta name="generator" content="docfx 2.58.0.0">
<meta name="generator" content="docfx 2.58.4.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -115,10 +115,10 @@
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_AssemblyVersion.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.AssemblyVersion%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_AssemblyVersion.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.AssemblyVersion%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/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L26">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L28">View Source</a>
</span>
<a id="Dalamud_Utility_Util_AssemblyVersion_" data-uid="Dalamud.Utility.Util.AssemblyVersion*"></a>
<h4 id="Dalamud_Utility_Util_AssemblyVersion" data-uid="Dalamud.Utility.Util.AssemblyVersion">AssemblyVersion</h4>
@ -148,10 +148,10 @@
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_ByteArrayToHex_System_Byte___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.ByteArrayToHex(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32)%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_ByteArrayToHex_System_Byte___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.ByteArrayToHex(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32)%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/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L71">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L73">View Source</a>
</span>
<a id="Dalamud_Utility_Util_ByteArrayToHex_" data-uid="Dalamud.Utility.Util.ByteArrayToHex*"></a>
<h4 id="Dalamud_Utility_Util_ByteArrayToHex_System_Byte___System_Int32_System_Int32_" data-uid="Dalamud.Utility.Util.ByteArrayToHex(System.Byte[],System.Int32,System.Int32)">ByteArrayToHex(Byte[], Int32, Int32)</h4>
@ -210,10 +210,156 @@
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_DumpMemory_System_IntPtr_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.DumpMemory(System.IntPtr%2CSystem.Int32)%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_CompressString_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.CompressString(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/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L51">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L215">View Source</a>
</span>
<a id="Dalamud_Utility_Util_CompressString_" data-uid="Dalamud.Utility.Util.CompressString*"></a>
<h4 id="Dalamud_Utility_Util_CompressString_System_String_" data-uid="Dalamud.Utility.Util.CompressString(System.String)">CompressString(String)</h4>
<div class="markdown level1 summary"><p>Compress a string using GZip.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static byte[] CompressString(string str)</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">str</span></td>
<td><p>The input string.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><p>The compressed output bytes.</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_Utility_Util_CopyTo_System_IO_Stream_System_IO_Stream_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.CopyTo(System.IO.Stream%2CSystem.IO.Stream%2CSystem.Int32)%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/Utility/Util.cs/#L256">View Source</a>
</span>
<a id="Dalamud_Utility_Util_CopyTo_" data-uid="Dalamud.Utility.Util.CopyTo*"></a>
<h4 id="Dalamud_Utility_Util_CopyTo_System_IO_Stream_System_IO_Stream_System_Int32_" data-uid="Dalamud.Utility.Util.CopyTo(System.IO.Stream,System.IO.Stream,System.Int32)">CopyTo(Stream, Stream, Int32)</h4>
<div class="markdown level1 summary"><p>Copy one stream to another.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void CopyTo(Stream src, Stream dest, int len = 4069)</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.IO.Stream</span></td>
<td><span class="parametername">src</span></td>
<td><p>The source stream.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.IO.Stream</span></td>
<td><span class="parametername">dest</span></td>
<td><p>The destination stream.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td><p>The maximum length to copy.</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_Utility_Util_DecompressString_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.DecompressString(System.Byte%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/Utility/Util.cs/#L236">View Source</a>
</span>
<a id="Dalamud_Utility_Util_DecompressString_" data-uid="Dalamud.Utility.Util.DecompressString*"></a>
<h4 id="Dalamud_Utility_Util_DecompressString_System_Byte___" data-uid="Dalamud.Utility.Util.DecompressString(System.Byte[])">DecompressString(Byte[])</h4>
<div class="markdown level1 summary"><p>Decompress a string using GZip.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string DecompressString(byte[] bytes)</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.Byte</span>[]</td>
<td><span class="parametername">bytes</span></td>
<td><p>The input bytes.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>The compressed output string.</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_Utility_Util_DumpMemory_System_IntPtr_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.DumpMemory(System.IntPtr%2CSystem.Int32)%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/Utility/Util.cs/#L53">View Source</a>
</span>
<a id="Dalamud_Utility_Util_DumpMemory_" data-uid="Dalamud.Utility.Util.DumpMemory*"></a>
<h4 id="Dalamud_Utility_Util_DumpMemory_System_IntPtr_System_Int32_" data-uid="Dalamud.Utility.Util.DumpMemory(System.IntPtr,System.Int32)">DumpMemory(IntPtr, Int32)</h4>
@ -250,10 +396,10 @@
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_Fatal_System_String_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.Fatal(System.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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_Fatal_System_String_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.Fatal(System.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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L172">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L174">View Source</a>
</span>
<a id="Dalamud_Utility_Util_Fatal_" data-uid="Dalamud.Utility.Util.Fatal*"></a>
<h4 id="Dalamud_Utility_Util_Fatal_System_String_System_String_" data-uid="Dalamud.Utility.Util.Fatal(System.String,System.String)">Fatal(String, String)</h4>
@ -290,10 +436,10 @@
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_GetGitHash.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.GetGitHash%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_GetGitHash.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.GetGitHash%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/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L33">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L35">View Source</a>
</span>
<a id="Dalamud_Utility_Util_GetGitHash_" data-uid="Dalamud.Utility.Util.GetGitHash*"></a>
<h4 id="Dalamud_Utility_Util_GetGitHash" data-uid="Dalamud.Utility.Util.GetGitHash">GetGitHash()</h4>
@ -323,10 +469,10 @@ or null if it cannot be found.</p>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_GetUTF8String_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.GetUTF8String(System.Byte%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_GetUTF8String_System_Byte___.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.GetUTF8String(System.Byte%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/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L185">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L187">View Source</a>
</span>
<a id="Dalamud_Utility_Util_GetUTF8String_" data-uid="Dalamud.Utility.Util.GetUTF8String*"></a>
<h4 id="Dalamud_Utility_Util_GetUTF8String_System_Byte___" data-uid="Dalamud.Utility.Util.GetUTF8String(System.Byte[])">GetUTF8String(Byte[])</h4>
@ -373,10 +519,10 @@ or null if it cannot be found.</p>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_ShowObject_System_Object_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.ShowObject(System.Object)%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util_ShowObject_System_Object_.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util.ShowObject(System.Object)%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/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L134">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L136">View Source</a>
</span>
<a id="Dalamud_Utility_Util_ShowObject_" data-uid="Dalamud.Utility.Util.ShowObject*"></a>
<h4 id="Dalamud_Utility_Util_ShowObject_System_Object_" data-uid="Dalamud.Utility.Util.ShowObject(System.Object)">ShowObject(Object)</h4>
@ -413,10 +559,10 @@ or null if it cannot be found.</p>
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_Util.md&amp;value=---%0Auid%3A%20Dalamud.Utility.Util%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/goaaats/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L19" class="contribution-link">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/Util.cs/#L21" class="contribution-link">View Source</a>
</li>
</ul>
</div>