deploy: 9570d7b

LolaLollipop · Jan 1, 2024 · d089462 · d089462
1 parent a2e0937
commit d089462
Show file tree

Hide file tree

Showing 37 changed files with 1,151 additions and 435 deletions.
diff --git a/api/RueI.Displays.DisplayBase.html b/api/RueI.Displays.DisplayBase.html
@@ -346,7 +346,7 @@ <h3 id="RueI_Displays_DisplayBase_Delete" data-uid="RueI.Displays.DisplayBase.De
   <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayBase.cs/#L63"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Deletes this display, removing it from the player's coordinator.</p>
+  <div class="markdown level1 summary"><p>Deletes this display, removing it from the player's core.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 

diff --git a/api/RueI.Displays.DisplayCore.html b/api/RueI.Displays.DisplayCore.html
@@ -158,6 +158,9 @@ <h1 id="RueI_Displays_DisplayCore" data-uid="RueI.Displays.DisplayCore" class="t
   <div>
       <a class="xref" href="RueI.Extensions.DisplayCoreExtensions.html#RueI_Extensions_DisplayCoreExtensions_ShowTemp_RueI_Displays_DisplayCore_System_String_System_Single_System_TimeSpan_RueI_Displays_Scheduling_TimedElemRef_RueI_Elements_SetElement__">DisplayCoreExtensions.ShowTemp(DisplayCore, string, float, TimeSpan, TimedElemRef&lt;SetElement&gt;)</a>
   </div>
+  <div>
+      <a class="xref" href="RueI.Extensions.DisplayCoreExtensions.html#RueI_Extensions_DisplayCoreExtensions_ShowTempFunctional_RueI_Displays_DisplayCore_System_String_System_Single_System_TimeSpan_RueI_Displays_Scheduling_TimedElemRef_RueI_Elements_SetElement__">DisplayCoreExtensions.ShowTempFunctional(DisplayCore, string, float, TimeSpan, TimedElemRef&lt;SetElement&gt;)</a>
+  </div>
   <div>
       <a class="xref" href="RueI.Extensions.UniversalExtensions.html#RueI_Extensions_UniversalExtensions_AddTo__1___0_System_Collections_Generic_ICollection___0__">UniversalExtensions.AddTo&lt;T&gt;(T, ICollection&lt;T&gt;)</a>
   </div>

diff --git a/api/RueI.Displays.Scheduling.RateLimiter.html b/api/RueI.Displays.Scheduling.RateLimiter.html
@@ -91,7 +91,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
   <h1 id="RueI_Displays_Scheduling_RateLimiter" data-uid="RueI.Displays.Scheduling.RateLimiter" class="text-break">
     Class RateLimiter
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L7"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L10"><i class="bi bi-code-slash"></i></a>
   </h1>
 
   <div class="facts text-secondary">
@@ -156,6 +156,9 @@ <h1 id="RueI_Displays_Scheduling_RateLimiter" data-uid="RueI.Displays.Scheduling
 
 
 
+  <h2 id="RueI_Displays_Scheduling_RateLimiter_remarks">Remarks</h2>
+  <div class="markdown level0 remarks"><p>The <a class="xref" href="RueI.Displays.Scheduling.RateLimiter.html">RateLimiter</a> operates using a simple token bucket ratelimiting algorithm.</p>
+</div>
 
 
   <h2 class="section" id="constructors">Constructors
@@ -166,7 +169,7 @@ <h2 class="section" id="constructors">Constructors
 
   <h3 id="RueI_Displays_Scheduling_RateLimiter__ctor_System_Int32_System_TimeSpan_" data-uid="RueI.Displays.Scheduling.RateLimiter.#ctor(System.Int32,System.TimeSpan)">
   RateLimiter(int, TimeSpan)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L17"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L22"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="RueI.Displays.Scheduling.RateLimiter.html">RateLimiter</a> class.</p>
@@ -206,7 +209,7 @@ <h2 class="section" id="properties">Properties
 
   <h3 id="RueI_Displays_Scheduling_RateLimiter_HasTokens" data-uid="RueI.Displays.Scheduling.RateLimiter.HasTokens">
   HasTokens
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L41"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L61"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets a value indicating whether or not this ratelimiter has a token available.</p>
@@ -238,7 +241,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="RueI_Displays_Scheduling_RateLimiter_RegenRate" data-uid="RueI.Displays.Scheduling.RateLimiter.RegenRate">
   RegenRate
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L26"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L31"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets or sets the regeneration rate for this ratelimiter.</p>
@@ -270,15 +273,15 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="RueI_Displays_Scheduling_RateLimiter_TokenLimit" data-uid="RueI.Displays.Scheduling.RateLimiter.TokenLimit">
   TokenLimit
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L31"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L36"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Gets the limit on tokens in this ratelimiter.</p>
+  <div class="markdown level1 summary"><p>Gets or sets the limit on tokens in this ratelimiter.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public int TokenLimit { get; }</code></pre>
+    <pre><code class="lang-csharp hljs">public int TokenLimit { get; set; }</code></pre>
   </div>
 
 
@@ -302,7 +305,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="RueI_Displays_Scheduling_RateLimiter_Tokens" data-uid="RueI.Displays.Scheduling.RateLimiter.Tokens">
   Tokens
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L36"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L49"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets the number of tokens available in this ratelimiter.</p>
@@ -334,19 +337,19 @@ <h2 class="section" id="methods">Methods
 </h2>
 
 
-  <a id="RueI_Displays_Scheduling_RateLimiter_CalculateNewTokens_" data-uid="RueI.Displays.Scheduling.RateLimiter.CalculateNewTokens*"></a>
+  <a id="RueI_Displays_Scheduling_RateLimiter_Consume_" data-uid="RueI.Displays.Scheduling.RateLimiter.Consume*"></a>
 
-  <h3 id="RueI_Displays_Scheduling_RateLimiter_CalculateNewTokens" data-uid="RueI.Displays.Scheduling.RateLimiter.CalculateNewTokens">
-  CalculateNewTokens()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L58"><i class="bi bi-code-slash"></i></a>
+  <h3 id="RueI_Displays_Scheduling_RateLimiter_Consume" data-uid="RueI.Displays.Scheduling.RateLimiter.Consume">
+  Consume()
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L82"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Calculates the number of new tokens for this ratelimiter.</p>
+  <div class="markdown level1 summary"><p>Consumes a token from this ratelimiter.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public void CalculateNewTokens()</code></pre>
+    <pre><code class="lang-csharp hljs">public void Consume()</code></pre>
   </div>
 
 
@@ -361,22 +364,28 @@ <h3 id="RueI_Displays_Scheduling_RateLimiter_CalculateNewTokens" data-uid="RueI.
 
 
 
-  <a id="RueI_Displays_Scheduling_RateLimiter_Consume_" data-uid="RueI.Displays.Scheduling.RateLimiter.Consume*"></a>
+  <a id="RueI_Displays_Scheduling_RateLimiter_TryConsume_" data-uid="RueI.Displays.Scheduling.RateLimiter.TryConsume*"></a>
 
-  <h3 id="RueI_Displays_Scheduling_RateLimiter_Consume" data-uid="RueI.Displays.Scheduling.RateLimiter.Consume">
-  Consume()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L46"><i class="bi bi-code-slash"></i></a>
+  <h3 id="RueI_Displays_Scheduling_RateLimiter_TryConsume" data-uid="RueI.Displays.Scheduling.RateLimiter.TryConsume">
+  TryConsume()
+  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L67"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Consumes a token from this ratelimiter.</p>
+  <div class="markdown level1 summary"><p>Tries to consume a token from this ratelimiter.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public void Consume()</code></pre>
+    <pre><code class="lang-csharp hljs">public bool TryConsume()</code></pre>
   </div>
 
 
+  <h4 class="section">Returns</h4>
+  <dl class="parameters">
+    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
+    <dd><p>A value indicating whether or not this <a class="xref" href="RueI.Displays.Scheduling.RateLimiter.html">RateLimiter</a> has a token available.</p>
+</dd>
+  </dl>
 
 
 
@@ -396,7 +405,7 @@ <h2 id="seealso">See Also</h2>
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L7" class="edit-link">Edit this page</a>
+          <a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/RateLimiter.cs/#L10" class="edit-link">Edit this page</a>
         </div>