Skip to content

Commit

Permalink
deploy: b836c83
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ruemena
Ruemena committed Dec 30, 2023
1 parent 7569d80 commit fc37acd
Show file tree
Hide file tree
Showing 16 changed files with 103 additions and 85 deletions.
30 changes: 15 additions & 15 deletions api/RueI.Constants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>

<h1 id="RueI_Constants" data-uid="RueI.Constants" class="text-break">
Class Constants
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L11"><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/Constants.cs/#L13"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -161,7 +161,7 @@ <h2 class="section" id="fields">Fields

<h3 id="RueI_Constants_BOLDINCREASE" data-uid="RueI.Constants.BOLDINCREASE">
BOLDINCREASE
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L33"><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/Constants.cs/#L35"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the pixel increase for bold characters.</p>
Expand Down Expand Up @@ -192,7 +192,7 @@ <h4 class="section">Field Value</h4>

<h3 id="RueI_Constants_CAPSTOSMALLCAPS" data-uid="RueI.Constants.CAPSTOSMALLCAPS">
CAPSTOSMALLCAPS
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L28"><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/Constants.cs/#L30"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the multiplier used to convert the size of a capital character to a smallcaps character.</p>
Expand Down Expand Up @@ -223,7 +223,7 @@ <h4 class="section">Field Value</h4>

<h3 id="RueI_Constants_DEFAULTHEIGHT" data-uid="RueI.Constants.DEFAULTHEIGHT">
DEFAULTHEIGHT
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.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/Constants.cs/#L19"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the default height if a line-height is not provided.</p>
Expand Down Expand Up @@ -257,7 +257,7 @@ <h4 class="section" id="RueI_Constants_DEFAULTHEIGHT_remarks">Remarks</h4>

<h3 id="RueI_Constants_DEFAULTSIZE" data-uid="RueI.Constants.DEFAULTSIZE">
DEFAULTSIZE
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L23"><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/Constants.cs/#L25"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the default size (in pixels) if a size is not provided.</p>
Expand Down Expand Up @@ -291,7 +291,7 @@ <h4 class="section" id="RueI_Constants_DEFAULTSIZE_remarks">Remarks</h4>

<h3 id="RueI_Constants_DISPLAYAREAWIDTH" data-uid="RueI.Constants.DISPLAYAREAWIDTH">
DISPLAYAREAWIDTH
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L38"><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/Constants.cs/#L40"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the width of the display area (in pixels).</p>
Expand Down Expand Up @@ -322,7 +322,7 @@ <h4 class="section">Field Value</h4>

<h3 id="RueI_Constants_EMSTOPIXELS" data-uid="RueI.Constants.EMSTOPIXELS">
EMSTOPIXELS
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L43"><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/Constants.cs/#L45"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets how many pixels are in an em.</p>
Expand Down Expand Up @@ -353,7 +353,7 @@ <h4 class="section">Field Value</h4>

<h3 id="RueI_Constants_HintRateLimit" data-uid="RueI.Constants.HintRateLimit">
HintRateLimit
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L63"><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/Constants.cs/#L65"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the ratelimit used for displaying hints.</p>
Expand Down Expand Up @@ -384,7 +384,7 @@ <h4 class="section">Field Value</h4>

<h3 id="RueI_Constants_MAXTAGNAMESIZE" data-uid="RueI.Constants.MAXTAGNAMESIZE">
MAXTAGNAMESIZE
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L53"><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/Constants.cs/#L55"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the maximum name size allowed for a tag.</p>
Expand Down Expand Up @@ -415,7 +415,7 @@ <h4 class="section">Field Value</h4>

<h3 id="RueI_Constants_MEASUREMENTVALUELIMIT" data-uid="RueI.Constants.MEASUREMENTVALUELIMIT">
MEASUREMENTVALUELIMIT
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L58"><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/Constants.cs/#L60"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the limit on measurement values.</p>
Expand Down Expand Up @@ -446,7 +446,7 @@ <h4 class="section">Field Value</h4>

<h3 id="RueI_Constants_ZeroWidthSpace" data-uid="RueI.Constants.ZeroWidthSpace">
ZeroWidthSpace
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L48"><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/Constants.cs/#L50"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the zero width space.</p>
Expand Down Expand Up @@ -482,7 +482,7 @@ <h2 class="section" id="properties">Properties

<h3 id="RueI_Constants_Alignments" data-uid="RueI.Constants.Alignments">
Alignments
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L79"><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/Constants.cs/#L81"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.objectmodel.readonlycollection-1">ReadOnlyCollection&lt;T&gt;</a> of valid alignments for <a class="xref" href="RueI.Parsing.Tags.ConcreteTags.AlignTag.html">AlignTag</a>.</p>
Expand Down Expand Up @@ -514,7 +514,7 @@ <h4 class="section">Property Value</h4>

<h3 id="RueI_Constants_Colors" data-uid="RueI.Constants.Colors">
Colors
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L91"><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/Constants.cs/#L93"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets a list of allowed colors for <a class="xref" href="RueI.Parsing.Tags.ConcreteTags.ColorTag.html">ColorTag</a>.</p>
Expand Down Expand Up @@ -546,7 +546,7 @@ <h4 class="section">Property Value</h4>

<h3 id="RueI_Constants_ValidColorSizes" data-uid="RueI.Constants.ValidColorSizes">
ValidColorSizes
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L68"><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/Constants.cs/#L70"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets a list of allowed sizes of color param tags, ignoring the hashtag.</p>
Expand Down Expand Up @@ -578,7 +578,7 @@ <h4 class="section">Property Value</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L11" class="edit-link">Edit this page</a>
<a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Constants.cs/#L13" class="edit-link">Edit this page</a>
</div>


Expand Down
3 changes: 1 addition & 2 deletions api/RueI.Displays.Display.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,8 @@ <h2 id="RueI_Displays_Display_examples">Examples</h2>
<p>This example demonstrates creating and using a <a class="xref" href="RueI.Displays.Display.html">Display</a>.</p>
<pre><code class="lang-csharp">Display display = new(referenceHub); // Create a new display from a ReferenceHub

SetElement helloElem = new(300, zIndex: 10, "hello").AddTo(display);
SetElement helloElem = new(300, zIndex: 10, "hello").AddTo(display);
SetElement worldElem = new(250, zIndex: 10, "world").AddTo(display);
display.Elements.Add(helloElem, worldElem);

display.Update(); // Update the display</code></pre>

Expand Down
8 changes: 4 additions & 4 deletions api/RueI.Displays.DisplayCore.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ <h2 class="section" id="methods">Methods

<h3 id="RueI_Displays_DisplayCore_AddAsReference__1_RueI_Displays_IElemReference___0____0_" data-uid="RueI.Displays.DisplayCore.AddAsReference``1(RueI.Displays.IElemReference{``0},``0)">
AddAsReference&lt;T&gt;(IElemReference&lt;T&gt;, T)
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayCore.cs/#L149"><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/DisplayCore.cs/#L148"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Adds an <a class="xref" href="RueI.Elements.Element.html">Element</a> as an <a class="xref" href="RueI.Displays.IElemReference-1.html">IElemReference&lt;T&gt;</a>.</p>
Expand Down Expand Up @@ -332,7 +332,7 @@ <h4 class="section" id="RueI_Displays_DisplayCore_Get_ReferenceHub__remarks">Rem

<h3 id="RueI_Displays_DisplayCore_GetElementOrNew__1_RueI_Displays_IElemReference___0__System_Func___0__" data-uid="RueI.Displays.DisplayCore.GetElementOrNew``1(RueI.Displays.IElemReference{``0},System.Func{``0})">
GetElementOrNew&lt;T&gt;(IElemReference&lt;T&gt;, Func&lt;T&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayCore.cs/#L128"><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/DisplayCore.cs/#L127"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets an <a class="xref" href="RueI.Elements.Element.html">Element</a> as <code class="typeparamref">T</code>, or creates it.</p>
Expand Down Expand Up @@ -380,7 +380,7 @@ <h4 class="section">Type Parameters</h4>

<h3 id="RueI_Displays_DisplayCore_GetElement__1_RueI_Displays_IElemReference___0__" data-uid="RueI.Displays.DisplayCore.GetElement``1(RueI.Displays.IElemReference{``0})">
GetElement&lt;T&gt;(IElemReference&lt;T&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayCore.cs/#L108"><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/DisplayCore.cs/#L107"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets an <a class="xref" href="RueI.Elements.Element.html">Element</a> as <code class="typeparamref">T</code> if the <a class="xref" href="RueI.Displays.IElemReference-1.html">IElemReference&lt;T&gt;</a> exists within this <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a>'s element references.</p>
Expand Down Expand Up @@ -464,7 +464,7 @@ <h4 class="section">Type Parameters</h4>

<h3 id="RueI_Displays_DisplayCore_RemoveReference__1_RueI_Displays_IElemReference___0__" data-uid="RueI.Displays.DisplayCore.RemoveReference``1(RueI.Displays.IElemReference{``0})">
RemoveReference&lt;T&gt;(IElemReference&lt;T&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayCore.cs/#L160"><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/DisplayCore.cs/#L159"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Removes a <a class="xref" href="RueI.Displays.IElemReference-1.html">IElemReference&lt;T&gt;</a> from this <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a>.</p>
Expand Down
12 changes: 8 additions & 4 deletions api/RueI.Displays.ElemCombiner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>

<h1 id="RueI_Displays_ElemCombiner" data-uid="RueI.Displays.ElemCombiner" class="text-break">
Class ElemCombiner
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/ElemCombiner.cs/#L14"><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/ElemCombiner.cs/#L18"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -149,6 +149,10 @@ <h1 id="RueI_Displays_ElemCombiner" data-uid="RueI.Displays.ElemCombiner" class=



<h2 id="RueI_Displays_ElemCombiner_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>The <a class="xref" href="RueI.Displays.ElemCombiner.html">ElemCombiner</a> is a helper class that combines all of the <a class="xref" href="RueI.Elements.Element.html">Element</a>s for a <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a> into a single string,
to be displayed as a hint.</p>
</div>


<h2 class="section" id="methods">Methods
Expand All @@ -159,7 +163,7 @@ <h2 class="section" id="methods">Methods

<h3 id="RueI_Displays_ElemCombiner_CalculateOffset_System_Single_System_Single_System_Single_" data-uid="RueI.Displays.ElemCombiner.CalculateOffset(System.Single,System.Single,System.Single)">
CalculateOffset(float, float, float)
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/ElemCombiner.cs/#L84"><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/ElemCombiner.cs/#L85"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Calculates the offset for two hints.</p>
Expand Down Expand Up @@ -204,7 +208,7 @@ <h4 class="section">Returns</h4>

<h3 id="RueI_Displays_ElemCombiner_Combine_System_Collections_Generic_IEnumerable_RueI_Elements_Element__" data-uid="RueI.Displays.ElemCombiner.Combine(System.Collections.Generic.IEnumerable{RueI.Elements.Element})">
Combine(IEnumerable&lt;Element&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/ElemCombiner.cs/#L21"><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/ElemCombiner.cs/#L25"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Combines multiple <a class="xref" href="RueI.Elements.Element.html">Element</a>s into a string.</p>
Expand Down Expand Up @@ -243,7 +247,7 @@ <h4 class="section">Returns</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/ElemCombiner.cs/#L14" class="edit-link">Edit this page</a>
<a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/ElemCombiner.cs/#L18" class="edit-link">Edit this page</a>
</div>


Expand Down
2 changes: 1 addition & 1 deletion api/RueI.Extensions.AutoElement.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ <h4 class="section">Parameters</h4>

<h3 id="RueI_Extensions_AutoElement_RemoveFrom_RueI_Displays_DisplayCore_" data-uid="RueI.Extensions.AutoElement.RemoveFrom(RueI.Displays.DisplayCore)">
RemoveFrom(DisplayCore)
<a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/AutoGiving/AutoGivers.cs/#L154"><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/AutoGiving/AutoGivers.cs/#L153"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Removes this <a class="xref" href="RueI.Extensions.AutoElement.html">AutoElement</a> from a <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a>.</p>
Expand Down
Loading

0 comments on commit fc37acd

Please sign in to comment.