diff --git a/api/RueI.Displays.DisplayBase.html b/api/RueI.Displays.DisplayBase.html index 68dd657..7674dd4 100644 --- a/api/RueI.Displays.DisplayBase.html +++ b/api/RueI.Displays.DisplayBase.html @@ -346,7 +346,7 @@

-

Deletes this display, removing it from the player's coordinator.

+

Deletes this display, removing it from the player's core.

diff --git a/api/RueI.Displays.DisplayCore.html b/api/RueI.Displays.DisplayCore.html index 43718b5..c04d8ea 100644 --- a/api/RueI.Displays.DisplayCore.html +++ b/api/RueI.Displays.DisplayCore.html @@ -158,6 +158,9 @@

DisplayCoreExtensions.ShowTemp(DisplayCore, string, float, TimeSpan, TimedElemRef<SetElement>)

+
+ DisplayCoreExtensions.ShowTempFunctional(DisplayCore, string, float, TimeSpan, TimedElemRef<SetElement>) +
UniversalExtensions.AddTo<T>(T, ICollection<T>)
diff --git a/api/RueI.Displays.Scheduling.RateLimiter.html b/api/RueI.Displays.Scheduling.RateLimiter.html index 5f8d847..ad7dc91 100644 --- a/api/RueI.Displays.Scheduling.RateLimiter.html +++ b/api/RueI.Displays.Scheduling.RateLimiter.html @@ -91,7 +91,7 @@
Table of Contents

Class RateLimiter - +

@@ -156,6 +156,9 @@

Remarks

+

The RateLimiter operates using a simple token bucket ratelimiting algorithm.

+

Constructors @@ -166,7 +169,7 @@

Constructors

RateLimiter(int, TimeSpan) - +

Initializes a new instance of the RateLimiter class.

@@ -206,7 +209,7 @@

Properties

HasTokens - +

Gets a value indicating whether or not this ratelimiter has a token available.

@@ -238,7 +241,7 @@

Property Value

RegenRate - +

Gets or sets the regeneration rate for this ratelimiter.

@@ -270,15 +273,15 @@

Property Value

TokenLimit - +

-

Gets the limit on tokens in this ratelimiter.

+

Gets or sets the limit on tokens in this ratelimiter.

-
public int TokenLimit { get; }
+
public int TokenLimit { get; set; }
@@ -302,7 +305,7 @@

Property Value

Tokens - +

Gets the number of tokens available in this ratelimiter.

@@ -334,19 +337,19 @@

Methods

- + -

- CalculateNewTokens() - +

+ Consume() +

-

Calculates the number of new tokens for this ratelimiter.

+

Consumes a token from this ratelimiter.

-
public void CalculateNewTokens()
+
public void Consume()
@@ -361,22 +364,28 @@

+ -

- Consume() - +

+ TryConsume() +

-

Consumes a token from this ratelimiter.

+

Tries to consume a token from this ratelimiter.

-
public void Consume()
+
public bool TryConsume()
+

Returns

+
+
bool
+

A value indicating whether or not this RateLimiter has a token available.

+
+
@@ -396,7 +405,7 @@

See Also

diff --git a/api/RueI.Displays.Scheduling.Scheduler.html b/api/RueI.Displays.Scheduling.Scheduler.html index 867f0c7..155256c 100644 --- a/api/RueI.Displays.Scheduling.Scheduler.html +++ b/api/RueI.Displays.Scheduling.Scheduler.html @@ -91,7 +91,7 @@
Table of Contents

Class Scheduler - +

@@ -169,7 +169,7 @@

Constructors

Scheduler(DisplayCore) - +

Initializes a new instance of the Scheduler class.

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

Methods

CalculateWeighted(IEnumerable<ScheduledJob>) - +

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

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

Returns

KillJob(JobToken) - +

-

Attempts to kill a single job using the JobToken.

+

Attempts to kill the job with the JobToken.

@@ -274,25 +274,25 @@

Parameters

- + -

- KillMultiple(JobToken) - +

+ Schedule(ScheduledJob) +

-

Attempts to kill all jobs that have the JobToken.

+

Schedules a job.

-
public void KillMultiple(JobToken token)
+
public void Schedule(ScheduledJob job)

Parameters

-
token JobToken
-

The JobToken to use as a reference.

+
job ScheduledJob
+

The job to schedule.

@@ -309,23 +309,26 @@

Parameters

-

- Schedule(ScheduledJob) - +

+ Schedule(ScheduledJob, params ScheduledJob[]) +

-

Schedules a job.

+

Schedules multiple jobs.

-
public void Schedule(ScheduledJob job)
+
public void Schedule(ScheduledJob job, params ScheduledJob[] jobs)

Parameters

job ScheduledJob
-

The job to schedule.

+

The first job to schedule.

+
+
jobs ScheduledJob[]
+

The rest of the jobs to schedule.

@@ -344,7 +347,7 @@

Parameters

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

Schedules a job.

@@ -386,7 +389,7 @@

Parameters

Schedule(TimeSpan, Action, JobToken?) - +

Schedules a job with a priority of 1.

@@ -425,7 +428,7 @@

Parameters

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

Schedules a job.

@@ -467,7 +470,7 @@

Parameters

ScheduleUpdate(TimeSpan, int) - +

Schedules an uncancellable update job.

@@ -503,7 +506,7 @@

Parameters

diff --git a/api/RueI.Displays.ScreenDisplay.html b/api/RueI.Displays.ScreenDisplay.html index bbc36bc..00927dd 100644 --- a/api/RueI.Displays.ScreenDisplay.html +++ b/api/RueI.Displays.ScreenDisplay.html @@ -91,7 +91,7 @@
Table of Contents

Class ScreenDisplay - +

@@ -172,6 +172,11 @@

Remarks

+

A ScreenDisplay is a version of the Display that contains a list of Screens. +A Screen acts as a container for Elements, and only one can be active in a ScreenDisplay +at a time.

+

Constructors @@ -182,7 +187,7 @@

Constructors

ScreenDisplay(ReferenceHub, Screen) - +

Initializes a new instance of the ScreenDisplay class.

@@ -218,7 +223,7 @@

Parameters

ScreenDisplay(DisplayCore, Screen) - +

Initializes a new instance of the ScreenDisplay class.

@@ -258,7 +263,7 @@

Properties

CurrentScreen - +

Gets the current screen of this display.

@@ -290,7 +295,7 @@

Property Value

GlobalElements - +

Gets the elements of this display that will be displayed regardless of screen.

@@ -322,7 +327,7 @@

Property Value

Screens - +

Gets all of the screens of this display.

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

Methods

GetAllElements() - +

Gets all of the elements of this display.

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

Returns

SetScreen(Screen) - +

Sets the CurrentScreen of this display.

@@ -430,7 +435,7 @@

Exceptions

diff --git a/api/RueI.Elements.DynamicElement.html b/api/RueI.Elements.DynamicElement.html index fb9e1e2..5fe16af 100644 --- a/api/RueI.Elements.DynamicElement.html +++ b/api/RueI.Elements.DynamicElement.html @@ -293,7 +293,7 @@

Returns

Remarks

-

This contains information used to ensure that multiple elements can be displayed at once. To obtain this, you should almost always use Parse(string, ElementOptions).

+

This contains information used to ensure that multiple elements can be displayed at once. To obtain this, you must use Parse(string, ElementOptions).

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

Class Element - +

@@ -169,6 +169,10 @@

Remarks

+

An Element is how text is displayed within RueI. Each Element +acts like an individual Hints.Hint, and cannot influence other Elements.

+

Constructors @@ -179,7 +183,7 @@

Constructors

Element(float) - +

Initializes a new instance of the Element class.

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

Properties

Enabled - +

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

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

Property Value

Options - +

Gets or sets the options for this element.

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

Property Value

Parser - +

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

@@ -315,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.

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

Property Value

ZIndex - +

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

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

Methods

GetParsedData() - +

Gets the data used for parsing.

@@ -409,7 +413,7 @@

Returns

Remarks

-

This contains information used to ensure that multiple elements can be displayed at once. To obtain this, you should almost always use Parse(string, ElementOptions).

+

This contains information used to ensure that multiple elements can be displayed at once. To obtain this, you must use Parse(string, ElementOptions).

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

Remarks

diff --git a/api/RueI.Elements.Enums.ElementOptions.html b/api/RueI.Elements.Enums.ElementOptions.html index ab549c1..7b9f027 100644 --- a/api/RueI.Elements.Enums.ElementOptions.html +++ b/api/RueI.Elements.Enums.ElementOptions.html @@ -92,7 +92,7 @@
Table of Contents

Enum ElementOptions - +

@@ -145,11 +145,16 @@

Fields +

Remarks

+

The ElementOptions enum is a bitwise flag enum. This means that the values +of this enum are not mutually exclusive. You can combine values using the bitwise OR operator | +to specify that multiple options should be used.

+
diff --git a/api/RueI.Elements.SetElement.html b/api/RueI.Elements.SetElement.html index c48e58e..6563fbf 100644 --- a/api/RueI.Elements.SetElement.html +++ b/api/RueI.Elements.SetElement.html @@ -296,7 +296,7 @@

Returns

Remarks

-

This contains information used to ensure that multiple elements can be displayed at once. To obtain this, you should almost always use Parse(string, ElementOptions).

+

This contains information used to ensure that multiple elements can be displayed at once. To obtain this, you must use Parse(string, ElementOptions).

diff --git a/api/RueI.Extensions.AutoElement.html b/api/RueI.Extensions.AutoElement.html index df8b591..4d089a6 100644 --- a/api/RueI.Extensions.AutoElement.html +++ b/api/RueI.Extensions.AutoElement.html @@ -91,7 +91,7 @@
Table of Contents

Class AutoElement - +

@@ -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.

@@ -433,7 +433,7 @@

Returns

diff --git a/api/RueI.Extensions.DisplayCoreExtensions.html b/api/RueI.Extensions.DisplayCoreExtensions.html index 95e88fc..abcd13c 100644 --- a/api/RueI.Extensions.DisplayCoreExtensions.html +++ b/api/RueI.Extensions.DisplayCoreExtensions.html @@ -252,7 +252,7 @@

-

Temporarily adds a SetElement using the provided string or position, or sets it if it already exists.

+

Temporarily adds a SetElement using the provided string and position, or sets it if it already exists.

@@ -290,6 +290,51 @@

Parameters

+ + +

+ ShowTempFunctional(DisplayCore, string, float, TimeSpan, TimedElemRef<SetElement>) + +

+ +

Temporarily adds a SetElement using the provided string and functional position, or sets it if it already exists.

+
+
+ +
+
public static void ShowTempFunctional(this DisplayCore core, string content, float position, TimeSpan time, TimedElemRef<SetElement> elemRef)
+
+ +

Parameters

+
+
core DisplayCore
+

The DisplayCore to add the element to.

+
+
content string
+

The content of the element.

+
+
position float
+

The position of the element.

+
+
time TimeSpan
+

How long to keep the element in the DisplayCore for.

+
+
elemRef TimedElemRef<SetElement>
+

The TimedElemRef<T> to use.

+
+
+ + + + + + + + + + + + diff --git a/api/RueI.Extensions.EnumExtensions.html b/api/RueI.Extensions.EnumExtensions.html index bcd8049..b37fadb 100644 --- a/api/RueI.Extensions.EnumExtensions.html +++ b/api/RueI.Extensions.EnumExtensions.html @@ -159,7 +159,7 @@

Methods

HasFlagFast(Roles, RoleTypeId) - +

Quickly determines if a Roles has a RoleTypeId.

@@ -201,7 +201,7 @@

Returns

HasFlagFast(Roles, Roles) - +

Quickly determines if a Roles has another Roles.

@@ -235,6 +235,10 @@

Returns

+

Remarks

+

This method is faster than HasFlag(Enum), because it skips checking whether or not +second is a valid option and avoids boxing/unboxing.

+
@@ -243,7 +247,7 @@

Returns

HasFlagFast(ElementOptions, ElementOptions) - +

Quickly determines if an ElementOptions has another ElementOptions.

@@ -277,6 +281,10 @@

Returns

+

Remarks

+

This method is faster than HasFlag(Enum), because it skips checking whether or not +second is a valid option and avoids boxing/unboxing.

+
diff --git a/api/RueI.Extensions.ReflectionHelpers.html b/api/RueI.Extensions.ReflectionHelpers.html new file mode 100644 index 0000000..a91b30a --- /dev/null +++ b/api/RueI.Extensions.ReflectionHelpers.html @@ -0,0 +1,219 @@ + + + + + Class ReflectionHelpers + | RueI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+ Class ReflectionHelpers + +

+ +
+
Namespace
RueI.Extensions
+
Assembly
RueI.dll
+
+ +

Contains methods designed for use by reflection.

+
+
+ +
+
public static class ReflectionHelpers
+
+ + + + +
+
Inheritance
+
+ +
ReflectionHelpers
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + +
+ + + + + + +

Methods +

+ + + + +

+ GetElementShower() + +

+ +

Gets a Action<T1, T2, T3, T4> that can be used to add an element, with a TimedElemRef<T> as a closure.

+
+
+ +
+
public static Action<ReferenceHub, string, float, TimeSpan> GetElementShower()
+
+ + +

Returns

+
+
Action<ReferenceHub, string, float, TimeSpan>
+

A Action<T1, T2, T3, T4> that can be used to add an element to a ReferenceHub.

+
+
+ + + + + + + +

Remarks

+

This method is not intended to be used when using RueI as a direct dependency.

+
+ + + + + +
+ + + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/api/RueI.Extensions.html b/api/RueI.Extensions.html index ce090fc..07c3aab 100644 --- a/api/RueI.Extensions.html +++ b/api/RueI.Extensions.html @@ -109,11 +109,6 @@

DisplayCoreExtensions

Provides miscellaneous utility for DisplayCores.

-
-
-
-
ElemRefResolver<T>
-

Represents a IElemReference<T> and its associated creator.

@@ -139,6 +134,11 @@

Intersection<T, TOther>

Represents an intersection between a class and an interface.

+
+
+
+
ReflectionHelpers
+

Contains methods designed for use by reflection.

diff --git a/api/RueI.NonUnityProvider.TaskAsyncOperation.html b/api/RueI.NonUnityProvider.TaskAsyncOperation.html index 4211141..52a2d4f 100644 --- a/api/RueI.NonUnityProvider.TaskAsyncOperation.html +++ b/api/RueI.NonUnityProvider.TaskAsyncOperation.html @@ -91,7 +91,7 @@
Table of Contents

Class NonUnityProvider.TaskAsyncOperation - +

@@ -173,7 +173,7 @@

Constructors

TaskAsyncOperation(TimeSpan, Action) - +

Initializes a new instance of the NonUnityProvider.TaskAsyncOperation class, and then immediately runs.

@@ -213,7 +213,7 @@

Properties

IsRunning - +

Gets a value indicating whether or not this operation is currently running.

@@ -249,7 +249,7 @@

Methods

Cancel() - +

Cancels this operation.

@@ -276,7 +276,7 @@

Dispose() - +

Disposes this async operation.

@@ -303,7 +303,7 @@

- Edit this page + Edit this page

diff --git a/api/RueI.NonUnityProvider.html b/api/RueI.NonUnityProvider.html index 3e00553..2ecdfa4 100644 --- a/api/RueI.NonUnityProvider.html +++ b/api/RueI.NonUnityProvider.html @@ -91,7 +91,7 @@
Table of Contents

Class NonUnityProvider - +

@@ -170,7 +170,7 @@

Methods

Log(string) - +

Logs a message to the console.

@@ -199,11 +199,44 @@

Parameters

+ + +

+ LogDebug(string) + +

+ +

Logs a debug message to the console.

+
+
+ +
+
public override void LogDebug(string message)
+
+ +

Parameters

+
+
message string
+

The debug message to log.

+
+
+ + + + + + + + + + + +

LogWarn(string) - +

Logs a warning message to the console.

@@ -236,7 +269,7 @@

Parameters

PatchAll(Harmony) - +

Loads all patches.

@@ -269,7 +302,7 @@

Parameters

PerformAsync(TimeSpan, Action) - +

Performs an async operation.

@@ -311,7 +344,7 @@

Returns

diff --git a/api/RueI.CharacterLengths.html b/api/RueI.Parsing.CharacterLengths.html similarity index 89% rename from api/RueI.CharacterLengths.html rename to api/RueI.Parsing.CharacterLengths.html index 9bdd4e9..c3b3c1c 100644 --- a/api/RueI.CharacterLengths.html +++ b/api/RueI.Parsing.CharacterLengths.html @@ -17,7 +17,7 @@ - + @@ -85,21 +85,21 @@
Table of Contents
-
+
-

+

Class CharacterLengths

-
Namespace
RueI
+
Namespace
RueI.Parsing
Assembly
RueI.dll
-

Provides lengths for characters in hints.

+

Provides a variety of constant values.

@@ -149,7 +149,7 @@

Remarks

+

Remarks

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

@@ -158,9 +158,9 @@

Properties

- + -

+

Lengths

diff --git a/api/RueI.Parsing.ClosingTag-1.html b/api/RueI.Parsing.ClosingTag-1.html index 986064d..a803814 100644 --- a/api/RueI.Parsing.ClosingTag-1.html +++ b/api/RueI.Parsing.ClosingTag-1.html @@ -149,6 +149,7 @@

Type Parameters

+
diff --git a/api/RueI.Parsing.Parser.html b/api/RueI.Parsing.Parser.html index 73abb89..72d0098 100644 --- a/api/RueI.Parsing.Parser.html +++ b/api/RueI.Parsing.Parser.html @@ -91,7 +91,7 @@

Table of Contents

Class Parser - +

@@ -177,7 +177,7 @@

Properties

DefaultParser - +

Gets the default Parser.

@@ -209,7 +209,7 @@

Property Value

TagBackups - +

Gets a list of Parsers which this Parser will include the tags for.

@@ -241,7 +241,7 @@

Property Value

Tags - +

Gets the tags that will be searched for when parsing.

@@ -280,7 +280,7 @@

Methods

AddCharacter(ParserContext, char, bool) - +

Adds a character to a parser context.

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

Parameters

CalculateCharacterLength(TextInfo, char) - +

Calculates the length of a char with a context.

@@ -361,7 +361,7 @@

Returns

CreateLineBreak(ParserContext, bool) - +

Generates the effects of a linebreak for a parser.

@@ -397,7 +397,7 @@

Parameters

GetTagAttributes(string, out Dictionary<string, string>) - +

Parses the tag attributes of a string.

@@ -439,7 +439,7 @@

Returns

Parse(string, ElementOptions) - +

Parses a rich text string.

@@ -485,7 +485,7 @@

See Also

diff --git a/api/RueI.Parsing.Tags.ConcreteTags.CloseVOffsetTag.html b/api/RueI.Parsing.Tags.ConcreteTags.CloseVOffsetTag.html new file mode 100644 index 0000000..b81e167 --- /dev/null +++ b/api/RueI.Parsing.Tags.ConcreteTags.CloseVOffsetTag.html @@ -0,0 +1,240 @@ + + + + + Class CloseVOffsetTag + | RueI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+ Class CloseVOffsetTag + +

+ +
+
Namespace
RueI.Parsing.Tags.ConcreteTags
+
Assembly
RueI.dll
+
+ +

Provides a way to handle closing voffset tags.

+
+
+ +
+
public class CloseVOffsetTag : ClosingTag<CloseVOffsetTag>
+
+ + + + +
+
Inheritance
+
+ + + + +
CloseVOffsetTag
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + + + + + + +
+ +
+
Extension Methods
+
+ +
+ + + + + +

Properties +

+ + + + +

+ Name + +

+ +

Gets the only name of this ClosingTag<T>.

+
+
+ +
+
public override string Name { get; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + + +
+ + + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/api/RueI.Extensions.ElemRefResolver-1.html b/api/RueI.Parsing.Tags.ConcreteTags.VOffsetTag.html similarity index 55% rename from api/RueI.Extensions.ElemRefResolver-1.html rename to api/RueI.Parsing.Tags.ConcreteTags.VOffsetTag.html index 702a673..f583826 100644 --- a/api/RueI.Extensions.ElemRefResolver-1.html +++ b/api/RueI.Parsing.Tags.ConcreteTags.VOffsetTag.html @@ -2,10 +2,10 @@ - Class ElemRefResolver<T> + <title>Class VOffsetTag | RueI - @@ -17,7 +17,7 @@ - + @@ -85,56 +85,52 @@
Table of Contents
-
+
-

- Class ElemRefResolver<T> - +

+ Class VOffsetTag +

-
Namespace
RueI.Extensions
+
Namespace
RueI.Parsing.Tags.ConcreteTags
Assembly
RueI.dll
-

Represents a IElemReference<T> and its associated creator.

+

Provides a way to handle voffset tags.

-
public record ElemRefResolver<T> : IEquatable<ElemRefResolver<T>> where T : Element
+
public class VOffsetTag : MeasurementTag
-

Type Parameters

-
-
T
-

The type of the element.

-
-
Inheritance
-
ElemRefResolver<T>
+ + +
VOffsetTag
-
-
Implements
-
- -
-
Inherited Members
+ + @@ -170,63 +166,23 @@

Type Parameters

-

Constructors -

- - - - -

- ElemRefResolver(IElemReference<T>, Func<T>) - -

- -

Represents a IElemReference<T> and its associated creator.

-
-
- -
-
public ElemRefResolver(IElemReference<T> elemRef, Func<T> creator)
-
- -

Parameters

-
-
elemRef IElemReference<T>
-

The IElemReference<T> to use.

-
-
creator Func<T>
-

A Func<TResult> that creates the element. if it does not exist.

-
-
- - - - - - - - - - - -

Properties

- + -

- creator - +

+ AllowPercentages +

-

A Func<TResult> that creates the element. if it does not exist.

+

Gets a value indicating whether or not this tag allows parentheses.

-
public Func<T> creator { get; init; }
+
public override bool AllowPercentages { get; }
@@ -235,7 +191,7 @@

Property Value

-
Func<T>
+
bool
@@ -246,19 +202,19 @@

Property Value

- + -

- elemRef - +

+ Names +

-

The IElemReference<T> to use.

+

Gets the names of this tag.

-
public IElemReference<T> elemRef { get; init; }
+
public override string[] Names { get; }
@@ -267,7 +223,7 @@

Property Value

-
IElemReference<T>
+
string[]
@@ -282,32 +238,35 @@

Methods

- + -

- GetFor(DisplayCore) - +

+ HandleTag(ParserContext, MeasurementInfo) +

-

Gets an instance of T using the IElemReference<T>, or creates it.

+

Handles an instance of this tag with MeasurementInfo.

-
public T GetFor(DisplayCore core)
+
public override bool HandleTag(ParserContext context, MeasurementInfo info)

Parameters

-
core DisplayCore
-

The DisplayCore to use.

+
context ParserContext
+

The context of the parser.

+
+
info MeasurementInfo
+

The information about the measurement.

Returns

-
T
-

An instance of T.

+
bool
+

true if the tag is valid, otherwise false.

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

Returns

diff --git a/api/RueI.Parsing.Tags.ConcreteTags.html b/api/RueI.Parsing.Tags.ConcreteTags.html index 46d0c06..1fdca4a 100644 --- a/api/RueI.Parsing.Tags.ConcreteTags.html +++ b/api/RueI.Parsing.Tags.ConcreteTags.html @@ -239,6 +239,11 @@

CloseUnderlineTag

Provides a way to handle closing underline tags.

+
+
+
+
CloseVOffsetTag
+

Provides a way to handle closing voffset tags.

@@ -361,6 +366,11 @@

Provides a way to handle italics tags.

+
+
VOffsetTag
+

Provides a way to handle voffset tags.

+
+

diff --git a/api/RueI.Parsing.Tags.MeasurementTag.html b/api/RueI.Parsing.Tags.MeasurementTag.html index 14473c8..d2e7ee9 100644 --- a/api/RueI.Parsing.Tags.MeasurementTag.html +++ b/api/RueI.Parsing.Tags.MeasurementTag.html @@ -134,6 +134,7 @@

RotateTag

+
diff --git a/api/RueI.Parsing.TextInfo.html b/api/RueI.Parsing.TextInfo.html index ad892af..0390801 100644 --- a/api/RueI.Parsing.TextInfo.html +++ b/api/RueI.Parsing.TextInfo.html @@ -91,7 +91,7 @@

Table of Contents

Class TextInfo - +

@@ -163,7 +163,8 @@

Remarks

-

This class provides information necessary for individual character sizes, but does not provide the required information to calculate vertical offsets and total line widths. For that, use the derived class ParserContext.

+

This class provides information necessary for individual character sizes, but does not provide the required +information to calculate vertical offsets and total line widths. For that, use the derived class ParserContext.

@@ -175,7 +176,7 @@

Properties

CurrentCSpace - +

Gets or sets the current additional character spacing of the text.

@@ -207,7 +208,7 @@

Property Value

CurrentCase - +

Gets or sets the current case of the parser.

@@ -239,7 +240,7 @@

Property Value

CurrentLineHeight - +

Gets or sets the current line height of the parser.

@@ -271,7 +272,7 @@

Property Value

IsBold - +

Gets or sets a value indicating whether or not the characters are currently bold.

@@ -303,7 +304,7 @@

Property Value

IsMonospace - +

Gets or sets a value indicating whether the characters are currently in monospace.

@@ -335,7 +336,7 @@

Property Value

IsSubscript - +

Gets or sets a value indicating whether or not the parser is in subscript.

@@ -367,7 +368,7 @@

Property Value

IsSuperscript - +

Gets or sets a value indicating whether or not the parser is in superscript.

@@ -399,7 +400,7 @@

Property Value

Monospacing - +

Gets or sets the monospacing of the text.

@@ -423,6 +424,9 @@

Property Value

+

Remarks

+

If IsMonospace is false, this value will be ignored.

+
@@ -431,7 +435,7 @@

Property Value

Scale - +

Gets or sets the scale of the parser.

@@ -463,7 +467,7 @@

Property Value

Size - +

Gets or sets the current character of the parser.

@@ -495,7 +499,7 @@

Property Value

diff --git a/api/RueI.Parsing.html b/api/RueI.Parsing.html index 0d6d18c..b31af98 100644 --- a/api/RueI.Parsing.html +++ b/api/RueI.Parsing.html @@ -96,6 +96,11 @@

Namespace RueI.

Classes

+
+
CharacterLengths
+

Provides a variety of constant values.

+
+
ClosingTag<T>

Defines the base class for all rich text tags.

diff --git a/api/RueI.RueIMain.html b/api/RueI.RueIMain.html index 148bdb4..bcb28cf 100644 --- a/api/RueI.RueIMain.html +++ b/api/RueI.RueIMain.html @@ -150,7 +150,7 @@

Remarks

-

The RueIMain class is responsible for properly initializing all of RueI. It handles

+

The RueIMain class is responsible for properly initializing all of RueI.

diff --git a/api/RueI.Ruetility.html b/api/RueI.Ruetility.html index 755c3c4..08316fe 100644 --- a/api/RueI.Ruetility.html +++ b/api/RueI.Ruetility.html @@ -91,7 +91,7 @@
Table of Contents

Class Ruetility - +

@@ -159,7 +159,7 @@

Methods

FunctionalToScaledPosition(float) - +

Converts a functional position into a scaled position.

@@ -198,7 +198,7 @@

Returns

GetCleanText(string) - +

Cleans a string by wrapping it in noparses, and removes any noparse closer tags existing in it already.

@@ -237,7 +237,7 @@

Returns

ScaledPositionToFunctional(float) - +

Converts a scaled position from 0-1000 into functional pixels (offset from baseline).

@@ -276,7 +276,7 @@

Returns

diff --git a/api/RueI.UnityAlternative.IAsyncOperation.html b/api/RueI.UnityAlternative.IAsyncOperation.html index 606acff..fb2196b 100644 --- a/api/RueI.UnityAlternative.IAsyncOperation.html +++ b/api/RueI.UnityAlternative.IAsyncOperation.html @@ -91,7 +91,7 @@
Table of Contents

Interface UnityAlternative.IAsyncOperation - +

@@ -141,7 +141,7 @@

Properties

IsRunning - +

Gets a value indicating whether or not this operation is currently running.

@@ -177,7 +177,7 @@

Methods

Cancel() - +

Cancels this operation.

@@ -204,7 +204,7 @@

- Edit this page + Edit this page

diff --git a/api/RueI.UnityAlternative.html b/api/RueI.UnityAlternative.html index ed05da1..40e2ce1 100644 --- a/api/RueI.UnityAlternative.html +++ b/api/RueI.UnityAlternative.html @@ -91,7 +91,7 @@
Table of Contents

Class UnityAlternative - +

@@ -177,7 +177,7 @@

Properties

Provider - +

Gets the current UnityAlternative of the application.

@@ -213,7 +213,7 @@

Methods

Log(string) - +

Logs a message to the console.

@@ -242,11 +242,45 @@

Parameters

+ + +

+ LogDebug(string) + +

+ +

Logs a debug message to the console.

+
+
+ +
+
[Conditional("DEBUG")]
+public abstract void LogDebug(string message)
+
+ +

Parameters

+
+
message string
+

The debug message to log.

+
+
+ + + + + + + + + + + +

LogWarn(string) - +

Logs a warning message to the console.

@@ -279,7 +313,7 @@

Parameters

PatchAll(Harmony) - +

Loads all patches.

@@ -312,7 +346,7 @@

Parameters

PerformAsync(TimeSpan, Action) - +

Performs an async operation.

@@ -354,7 +388,7 @@

Returns

diff --git a/api/RueI.UnityProvider.MECAsyncOperation.html b/api/RueI.UnityProvider.MECAsyncOperation.html index 49a9575..d51d16f 100644 --- a/api/RueI.UnityProvider.MECAsyncOperation.html +++ b/api/RueI.UnityProvider.MECAsyncOperation.html @@ -91,7 +91,7 @@
Table of Contents

Class UnityProvider.MECAsyncOperation - +

@@ -173,7 +173,7 @@

Constructors

MECAsyncOperation(TimeSpan, Action) - +

Initializes a new instance of the UnityProvider.MECAsyncOperation class, and then immediately runs.

@@ -213,7 +213,7 @@

Properties

IsRunning - +

Gets a value indicating whether or not this operation is currently running.

@@ -249,7 +249,7 @@

Methods

Cancel() - +

Cancels this operation.

@@ -276,7 +276,7 @@

Dispose() - +

Disposes this MEC operation.

@@ -303,7 +303,7 @@

- Edit this page + Edit this page

diff --git a/api/RueI.UnityProvider.html b/api/RueI.UnityProvider.html index a117d7f..b33eef4 100644 --- a/api/RueI.UnityProvider.html +++ b/api/RueI.UnityProvider.html @@ -91,7 +91,7 @@
Table of Contents

Class UnityProvider - +

@@ -170,7 +170,7 @@

Methods

Log(string) - +

Logs a message to the console.

@@ -199,11 +199,44 @@

Parameters

+ + +

+ LogDebug(string) + +

+ +

Logs a debug message to the console.

+
+
+ +
+
public override void LogDebug(string message)
+
+ +

Parameters

+
+
message string
+

The debug message to log.

+
+
+ + + + + + + + + + + +

LogWarn(string) - +

Logs a warning message to the console.

@@ -236,7 +269,7 @@

Parameters

PatchAll(Harmony) - +

Loads all patches.

@@ -269,7 +302,7 @@

Parameters

PerformAsync(TimeSpan, Action) - +

Performs an async operation.

@@ -311,7 +344,7 @@

Returns

diff --git a/api/RueI.html b/api/RueI.html index d910442..141b90f 100644 --- a/api/RueI.html +++ b/api/RueI.html @@ -96,11 +96,6 @@

Namespace RueI

Classes

-
-
CharacterLengths
-

Provides lengths for characters in hints.

-
-
Constants

Provides a variety of constant values.

diff --git a/api/toc.html b/api/toc.html index 63c2398..26e76f7 100644 --- a/api/toc.html +++ b/api/toc.html @@ -17,9 +17,6 @@ RueI