deploy: 17eef8f

api/RueI.Displays.Display.html

@@ -99,7 +99,7 @@ <h1 id="RueI_Displays_Display" data-uid="RueI.Displays.Display" class="text-brea
   <dl><dt>Assembly</dt><dd>RueI.dll</dd></dl>
   </div>
 
-  <div class="markdown summary"><p>Represents a display attached to a <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a>.</p>
+  <div class="markdown summary"><p>Represents a basic display attached to a <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a>.</p>
 </div>
   <div class="markdown conceptual"></div>
 

api/RueI.Displays.DisplayCore.html

@@ -99,7 +99,7 @@ <h1 id="RueI_Displays_DisplayCore" data-uid="RueI.Displays.DisplayCore" class="t
   <dl><dt>Assembly</dt><dd>RueI.dll</dd></dl>
   </div>
 
-  <div class="markdown summary"><p>Is responsible for managing all of the <a class="xref" href="RueI.Displays.DisplayBase.html">DisplayBase</a>s for a ReferenceHub.</p>
+  <div class="markdown summary"><p>Manages all of the <a class="xref" href="RueI.Displays.DisplayBase.html">DisplayBase</a>s for a ReferenceHub.</p>
 </div>
   <div class="markdown conceptual"></div>
 
@@ -212,7 +212,7 @@ <h2 class="section" id="properties">Properties
 
   <h3 id="RueI_Displays_DisplayCore_Scheduler" data-uid="RueI.Displays.DisplayCore.Scheduler">
   Scheduler
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayCore.cs/#L42"><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/#L41"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets the <a class="xref" href="RueI.Displays.Scheduling.Scheduler.html">Scheduler</a> for this <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a>.</p>
@@ -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/#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/DisplayCore.cs/#L149"><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>
@@ -290,7 +290,7 @@ <h4 class="section">Type Parameters</h4>
 
   <h3 id="RueI_Displays_DisplayCore_Get_ReferenceHub_" data-uid="RueI.Displays.DisplayCore.Get(ReferenceHub)">
   Get(ReferenceHub)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayCore.cs/#L70"><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/#L64"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets a DisplayCore from a ReferenceHub, or creates it if it doesn't exist.</p>
@@ -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/#L133"><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/#L128"><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>
@@ -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/#L113"><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/#L108"><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>
@@ -425,7 +425,7 @@ <h4 class="section">Type Parameters</h4>
 
   <h3 id="RueI_Displays_DisplayCore_GetReference__1" data-uid="RueI.Displays.DisplayCore.GetReference``1">
   GetReference&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/#L87"><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/#L81"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets a new <a class="xref" href="RueI.Displays.IElemReference-1.html">IElemReference&lt;T&gt;</a>.</p>
@@ -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/#L165"><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/#L160"><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>
@@ -503,7 +503,7 @@ <h4 class="section">Type Parameters</h4>
 
   <h3 id="RueI_Displays_DisplayCore_Update_System_Int32_" data-uid="RueI.Displays.DisplayCore.Update(System.Int32)">
   Update(int)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/DisplayCore.cs/#L97"><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/#L91"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Updates this <a class="xref" href="RueI.Displays.DisplayCore.html">DisplayCore</a>.</p>

api/RueI.Displays.ElemCombiner.html

@@ -159,7 +159,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/#L80"><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/#L84"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Calculates the offset for two hints.</p>

api/RueI.Displays.Roles.html

@@ -92,7 +92,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
   <h1 id="RueI_Displays_Roles" data-uid="RueI.Displays.Roles" class="text-break">
     Enum Roles
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/AutoGiving/Roles.cs/#L8"><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/Roles.cs/#L13"><i class="bi bi-code-slash"></i></a>
   </h1>
 
   <div class="facts text-secondary">
@@ -237,12 +237,27 @@ <h2 id="fields">Fields
 </dd>
   </dl>
 
+  <h2 id="RueI_Displays_Roles_examples">Examples</h2>
+  <p>This example shows how <a class="xref" href="RueI.Displays.Roles.html">Roles</a> can be used to perform bitfield operations with RoleTypeIds.</p>
+<pre><code class="lang-csharp">// the | (pipe) is the bitwise OR operator
+// it combines the bits of all of the provided fields
+// 1010 | 1100 -&gt; 1110
+Roles roles = Roles.CivilianRoles | Roles.FacilityGuard | Roles.ScpsNo0492; // all things that can spawn in at the start of the game
 
+// using RueI.Extensions.HasFlagFast because it is much quicker
+roles.HasFlagFast(Roles.ChaosRifleman); // -&gt; false
+roles.HasFlagFast(Roles.Scientist); // -&gt; true</code></pre>
+
+
+  <h2 id="RueI_Displays_Roles_remarks">Remarks</h2>
+  <div class="markdown level0 remarks"><p>The purpose of the <a class="xref" href="RueI.Displays.Roles.html">Roles</a> enum is to enable roles to be treated like a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.flagsattribute">FlagsAttribute</a> enum. Normally,
+RoleTypeId cannot be treated like bit flags, so this acts as a fast and convenient way to do so.</p>
+</div>
 
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/AutoGiving/Roles.cs/#L8" class="edit-link">Edit this page</a>
+          <a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/AutoGiving/Roles.cs/#L13" class="edit-link">Edit this page</a>
         </div>
 
 

api/RueI.Displays.Scheduling.JobToken.html

@@ -91,7 +91,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
   <h1 id="RueI_Displays_Scheduling_JobToken" data-uid="RueI.Displays.Scheduling.JobToken" class="text-break">
     Class JobToken
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/JobToken.cs/#L6"><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/JobToken.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_JobToken" data-uid="RueI.Displays.Scheduling.Jo
 
 
 
+  <h2 id="RueI_Displays_Scheduling_JobToken_remarks">Remarks</h2>
+  <div class="markdown level0 remarks"><p>A <a class="xref" href="RueI.Displays.Scheduling.JobToken.html">JobToken</a> provides a unique identifier for a <a class="xref" href="RueI.Displays.Scheduling.Records.ScheduledJob.html">ScheduledJob</a> within any number of <a class="xref" href="RueI.Displays.Scheduling.Scheduler.html">Scheduler</a>s. In other words, a <a class="xref" href="RueI.Displays.Scheduling.JobToken.html">JobToken</a> can reference multiple (or no) <a class="xref" href="RueI.Displays.Scheduling.Records.ScheduledJob.html">ScheduledJob</a>, but only a single <a class="xref" href="RueI.Displays.Scheduling.Records.ScheduledJob.html">ScheduledJob</a> with the given <a class="xref" href="RueI.Displays.Scheduling.JobToken.html">JobToken</a> can exist in a <a class="xref" href="RueI.Displays.Scheduling.Scheduler.html">Scheduler</a>.</p>
+</div>
 
 
   <h2 class="section" id="constructors">Constructors
@@ -166,7 +169,7 @@ <h2 class="section" id="constructors">Constructors
 
   <h3 id="RueI_Displays_Scheduling_JobToken__ctor" data-uid="RueI.Displays.Scheduling.JobToken.#ctor">
   JobToken()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/JobToken.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/Displays/Scheduling/JobToken.cs/#L15"><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.JobToken.html">JobToken</a> class.</p>
@@ -189,11 +192,15 @@ <h3 id="RueI_Displays_Scheduling_JobToken__ctor" data-uid="RueI.Displays.Schedul
 
 
 
+  <h2 id="seealso">See Also</h2>
+  <div class="seealso">
+      <div><a class="xref" href="RueI.Displays.Scheduling.Records.ScheduledJob.html">ScheduledJob</a></div>
+  </div>
 
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/JobToken.cs/#L6" class="edit-link">Edit this page</a>
+          <a href="https://github.com/Ruemena/RueI/blob/master/RueI/RueI/Displays/Scheduling/JobToken.cs/#L10" class="edit-link">Edit this page</a>
         </div>