Skip to content

Commit

Permalink
Deploying to gh-pages from @ 460ba36 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
RedstoneWizard08 committed May 10, 2024
1 parent 3fd7aed commit 488d418
Show file tree
Hide file tree
Showing 17 changed files with 3,240 additions and 17 deletions.
380 changes: 380 additions & 0 deletions api/ConfigurableWarning.API.SettingPatches.html

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions api/ConfigurableWarning.API.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,11 @@ <h3 id="classes">
<dd><p>Automatically registers the option. This will initialize it in the state,
register it with Content Settings, and load its default value if the value
is not present.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="ConfigurableWarning.API.SettingPatches.html">SettingPatches</a></dt>
<dd><p>Settings patches</p>
</dd>
</dl>

Expand Down
293 changes: 293 additions & 0 deletions api/ConfigurableWarning.Patches.DivingBellPatch.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class DivingBellPatch | ConfigurableWarning Docs </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class DivingBellPatch | ConfigurableWarning Docs ">

<meta name="description" content="Diving Bell patches">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">

<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/RedstoneWizard08/ConfigurableWarning/new/main/apiSpec/new?filename=ConfigurableWarning_Patches_DivingBellPatch.md&amp;value=---%0Auid%3A%20ConfigurableWarning.Patches.DivingBellPatch%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>

</head>

<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../banner.svg" alt="">

</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="ConfigurableWarning.Patches.DivingBellPatch">



<h1 id="ConfigurableWarning_Patches_DivingBellPatch" data-uid="ConfigurableWarning.Patches.DivingBellPatch" class="text-break">
Class DivingBellPatch <a class="header-action link-secondary" title="View source" href="https://github.com/RedstoneWizard08/ConfigurableWarning/blob/main/ConfigurableWarning/Source/Patches/DivingBellPatch.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="ConfigurableWarning.html">ConfigurableWarning</a>.<a class="xref" href="ConfigurableWarning.Patches.html">Patches</a></dd></dl>
<dl><dt>Assembly</dt><dd>RedstoneWizard08.ConfigurableWarning.dll</dd></dl>
</div>

<div class="markdown summary"><p>Diving Bell patches</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[HarmonyPatch]
public class DivingBellPatch</code></pre>
</div>




<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">DivingBellPatch</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>






<h2 class="section" id="methods">Methods
</h2>


<a id="ConfigurableWarning_Patches_DivingBellPatch_CheckForPlayers_" data-uid="ConfigurableWarning.Patches.DivingBellPatch.CheckForPlayers*"></a>

<h3 id="ConfigurableWarning_Patches_DivingBellPatch_CheckForPlayers_DiveBellPlayerDetector_System_Collections_Generic_ICollection_Player___" data-uid="ConfigurableWarning.Patches.DivingBellPatch.CheckForPlayers(DiveBellPlayerDetector,System.Collections.Generic.ICollection{Player}@)">
CheckForPlayers(DiveBellPlayerDetector, ref ICollection&lt;Player&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/RedstoneWizard08/ConfigurableWarning/blob/main/ConfigurableWarning/Source/Patches/DivingBellPatch.cs/#L31"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Patches the player checker to allow for all players to not need to be
inside.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[HarmonyPostfix]
[HarmonyPatch(typeof(DiveBellPlayerDetector), &quot;CheckForPlayers&quot;)]
public static void CheckForPlayers(DiveBellPlayerDetector __instance, ref ICollection&lt;Player&gt; __result)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__instance</code> <span class="xref">DiveBellPlayerDetector</span></dt>
<dd><p>The current instance of the <span class="xref">DiveBellPlayerDetector</span>.</p>
</dd>
<dt><code>__result</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection</a>&lt;<span class="xref">Player</span>&gt;</dt>
<dd><p>The players &quot;inside&quot; the diving bell</p>
</dd>
</dl>












<a id="ConfigurableWarning_Patches_DivingBellPatch_IsFullyClosed_" data-uid="ConfigurableWarning.Patches.DivingBellPatch.IsFullyClosed*"></a>

<h3 id="ConfigurableWarning_Patches_DivingBellPatch_IsFullyClosed_DivingBellDoor_System_Boolean__" data-uid="ConfigurableWarning.Patches.DivingBellPatch.IsFullyClosed(DivingBellDoor,System.Boolean@)">
IsFullyClosed(DivingBellDoor, ref bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/RedstoneWizard08/ConfigurableWarning/blob/main/ConfigurableWarning/Source/Patches/DivingBellPatch.cs/#L19"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Patches the diving bell to allow you to leave without your friends.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[HarmonyPostfix]
[HarmonyPatch(typeof(DivingBellDoor), &quot;IsFullyClosed&quot;)]
public static void IsFullyClosed(DivingBellDoor __instance, ref bool __result)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__instance</code> <span class="xref">DivingBellDoor</span></dt>
<dd><p>The current instance of the <span class="xref">DivingBellDoor</span>.</p>
</dd>
<dt><code>__result</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>












<a id="ConfigurableWarning_Patches_DivingBellPatch_Update_" data-uid="ConfigurableWarning.Patches.DivingBellPatch.Update*"></a>

<h3 id="ConfigurableWarning_Patches_DivingBellPatch_Update_DivingBell_" data-uid="ConfigurableWarning.Patches.DivingBellPatch.Update(DivingBell)">
Update(DivingBell)
<a class="header-action link-secondary" title="View source" href="https://github.com/RedstoneWizard08/ConfigurableWarning/blob/main/ConfigurableWarning/Source/Patches/DivingBellPatch.cs/#L42"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Patches the diving bell's update function to apply our settings</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[HarmonyPostfix]
[HarmonyPatch(typeof(DivingBell), &quot;Update&quot;)]
public static void Update(DivingBell __instance)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__instance</code> <span class="xref">DivingBell</span></dt>
<dd><p>The current instance of the <span class="xref">DivingBell</span>.</p>
</dd>
</dl>













</article>

<div class="contribution d-print-none">
<a href="https://github.com/RedstoneWizard08/ConfigurableWarning/blob/main/ConfigurableWarning/Source/Patches/DivingBellPatch.cs/#L12" class="edit-link">Edit this page</a>
</div>


</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit 488d418

Please sign in to comment.