From 0ff92db39b2ac5f15b6cc9e62f89ad821db1a788 Mon Sep 17 00:00:00 2001 From: Ruemena Date: Thu, 4 Jan 2024 00:04:02 +0000 Subject: [PATCH] deploy: da78773d8d0230475868e42927dc9427e46e27a2 --- api/RueI.Displays.DisplayCore.html | 4 +- api/RueI.Displays.Scheduling.Scheduler.html | 72 ++++++++++----------- api/RueI.Elements.Element.html | 18 +++--- api/RueI.Extensions.AutoElement.html | 16 ++--- api/RueI.Extensions.html | 2 +- api/RueI.Parsing.CharacterLengths.html | 4 +- api/RueI.Parsing.html | 2 +- api/RueI.Patches.HintPatch.html | 2 +- index.json | 12 ++-- xrefmap.yml | 18 +++--- 10 files changed, 75 insertions(+), 75 deletions(-) diff --git a/api/RueI.Displays.DisplayCore.html b/api/RueI.Displays.DisplayCore.html index c04d8ea..0f33729 100644 --- a/api/RueI.Displays.DisplayCore.html +++ b/api/RueI.Displays.DisplayCore.html @@ -514,13 +514,13 @@

- 
public void Update(int priority = 100)
+ 
public void Update(int priority = 10)

Parameters

priority int
-

The priority of the update - defaults to 100.

+

The priority of the update - defaults to 10.

diff --git a/api/RueI.Displays.Scheduling.Scheduler.html b/api/RueI.Displays.Scheduling.Scheduler.html index 155256c..62430e9 100644 --- a/api/RueI.Displays.Scheduling.Scheduler.html +++ b/api/RueI.Displays.Scheduling.Scheduler.html @@ -157,7 +157,8 @@

Remarks

-

The Scheduler is a powerful class that enables "batch operations". This means that multiple updates to a display can happen at once, helping to avoid the hint ratelimit.

+

The Scheduler is a powerful class that enables "batch operations". This means that multiple updates to a display can happen at once, helping to avoid the hint ratelimit. +More detailed information is available at Using the Scheduler.

@@ -177,12 +178,12 @@

- 
public Scheduler(DisplayCore coordinator)
+ 
public Scheduler(DisplayCore core)

Parameters

-
coordinator DisplayCore
+
core DisplayCore

The DisplayCore to use.

@@ -206,7 +207,7 @@

Methods

CalculateWeighted(IEnumerable<ScheduledJob>) - +

Calculates the weighted time for a list of jobs to be performed.

@@ -220,7 +221,7 @@

Parameters

jobs IEnumerable<ScheduledJob>
-

The jobs.

+

The ScheduledJob operations to schedule.

@@ -245,10 +246,10 @@

Returns

KillJob(JobToken) - +

-

Attempts to kill the job with the JobToken.

+

Attempts to kill the ScheduledJob with the JobToken.

@@ -278,10 +279,10 @@

Parameters

Schedule(ScheduledJob) - +

-

Schedules a job.

+

Schedules a ScheduledJob.

@@ -311,10 +312,10 @@

Parameters

Schedule(ScheduledJob, params ScheduledJob[]) - +

-

Schedules multiple jobs.

+

Schedules multiple ScheduledJob operations.

@@ -325,10 +326,10 @@

Parameters

job ScheduledJob
-

The first job to schedule.

+

The first ScheduledJob to schedule.

jobs ScheduledJob[]
-

The rest of the jobs to schedule.

+

The rest of the ScheduledJob operations to schedule.

@@ -339,38 +340,33 @@

Parameters

+

Remarks

+

When scheduling multiple jobs at a time, this method is preferred to calling Schedule(ScheduledJob) several +times since it only recalculates the batches once.

+
-

- Schedule(Action, TimeSpan, int, JobToken?) - +

+ Schedule(IEnumerable<ScheduledJob>) +

-

Schedules a job.

+

Schedules multiple ScheduledJob operations.

- 
public void Schedule(Action action, TimeSpan time, int priority, JobToken? token = null)
+ 
public void Schedule(IEnumerable<ScheduledJob> jobs)

Parameters

-
action Action
-

The Action to run.

-
-
time TimeSpan
-

How long into the future to run the action at.

-
-
priority int
-

The priority of the job, giving it additional weight when calculating.

-
-
token JobToken
-

An optional token to assign to the ScheduledJob.

+
jobs IEnumerable<ScheduledJob>
+

The jobs to schedule.

@@ -381,6 +377,10 @@

Parameters

+

Remarks

+

When scheduling multiple jobs at a time, this method is preferred to calling Schedule(ScheduledJob) several +times since it only recalculates the batches once.

+
@@ -389,10 +389,10 @@

Parameters

Schedule(TimeSpan, Action, JobToken?) - +

-

Schedules a job with a priority of 1.

+

Schedules a ScheduledJob with a priority of 1.

@@ -428,10 +428,10 @@

Parameters

Schedule(TimeSpan, Action, int, JobToken?) - +

-

Schedules a job.

+

Schedules a new ScheduledJob.

@@ -470,10 +470,10 @@

Parameters

ScheduleUpdate(TimeSpan, int) - +

-

Schedules an uncancellable update job.

+

Schedules an uncancellable update ScheduledJob.

@@ -487,7 +487,7 @@

Parameters

How long into the future to update at.

priority int
-

The priority of the job, giving it additional weight when calculating.

+

The priority of the ScheduledJob, giving it additional weight when calculating.

diff --git a/api/RueI.Elements.Element.html b/api/RueI.Elements.Element.html index 50d6081..53b8a8b 100644 --- a/api/RueI.Elements.Element.html +++ b/api/RueI.Elements.Element.html @@ -91,7 +91,7 @@
Table of Contents

Class Element - +

@@ -183,7 +183,7 @@

Constructors

Element(float) - +

Initializes a new instance of the Element class.

@@ -220,7 +220,7 @@

Properties

Enabled - +

Gets or sets a value indicating whether or not this element is enabled and will show.

@@ -252,7 +252,7 @@

Property Value

Options - +

Gets or sets the options for this element.

@@ -284,7 +284,7 @@

Property Value

Parser - +

Gets or sets the Parser currently in use by this Element.

@@ -319,7 +319,7 @@

Remarks

Position - +

Gets or sets the position of the element on a scale from 0-1000, where 0 represents the bottom of the screen and 1000 represents the top.

@@ -351,7 +351,7 @@

Property Value

ZIndex - +

Gets or sets the priority of the hint (determining if it shows above another hint).

@@ -387,7 +387,7 @@

Methods

GetParsedData() - +

Gets the data used for parsing.

@@ -423,7 +423,7 @@

Remarks

- Edit this page + Edit this page
diff --git a/api/RueI.Extensions.AutoElement.html b/api/RueI.Extensions.AutoElement.html index 4d089a6..6182722 100644 --- a/api/RueI.Extensions.AutoElement.html +++ b/api/RueI.Extensions.AutoElement.html @@ -99,7 +99,7 @@

Assembly
RueI.dll

-

Manages and automatically assigns elements to ReferenceHubs meeting a criteria.

+

Manages and automatically assigns elements to DisplayCore instances meeting a criteria.

@@ -166,7 +166,7 @@

Properties

Roles - +

Gets or sets the roles that this AutoElement will give this element on.

@@ -202,7 +202,7 @@

Methods

Create<T>(Roles, Func<DisplayCore, T>) - +

Creates a new AutoElement using a IElemReference<T>.

@@ -250,7 +250,7 @@

Type Parameters

Create<T>(Roles, T) - +

Creates a new AutoElement of a shared Element.

@@ -298,7 +298,7 @@

Type Parameters

Disable() - +

Disables this AutoElement.

@@ -325,7 +325,7 @@

GiveTo(DisplayCore) - +

Gives this AutoElement to a DisplayCore.

@@ -358,7 +358,7 @@

Parameters

RemoveFrom(DisplayCore) - +

Removes this AutoElement from a DisplayCore.

@@ -391,7 +391,7 @@

Parameters

UpdateEvery(TimeSpan, int) - +

Schedules an update for all players with one of the Roles every span.

diff --git a/api/RueI.Extensions.html b/api/RueI.Extensions.html index 07c3aab..2e15b60 100644 --- a/api/RueI.Extensions.html +++ b/api/RueI.Extensions.html @@ -98,7 +98,7 @@

AutoElement
-

Manages and automatically assigns elements to ReferenceHubs meeting a criteria.

+

Manages and automatically assigns elements to DisplayCore instances meeting a criteria.

diff --git a/api/RueI.Parsing.CharacterLengths.html b/api/RueI.Parsing.CharacterLengths.html index c3b3c1c..e6d6ded 100644 --- a/api/RueI.Parsing.CharacterLengths.html +++ b/api/RueI.Parsing.CharacterLengths.html @@ -99,7 +99,7 @@

Assembly
RueI.dll

-

Provides a variety of constant values.

+

Provides lengths for characters in hints.

@@ -150,7 +150,7 @@

Remarks

-

This class is mosty designed for internal use within RueI. However, they can still be useful for external use.

+

This class is mosty designed for internal use within RueI. However, it can still be useful for external use.

diff --git a/api/RueI.Parsing.html b/api/RueI.Parsing.html index b31af98..41e6b7f 100644 --- a/api/RueI.Parsing.html +++ b/api/RueI.Parsing.html @@ -98,7 +98,7 @@

CharacterLengths
-

Provides a variety of constant values.

+

Provides lengths for characters in hints.

diff --git a/api/RueI.Patches.HintPatch.html b/api/RueI.Patches.HintPatch.html index c28dec1..7a1849f 100644 --- a/api/RueI.Patches.HintPatch.html +++ b/api/RueI.Patches.HintPatch.html @@ -164,7 +164,7 @@

Methods

Transpiler(IEnumerable<CodeInstruction>, ILGenerator) - +

Patches HintDisplay.Show to detect when hints are shown.

diff --git a/index.json b/index.json index 3433d8c..c37a124 100644 --- a/index.json +++ b/index.json @@ -22,7 +22,7 @@ "api/RueI.Displays.DisplayCore.html": { "href": "api/RueI.Displays.DisplayCore.html", "title": "Class DisplayCore | RueI", - "keywords": "Class DisplayCore Namespace RueI.Displays Assembly RueI.dll Manages all of the DisplayBases for a ReferenceHub. public class DisplayCore Inheritance object DisplayCore Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Extension Methods DisplayCoreExtensions.AddTemp(DisplayCore, T, TimeSpan, TimedElemRef) DisplayCoreExtensions.SetElementOrNew(DisplayCore, IElemReference, string, float) DisplayCoreExtensions.ShowTemp(DisplayCore, string, float, TimeSpan, TimedElemRef) DisplayCoreExtensions.ShowTempFunctional(DisplayCore, string, float, TimeSpan, TimedElemRef) UniversalExtensions.AddTo(T, ICollection) Constructors DisplayCore(ReferenceHub) Initializes a new instance of the DisplayCore class. protected DisplayCore(ReferenceHub hub) Parameters hub ReferenceHub The hub to create the display for. Properties Scheduler Gets the Scheduler for this DisplayCore. public Scheduler Scheduler { get; } Property Value Scheduler Methods AddAsReference(IElemReference, T) Adds an Element as an IElemReference. public void AddAsReference(IElemReference reference, T element) where T : Element Parameters reference IElemReference The IElemReference to use. element T The Element to add. Type Parameters T The type of the Element to add. Get(ReferenceHub) Gets a DisplayCore from a ReferenceHub, or creates it if it doesn't exist. public static DisplayCore Get(ReferenceHub hub) Parameters hub ReferenceHub The hub to get the display for. Returns DisplayCore The DisplayCore. Remarks This method will never fail nor return null. GetElementOrNew(IElemReference, Func) Gets an Element as T, or creates it. public T GetElementOrNew(IElemReference reference, Func creator) where T : Element Parameters reference IElemReference The IElemReference to use. creator Func A function that creates a new instance of T if it does not exist. Returns T The instance of T. Type Parameters T The type of the Element to get. GetElement(IElemReference) Gets an Element as T if the IElemReference exists within this DisplayCore's element references. public T? GetElement(IElemReference reference) where T : Element Parameters reference IElemReference The IElemReference to use. Returns T The instance of T if the Element exists within the DisplayCore's element references, otherwise null. Type Parameters T The type of the Element to get. GetReference() Gets a new IElemReference. public static IElemReference GetReference() where T : Element Returns IElemReference A new, unique IElemReference. Type Parameters T The type of the element. RemoveReference(IElemReference) Removes a IElemReference from this DisplayCore. public void RemoveReference(IElemReference reference) where T : Element Parameters reference IElemReference The IElemReference to remove. Type Parameters T The type of the Element to remove. Update(int) Updates this DisplayCore. public void Update(int priority = 100) Parameters priority int The priority of the update - defaults to 100." + "keywords": "Class DisplayCore Namespace RueI.Displays Assembly RueI.dll Manages all of the DisplayBases for a ReferenceHub. public class DisplayCore Inheritance object DisplayCore Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Extension Methods DisplayCoreExtensions.AddTemp(DisplayCore, T, TimeSpan, TimedElemRef) DisplayCoreExtensions.SetElementOrNew(DisplayCore, IElemReference, string, float) DisplayCoreExtensions.ShowTemp(DisplayCore, string, float, TimeSpan, TimedElemRef) DisplayCoreExtensions.ShowTempFunctional(DisplayCore, string, float, TimeSpan, TimedElemRef) UniversalExtensions.AddTo(T, ICollection) Constructors DisplayCore(ReferenceHub) Initializes a new instance of the DisplayCore class. protected DisplayCore(ReferenceHub hub) Parameters hub ReferenceHub The hub to create the display for. Properties Scheduler Gets the Scheduler for this DisplayCore. public Scheduler Scheduler { get; } Property Value Scheduler Methods AddAsReference(IElemReference, T) Adds an Element as an IElemReference. public void AddAsReference(IElemReference reference, T element) where T : Element Parameters reference IElemReference The IElemReference to use. element T The Element to add. Type Parameters T The type of the Element to add. Get(ReferenceHub) Gets a DisplayCore from a ReferenceHub, or creates it if it doesn't exist. public static DisplayCore Get(ReferenceHub hub) Parameters hub ReferenceHub The hub to get the display for. Returns DisplayCore The DisplayCore. Remarks This method will never fail nor return null. GetElementOrNew(IElemReference, Func) Gets an Element as T, or creates it. public T GetElementOrNew(IElemReference reference, Func creator) where T : Element Parameters reference IElemReference The IElemReference to use. creator Func A function that creates a new instance of T if it does not exist. Returns T The instance of T. Type Parameters T The type of the Element to get. GetElement(IElemReference) Gets an Element as T if the IElemReference exists within this DisplayCore's element references. public T? GetElement(IElemReference reference) where T : Element Parameters reference IElemReference The IElemReference to use. Returns T The instance of T if the Element exists within the DisplayCore's element references, otherwise null. Type Parameters T The type of the Element to get. GetReference() Gets a new IElemReference. public static IElemReference GetReference() where T : Element Returns IElemReference A new, unique IElemReference. Type Parameters T The type of the element. RemoveReference(IElemReference) Removes a IElemReference from this DisplayCore. public void RemoveReference(IElemReference reference) where T : Element Parameters reference IElemReference The IElemReference to remove. Type Parameters T The type of the Element to remove. Update(int) Updates this DisplayCore. public void Update(int priority = 10) Parameters priority int The priority of the update - defaults to 10." }, "api/RueI.Displays.ElemCombiner.html": { "href": "api/RueI.Displays.ElemCombiner.html", @@ -72,7 +72,7 @@ "api/RueI.Displays.Scheduling.Scheduler.html": { "href": "api/RueI.Displays.Scheduling.Scheduler.html", "title": "Class Scheduler | RueI", - "keywords": "Class Scheduler Namespace RueI.Displays.Scheduling Assembly RueI.dll Provides a means of doing batch operations. public class Scheduler Inheritance object Scheduler Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Extension Methods UniversalExtensions.AddTo(T, ICollection) Remarks The Scheduler is a powerful class that enables \"batch operations\". This means that multiple updates to a display can happen at once, helping to avoid the hint ratelimit. Constructors Scheduler(DisplayCore) Initializes a new instance of the Scheduler class. public Scheduler(DisplayCore coordinator) Parameters coordinator DisplayCore The DisplayCore to use. Methods CalculateWeighted(IEnumerable) Calculates the weighted time for a list of jobs to be performed. public static DateTimeOffset CalculateWeighted(IEnumerable jobs) Parameters jobs IEnumerable The jobs. Returns DateTimeOffset The weighted DateTimeOffset of all of the jobs. KillJob(JobToken) Attempts to kill the job with the JobToken. public void KillJob(JobToken token) Parameters token JobToken The JobToken to use as a reference. Schedule(ScheduledJob) Schedules a job. public void Schedule(ScheduledJob job) Parameters job ScheduledJob The job to schedule. Schedule(ScheduledJob, params ScheduledJob[]) Schedules multiple jobs. public void Schedule(ScheduledJob job, params ScheduledJob[] jobs) Parameters job ScheduledJob The first job to schedule. jobs ScheduledJob[] The rest of the jobs to schedule. Schedule(Action, TimeSpan, int, JobToken?) Schedules a job. public void Schedule(Action action, TimeSpan time, int priority, JobToken? token = null) Parameters action Action The Action to run. time TimeSpan How long into the future to run the action at. priority int The priority of the job, giving it additional weight when calculating. token JobToken An optional token to assign to the ScheduledJob. Schedule(TimeSpan, Action, JobToken?) Schedules a job with a priority of 1. public void Schedule(TimeSpan time, Action action, JobToken? token = null) Parameters time TimeSpan How long into the future to run the action at. action Action The Action to run. token JobToken An optional token to assign to the ScheduledJob. Schedule(TimeSpan, Action, int, JobToken?) Schedules a job. public void Schedule(TimeSpan time, Action action, int priority, JobToken? token = null) Parameters time TimeSpan How long into the future to run the action at. action Action The Action to run. priority int The priority of the job, giving it additional weight when calculating. token JobToken An optional token to assign to the ScheduledJob. ScheduleUpdate(TimeSpan, int) Schedules an uncancellable update job. public void ScheduleUpdate(TimeSpan time, int priority) Parameters time TimeSpan How long into the future to update at. priority int The priority of the job, giving it additional weight when calculating." + "keywords": "Class Scheduler Namespace RueI.Displays.Scheduling Assembly RueI.dll Provides a means of doing batch operations. public class Scheduler Inheritance object Scheduler Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Extension Methods UniversalExtensions.AddTo(T, ICollection) Remarks The Scheduler is a powerful class that enables \"batch operations\". This means that multiple updates to a display can happen at once, helping to avoid the hint ratelimit. More detailed information is available at Using the Scheduler. Constructors Scheduler(DisplayCore) Initializes a new instance of the Scheduler class. public Scheduler(DisplayCore core) Parameters core DisplayCore The DisplayCore to use. Methods CalculateWeighted(IEnumerable) Calculates the weighted time for a list of jobs to be performed. public static DateTimeOffset CalculateWeighted(IEnumerable jobs) Parameters jobs IEnumerable The ScheduledJob operations to schedule. Returns DateTimeOffset The weighted DateTimeOffset of all of the jobs. KillJob(JobToken) Attempts to kill the ScheduledJob with the JobToken. public void KillJob(JobToken token) Parameters token JobToken The JobToken to use as a reference. Schedule(ScheduledJob) Schedules a ScheduledJob. public void Schedule(ScheduledJob job) Parameters job ScheduledJob The job to schedule. Schedule(ScheduledJob, params ScheduledJob[]) Schedules multiple ScheduledJob operations. public void Schedule(ScheduledJob job, params ScheduledJob[] jobs) Parameters job ScheduledJob The first ScheduledJob to schedule. jobs ScheduledJob[] The rest of the ScheduledJob operations to schedule. Remarks When scheduling multiple jobs at a time, this method is preferred to calling Schedule(ScheduledJob) several times since it only recalculates the batches once. Schedule(IEnumerable) Schedules multiple ScheduledJob operations. public void Schedule(IEnumerable jobs) Parameters jobs IEnumerable The jobs to schedule. Remarks When scheduling multiple jobs at a time, this method is preferred to calling Schedule(ScheduledJob) several times since it only recalculates the batches once. Schedule(TimeSpan, Action, JobToken?) Schedules a ScheduledJob with a priority of 1. public void Schedule(TimeSpan time, Action action, JobToken? token = null) Parameters time TimeSpan How long into the future to run the action at. action Action The Action to run. token JobToken An optional token to assign to the ScheduledJob. Schedule(TimeSpan, Action, int, JobToken?) Schedules a new ScheduledJob. public void Schedule(TimeSpan time, Action action, int priority, JobToken? token = null) Parameters time TimeSpan How long into the future to run the action at. action Action The Action to run. priority int The priority of the job, giving it additional weight when calculating. token JobToken An optional token to assign to the ScheduledJob. ScheduleUpdate(TimeSpan, int) Schedules an uncancellable update ScheduledJob. public void ScheduleUpdate(TimeSpan time, int priority) Parameters time TimeSpan How long into the future to update at. priority int The priority of the ScheduledJob, giving it additional weight when calculating." }, "api/RueI.Displays.Scheduling.TimedElemRef-1.html": { "href": "api/RueI.Displays.Scheduling.TimedElemRef-1.html", @@ -172,7 +172,7 @@ "api/RueI.Extensions.AutoElement.html": { "href": "api/RueI.Extensions.AutoElement.html", "title": "Class AutoElement | RueI", - "keywords": "Class AutoElement Namespace RueI.Extensions Assembly RueI.dll Manages and automatically assigns elements to ReferenceHubs meeting a criteria. public class AutoElement Inheritance object AutoElement Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Extension Methods UniversalExtensions.AddTo(T, ICollection) Properties Roles Gets or sets the roles that this AutoElement will give this element on. public Roles Roles { get; set; } Property Value Roles Methods Create(Roles, Func) Creates a new AutoElement using a IElemReference. public static AutoElement Create(Roles roles, Func creator) where T : Element Parameters roles Roles The Roles to use for the AutoElement. creator Func A Func that creates the elements. Returns AutoElement A new AutoElement. Type Parameters T The type of the Element. Create(Roles, T) Creates a new AutoElement of a shared Element. public static AutoElement Create(Roles roles, T element) where T : Element Parameters roles Roles The Roles to use for the AutoElement. element T The element to use. Returns AutoElement A new AutoElement. Type Parameters T The type of the Element. Disable() Disables this AutoElement. public virtual void Disable() GiveTo(DisplayCore) Gives this AutoElement to a DisplayCore. protected virtual void GiveTo(DisplayCore core) Parameters core DisplayCore The DisplayCore to give to. RemoveFrom(DisplayCore) Removes this AutoElement from a DisplayCore. protected virtual void RemoveFrom(DisplayCore core) Parameters core DisplayCore The DisplayCore to give to. UpdateEvery(TimeSpan, int) Schedules an update for all players with one of the Roles every span. public AutoElement UpdateEvery(TimeSpan span, int priority = 35) Parameters span TimeSpan How often to schedule an update. priority int The priority of the update. Returns AutoElement A reference to this AutoElement." + "keywords": "Class AutoElement Namespace RueI.Extensions Assembly RueI.dll Manages and automatically assigns elements to DisplayCore instances meeting a criteria. public class AutoElement Inheritance object AutoElement Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Extension Methods UniversalExtensions.AddTo(T, ICollection) Properties Roles Gets or sets the roles that this AutoElement will give this element on. public Roles Roles { get; set; } Property Value Roles Methods Create(Roles, Func) Creates a new AutoElement using a IElemReference. public static AutoElement Create(Roles roles, Func creator) where T : Element Parameters roles Roles The Roles to use for the AutoElement. creator Func A Func that creates the elements. Returns AutoElement A new AutoElement. Type Parameters T The type of the Element. Create(Roles, T) Creates a new AutoElement of a shared Element. public static AutoElement Create(Roles roles, T element) where T : Element Parameters roles Roles The Roles to use for the AutoElement. element T The element to use. Returns AutoElement A new AutoElement. Type Parameters T The type of the Element. Disable() Disables this AutoElement. public virtual void Disable() GiveTo(DisplayCore) Gives this AutoElement to a DisplayCore. protected virtual void GiveTo(DisplayCore core) Parameters core DisplayCore The DisplayCore to give to. RemoveFrom(DisplayCore) Removes this AutoElement from a DisplayCore. protected virtual void RemoveFrom(DisplayCore core) Parameters core DisplayCore The DisplayCore to give to. UpdateEvery(TimeSpan, int) Schedules an update for all players with one of the Roles every span. public AutoElement UpdateEvery(TimeSpan span, int priority = 35) Parameters span TimeSpan How often to schedule an update. priority int The priority of the update. Returns AutoElement A reference to this AutoElement." }, "api/RueI.Extensions.CollectionExtensions.html": { "href": "api/RueI.Extensions.CollectionExtensions.html", @@ -237,7 +237,7 @@ "api/RueI.Extensions.html": { "href": "api/RueI.Extensions.html", "title": "Namespace RueI.Extensions | RueI", - "keywords": "Namespace RueI.Extensions Classes AutoElement Manages and automatically assigns elements to ReferenceHubs meeting a criteria. CollectionExtensions Provides extensions for working with collections. DisplayCoreExtensions Provides miscellaneous utility for DisplayCores. ElementHelpers Provides extensions and helpers for working with elements. EnumExtensions Provides extensions for working with RueI Enums. IComparableExtensions Provides extensions and helpers for working with elements. IEnumerableExtensions Provides extensions for working with collections. Intersection Represents an intersection between a class and an interface. ReflectionHelpers Contains methods designed for use by reflection. UniversalExtensions Provides extensions for working with all types." + "keywords": "Namespace RueI.Extensions Classes AutoElement Manages and automatically assigns elements to DisplayCore instances meeting a criteria. CollectionExtensions Provides extensions for working with collections. DisplayCoreExtensions Provides miscellaneous utility for DisplayCores. ElementHelpers Provides extensions and helpers for working with elements. EnumExtensions Provides extensions for working with RueI Enums. IComparableExtensions Provides extensions and helpers for working with elements. IEnumerableExtensions Provides extensions for working with collections. Intersection Represents an intersection between a class and an interface. ReflectionHelpers Contains methods designed for use by reflection. UniversalExtensions Provides extensions for working with all types." }, "api/RueI.NonUnityProvider.TaskAsyncOperation.html": { "href": "api/RueI.NonUnityProvider.TaskAsyncOperation.html", @@ -252,7 +252,7 @@ "api/RueI.Parsing.CharacterLengths.html": { "href": "api/RueI.Parsing.CharacterLengths.html", "title": "Class CharacterLengths | RueI", - "keywords": "Class CharacterLengths Namespace RueI.Parsing Assembly RueI.dll Provides a variety of constant values. public static class CharacterLengths Inheritance object CharacterLengths Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Remarks This class is mosty designed for internal use within RueI. However, they can still be useful for external use. Properties Lengths Gets a IReadOnlyDictionary of character sizes. public static IReadOnlyDictionary Lengths { get; } Property Value IReadOnlyDictionary" + "keywords": "Class CharacterLengths Namespace RueI.Parsing Assembly RueI.dll Provides lengths for characters in hints. public static class CharacterLengths Inheritance object CharacterLengths Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Remarks This class is mosty designed for internal use within RueI. However, it can still be useful for external use. Properties Lengths Gets a IReadOnlyDictionary of character sizes. public static IReadOnlyDictionary Lengths { get; } Property Value IReadOnlyDictionary" }, "api/RueI.Parsing.ClosingTag-1.html": { "href": "api/RueI.Parsing.ClosingTag-1.html", @@ -637,7 +637,7 @@ "api/RueI.Parsing.html": { "href": "api/RueI.Parsing.html", "title": "Namespace RueI.Parsing | RueI", - "keywords": "Namespace RueI.Parsing Classes CharacterLengths Provides a variety of constant values. ClosingTag Defines the base class for all rich text tags. NoParamsTag Defines the base class for all rich text tags. Parser Helps parse the content of elements. This class cannot be inherited. ParserBuilder Builds Parsers. ParserContext Describes the state of a parser at a time. RichTextTag Defines the base class for all rich text tags. TextInfo Provides information about TMP text at a certain point." + "keywords": "Namespace RueI.Parsing Classes CharacterLengths Provides lengths for characters in hints. ClosingTag Defines the base class for all rich text tags. NoParamsTag Defines the base class for all rich text tags. Parser Helps parse the content of elements. This class cannot be inherited. ParserBuilder Builds Parsers. ParserContext Describes the state of a parser at a time. RichTextTag Defines the base class for all rich text tags. TextInfo Provides information about TMP text at a certain point." }, "api/RueI.Patches.HintPatch.html": { "href": "api/RueI.Patches.HintPatch.html", diff --git a/xrefmap.yml b/xrefmap.yml index 3643104..40b8382 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -953,15 +953,15 @@ references: fullName.vb: RueI.Displays.Scheduling.Scheduler.Schedule(RueI.Displays.Scheduling.Records.ScheduledJob, ParamArray RueI.Displays.Scheduling.Records.ScheduledJob()) nameWithType: Scheduler.Schedule(ScheduledJob, params ScheduledJob[]) nameWithType.vb: Scheduler.Schedule(ScheduledJob, ParamArray ScheduledJob()) -- uid: RueI.Displays.Scheduling.Scheduler.Schedule(System.Action,System.TimeSpan,System.Int32,RueI.Displays.Scheduling.JobToken) - name: Schedule(Action, TimeSpan, int, JobToken?) - href: api/RueI.Displays.Scheduling.Scheduler.html#RueI_Displays_Scheduling_Scheduler_Schedule_System_Action_System_TimeSpan_System_Int32_RueI_Displays_Scheduling_JobToken_ - commentId: M:RueI.Displays.Scheduling.Scheduler.Schedule(System.Action,System.TimeSpan,System.Int32,RueI.Displays.Scheduling.JobToken) - name.vb: Schedule(Action, TimeSpan, Integer, JobToken) - fullName: RueI.Displays.Scheduling.Scheduler.Schedule(System.Action, System.TimeSpan, int, RueI.Displays.Scheduling.JobToken?) - fullName.vb: RueI.Displays.Scheduling.Scheduler.Schedule(System.Action, System.TimeSpan, Integer, RueI.Displays.Scheduling.JobToken) - nameWithType: Scheduler.Schedule(Action, TimeSpan, int, JobToken?) - nameWithType.vb: Scheduler.Schedule(Action, TimeSpan, Integer, JobToken) +- uid: RueI.Displays.Scheduling.Scheduler.Schedule(System.Collections.Generic.IEnumerable{RueI.Displays.Scheduling.Records.ScheduledJob}) + name: Schedule(IEnumerable) + href: api/RueI.Displays.Scheduling.Scheduler.html#RueI_Displays_Scheduling_Scheduler_Schedule_System_Collections_Generic_IEnumerable_RueI_Displays_Scheduling_Records_ScheduledJob__ + commentId: M:RueI.Displays.Scheduling.Scheduler.Schedule(System.Collections.Generic.IEnumerable{RueI.Displays.Scheduling.Records.ScheduledJob}) + name.vb: Schedule(IEnumerable(Of ScheduledJob)) + fullName: RueI.Displays.Scheduling.Scheduler.Schedule(System.Collections.Generic.IEnumerable) + fullName.vb: RueI.Displays.Scheduling.Scheduler.Schedule(System.Collections.Generic.IEnumerable(Of RueI.Displays.Scheduling.Records.ScheduledJob)) + nameWithType: Scheduler.Schedule(IEnumerable) + nameWithType.vb: Scheduler.Schedule(IEnumerable(Of ScheduledJob)) - uid: RueI.Displays.Scheduling.Scheduler.Schedule(System.TimeSpan,System.Action,RueI.Displays.Scheduling.JobToken) name: Schedule(TimeSpan, Action, JobToken?) href: api/RueI.Displays.Scheduling.Scheduler.html#RueI_Displays_Scheduling_Scheduler_Schedule_System_TimeSpan_System_Action_RueI_Displays_Scheduling_JobToken_