From fc37acd7a1ccf59754193a36ce87a238685a0bba Mon Sep 17 00:00:00 2001 From: Ruemena Date: Sat, 30 Dec 2023 06:20:14 +0000 Subject: [PATCH] deploy: b836c831a1872a1b286541d90d3fdb9fae97411f --- api/RueI.Constants.html | 30 +++++++++---------- api/RueI.Displays.Display.html | 3 +- api/RueI.Displays.DisplayCore.html | 8 ++--- api/RueI.Displays.ElemCombiner.html | 12 +++++--- api/RueI.Extensions.AutoElement.html | 2 +- ...I.NonUnityProvider.TaskAsyncOperation.html | 14 ++++----- api/RueI.NonUnityProvider.html | 12 ++++---- api/RueI.Parsing.ParserContext.html | 4 +-- ...ueI.Parsing.Tags.RichTextTagAttribute.html | 8 +++-- api/RueI.Patches.HintPatch.html | 10 +++++-- api/RueI.RueIMain.html | 13 ++++---- ...RueI.UnityAlternative.IAsyncOperation.html | 10 +++---- api/RueI.UnityAlternative.html | 18 ++++++----- api/RueI.UnityProvider.MECAsyncOperation.html | 14 ++++----- api/RueI.UnityProvider.html | 12 ++++---- index.json | 18 +++++------ 16 files changed, 103 insertions(+), 85 deletions(-) diff --git a/api/RueI.Constants.html b/api/RueI.Constants.html index a79e58c..537ba10 100644 --- a/api/RueI.Constants.html +++ b/api/RueI.Constants.html @@ -91,7 +91,7 @@
Table of Contents

Class Constants - +

@@ -161,7 +161,7 @@

Fields

BOLDINCREASE - +

Gets the pixel increase for bold characters.

@@ -192,7 +192,7 @@

Field Value

CAPSTOSMALLCAPS - +

Gets the multiplier used to convert the size of a capital character to a smallcaps character.

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

Field Value

DEFAULTHEIGHT - +

Gets the default height if a line-height is not provided.

@@ -257,7 +257,7 @@

Remarks

DEFAULTSIZE - +

Gets the default size (in pixels) if a size is not provided.

@@ -291,7 +291,7 @@

Remarks

DISPLAYAREAWIDTH - +

Gets the width of the display area (in pixels).

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

Field Value

EMSTOPIXELS - +

Gets how many pixels are in an em.

@@ -353,7 +353,7 @@

Field Value

HintRateLimit - +

Gets the ratelimit used for displaying hints.

@@ -384,7 +384,7 @@

Field Value

MAXTAGNAMESIZE - +

Gets the maximum name size allowed for a tag.

@@ -415,7 +415,7 @@

Field Value

MEASUREMENTVALUELIMIT - +

Gets the limit on measurement values.

@@ -446,7 +446,7 @@

Field Value

ZeroWidthSpace - +

Gets the zero width space.

@@ -482,7 +482,7 @@

Properties

Alignments - +

Gets a ReadOnlyCollection<T> of valid alignments for AlignTag.

@@ -514,7 +514,7 @@

Property Value

Colors - +

Gets a list of allowed colors for ColorTag.

@@ -546,7 +546,7 @@

Property Value

ValidColorSizes - +

Gets a list of allowed sizes of color param tags, ignoring the hashtag.

@@ -578,7 +578,7 @@

Property Value

- Edit this page + Edit this page
diff --git a/api/RueI.Displays.Display.html b/api/RueI.Displays.Display.html index c29e562..b1de132 100644 --- a/api/RueI.Displays.Display.html +++ b/api/RueI.Displays.Display.html @@ -181,9 +181,8 @@

Examples

This example demonstrates creating and using a Display.

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
diff --git a/api/RueI.Displays.DisplayCore.html b/api/RueI.Displays.DisplayCore.html index d62d1ab..43718b5 100644 --- a/api/RueI.Displays.DisplayCore.html +++ b/api/RueI.Displays.DisplayCore.html @@ -248,7 +248,7 @@

Methods

AddAsReference<T>(IElemReference<T>, T) - +

Adds an Element as an IElemReference<T>.

@@ -332,7 +332,7 @@

Rem

GetElementOrNew<T>(IElemReference<T>, Func<T>) - +

Gets an Element as T, or creates it.

@@ -380,7 +380,7 @@

Type Parameters

GetElement<T>(IElemReference<T>) - +

Gets an Element as T if the IElemReference<T> exists within this DisplayCore's element references.

@@ -464,7 +464,7 @@

Type Parameters

RemoveReference<T>(IElemReference<T>) - +

Removes a IElemReference<T> from this DisplayCore.

diff --git a/api/RueI.Displays.ElemCombiner.html b/api/RueI.Displays.ElemCombiner.html index 29817e4..119b379 100644 --- a/api/RueI.Displays.ElemCombiner.html +++ b/api/RueI.Displays.ElemCombiner.html @@ -91,7 +91,7 @@
Table of Contents

Class ElemCombiner - +

@@ -149,6 +149,10 @@

Remarks

+

The ElemCombiner is a helper class that combines all of the Elements for a DisplayCore into a single string, +to be displayed as a hint.

+

Methods @@ -159,7 +163,7 @@

Methods

CalculateOffset(float, float, float) - +

Calculates the offset for two hints.

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

Returns

Combine(IEnumerable<Element>) - +

Combines multiple Elements into a string.

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

Returns

- Edit this page + Edit this page
diff --git a/api/RueI.Extensions.AutoElement.html b/api/RueI.Extensions.AutoElement.html index 1805ef3..df8b591 100644 --- a/api/RueI.Extensions.AutoElement.html +++ b/api/RueI.Extensions.AutoElement.html @@ -358,7 +358,7 @@

Parameters

RemoveFrom(DisplayCore) - +

Removes this AutoElement from a DisplayCore.

diff --git a/api/RueI.NonUnityProvider.TaskAsyncOperation.html b/api/RueI.NonUnityProvider.TaskAsyncOperation.html index ce53e6e..4211141 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,10 +213,10 @@

Properties

IsRunning - +

-

Gets a value indicating whether or not this operation is handling.

+

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 b58c38f..3e00553 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.

@@ -203,7 +203,7 @@

Parameters

LogWarn(string) - +

Logs a warning message to the console.

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

Parameters

PatchAll(Harmony) - +

Loads all patches.

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

Parameters

PerformAsync(TimeSpan, Action) - +

Performs an async operation.

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

Returns

- Edit this page + Edit this page
diff --git a/api/RueI.Parsing.ParserContext.html b/api/RueI.Parsing.ParserContext.html index 903fa9c..88b12c6 100644 --- a/api/RueI.Parsing.ParserContext.html +++ b/api/RueI.Parsing.ParserContext.html @@ -859,7 +859,7 @@

Type Parameters

ApplyClosingTags() - +

Applies the endingTags and closing SizeTags tags to this ParserContext.

@@ -886,7 +886,7 @@

Dispose() - +

Disposes this ParserContext, returning the string builder to the pool.

diff --git a/api/RueI.Parsing.Tags.RichTextTagAttribute.html b/api/RueI.Parsing.Tags.RichTextTagAttribute.html index d378905..a72757b 100644 --- a/api/RueI.Parsing.Tags.RichTextTagAttribute.html +++ b/api/RueI.Parsing.Tags.RichTextTagAttribute.html @@ -91,7 +91,7 @@
Table of Contents

Class RichTextTagAttribute - +

@@ -269,13 +269,17 @@

Remarks

+

You can apply this Attribute to classes that inherit from RichTextTag to define a custom RichTextTag easily. +This attribute is used exclusive by the AddFromAssembly(Assembly) method.

+
- Edit this page + Edit this page
diff --git a/api/RueI.Patches.HintPatch.html b/api/RueI.Patches.HintPatch.html index 55b7d4b..c28dec1 100644 --- a/api/RueI.Patches.HintPatch.html +++ b/api/RueI.Patches.HintPatch.html @@ -91,7 +91,7 @@
Table of Contents

Class HintPatch - +

@@ -150,6 +150,10 @@

Remarks

+

RueI patches the HintDisplay.Show method so that it can get an accurate state of the player's hint display at any given time. +When a hint outside of RueI is shown, it schedules an update that occurs after 3 seconds.

+

Methods @@ -160,7 +164,7 @@

Methods

Transpiler(IEnumerable<CodeInstruction>, ILGenerator) - +

Patches HintDisplay.Show to detect when hints are shown.

@@ -203,7 +207,7 @@

Returns

- Edit this page + Edit this page
diff --git a/api/RueI.RueIMain.html b/api/RueI.RueIMain.html index c8c12bd..148bdb4 100644 --- a/api/RueI.RueIMain.html +++ b/api/RueI.RueIMain.html @@ -91,7 +91,7 @@
Table of Contents

Class RueIMain - +

@@ -149,6 +149,9 @@

+

Remarks

+

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

+

Fields @@ -158,7 +161,7 @@

Fields

HARMONYID - +

Gets the HarmonyLib.Harmony id for RueI.

@@ -189,7 +192,7 @@

Field Value

Version - +

Gets the current version of RueI.

@@ -225,7 +228,7 @@

Methods

EnsureInit() - +

Ensures that RueI is properly initialized.

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

- Edit this page + Edit this page
diff --git a/api/RueI.UnityAlternative.IAsyncOperation.html b/api/RueI.UnityAlternative.IAsyncOperation.html index a2248e7..606acff 100644 --- a/api/RueI.UnityAlternative.IAsyncOperation.html +++ b/api/RueI.UnityAlternative.IAsyncOperation.html @@ -91,7 +91,7 @@

Table of Contents

Interface UnityAlternative.IAsyncOperation - +

@@ -141,10 +141,10 @@

Properties

IsRunning - +

-

Gets a value indicating whether or not this operation is handling.

+

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 6e8011b..ed05da1 100644 --- a/api/RueI.UnityAlternative.html +++ b/api/RueI.UnityAlternative.html @@ -91,7 +91,7 @@
Table of Contents

Class UnityAlternative - +

@@ -163,6 +163,10 @@

Remarks

+

The UnityAlternative class is primarily intended for internal use within RueI. This enables certain features +to work even outside of SCP:SL and Unity, which is utilized primarily for unit-testing.

+

Properties @@ -173,7 +177,7 @@

Properties

Provider - +

Gets the current UnityAlternative of the application.

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

Methods

Log(string) - +

Logs a message to the console.

@@ -242,7 +246,7 @@

Parameters

LogWarn(string) - +

Logs a warning message to the console.

@@ -275,7 +279,7 @@

Parameters

PatchAll(Harmony) - +

Loads all patches.

@@ -308,7 +312,7 @@

Parameters

PerformAsync(TimeSpan, Action) - +

Performs an async operation.

@@ -350,7 +354,7 @@

Returns

- Edit this page + Edit this page
diff --git a/api/RueI.UnityProvider.MECAsyncOperation.html b/api/RueI.UnityProvider.MECAsyncOperation.html index 7a260a1..49a9575 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,10 +213,10 @@

Properties

IsRunning - +

-

Gets a value indicating whether or not this operation is handling.

+

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 d767164..a117d7f 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.

@@ -203,7 +203,7 @@

Parameters

LogWarn(string) - +

Logs a warning message to the console.

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

Parameters

PatchAll(Harmony) - +

Loads all patches.

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

Parameters

PerformAsync(TimeSpan, Action) - +

Performs an async operation.

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

Returns

- Edit this page + Edit this page
diff --git a/index.json b/index.json index f725be8..b518a6c 100644 --- a/index.json +++ b/index.json @@ -17,7 +17,7 @@ "api/RueI.Displays.Display.html": { "href": "api/RueI.Displays.Display.html", "title": "Class Display | RueI", - "keywords": "Class Display Namespace RueI.Displays Assembly RueI.dll Represents a basic display attached to a DisplayCore. public class Display : DisplayBase, IElementContainer Inheritance object DisplayBase Display Implements IElementContainer Inherited Members DisplayBase.IsActive DisplayBase.ReferenceHub DisplayBase.Coordinator DisplayBase.Update() DisplayBase.Delete() 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) Examples This example demonstrates creating and using a Display. Display display = new(referenceHub); // Create a new display from a ReferenceHub 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 Constructors Display(ReferenceHub) Initializes a new instance of the Display class. public Display(ReferenceHub hub) Parameters hub ReferenceHub The ReferenceHub to assign the display to. Display(DisplayCore) Initializes a new instance of the Display class. public Display(DisplayCore coordinator) Parameters coordinator DisplayCore The DisplayCore to assign the display to. Properties Elements Gets the elements of this display. public List Elements { get; } Property Value List Methods GetAllElements() Gets all of the elements of this display. public override IEnumerable GetAllElements() Returns IEnumerable The IEnumerator of elements." + "keywords": "Class Display Namespace RueI.Displays Assembly RueI.dll Represents a basic display attached to a DisplayCore. public class Display : DisplayBase, IElementContainer Inheritance object DisplayBase Display Implements IElementContainer Inherited Members DisplayBase.IsActive DisplayBase.ReferenceHub DisplayBase.Coordinator DisplayBase.Update() DisplayBase.Delete() 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) Examples This example demonstrates creating and using a Display. Display display = new(referenceHub); // Create a new display from a ReferenceHub SetElement helloElem = new(300, zIndex: 10, \"hello\").AddTo(display); SetElement worldElem = new(250, zIndex: 10, \"world\").AddTo(display); display.Update(); // Update the display Constructors Display(ReferenceHub) Initializes a new instance of the Display class. public Display(ReferenceHub hub) Parameters hub ReferenceHub The ReferenceHub to assign the display to. Display(DisplayCore) Initializes a new instance of the Display class. public Display(DisplayCore coordinator) Parameters coordinator DisplayCore The DisplayCore to assign the display to. Properties Elements Gets the elements of this display. public List Elements { get; } Property Value List Methods GetAllElements() Gets all of the elements of this display. public override IEnumerable GetAllElements() Returns IEnumerable The IEnumerator of elements." }, "api/RueI.Displays.DisplayBase.html": { "href": "api/RueI.Displays.DisplayBase.html", @@ -32,7 +32,7 @@ "api/RueI.Displays.ElemCombiner.html": { "href": "api/RueI.Displays.ElemCombiner.html", "title": "Class ElemCombiner | RueI", - "keywords": "Class ElemCombiner Namespace RueI.Displays Assembly RueI.dll Provides a means of combining Elements. public static class ElemCombiner Inheritance object ElemCombiner Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Methods CalculateOffset(float, float, float) Calculates the offset for two hints. public static float CalculateOffset(float hintOnePos, float hintOneTotalLines, float hintTwoPos) Parameters hintOnePos float The first hint's vertical position. hintOneTotalLines float The first hint's total line-height, excluding the vertical position. hintTwoPos float The second hint's vertical position. Returns float A float indicating the new offset. Combine(IEnumerable) Combines multiple Elements into a string. public static string Combine(IEnumerable enumElems) Parameters enumElems IEnumerable The IEnumerable of Elements to combine. Returns string A string with all of the combined Elements." + "keywords": "Class ElemCombiner Namespace RueI.Displays Assembly RueI.dll Provides a means of combining Elements. public static class ElemCombiner Inheritance object ElemCombiner Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Remarks The ElemCombiner is a helper class that combines all of the Elements for a DisplayCore into a single string, to be displayed as a hint. Methods CalculateOffset(float, float, float) Calculates the offset for two hints. public static float CalculateOffset(float hintOnePos, float hintOneTotalLines, float hintTwoPos) Parameters hintOnePos float The first hint's vertical position. hintOneTotalLines float The first hint's total line-height, excluding the vertical position. hintTwoPos float The second hint's vertical position. Returns float A float indicating the new offset. Combine(IEnumerable) Combines multiple Elements into a string. public static string Combine(IEnumerable enumElems) Parameters enumElems IEnumerable The IEnumerable of Elements to combine. Returns string A string with all of the combined Elements." }, "api/RueI.Displays.IElemReference-1.html": { "href": "api/RueI.Displays.IElemReference-1.html", @@ -247,7 +247,7 @@ "api/RueI.NonUnityProvider.TaskAsyncOperation.html": { "href": "api/RueI.NonUnityProvider.TaskAsyncOperation.html", "title": "Class NonUnityProvider.TaskAsyncOperation | RueI", - "keywords": "Class NonUnityProvider.TaskAsyncOperation Namespace RueI Assembly RueI.dll Represents an async operation using a Task. public class NonUnityProvider.TaskAsyncOperation : UnityAlternative.IAsyncOperation, IDisposable Inheritance object NonUnityProvider.TaskAsyncOperation Implements UnityAlternative.IAsyncOperation IDisposable 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) Constructors TaskAsyncOperation(TimeSpan, Action) Initializes a new instance of the NonUnityProvider.TaskAsyncOperation class, and then immediately runs. public TaskAsyncOperation(TimeSpan span, Action action) Parameters span TimeSpan How long until the action should be ran. action Action The action to run when finished. Properties IsRunning Gets a value indicating whether or not this operation is handling. public bool IsRunning { get; } Property Value bool Methods Cancel() Cancels this operation. public void Cancel() Dispose() Disposes this async operation. public void Dispose()" + "keywords": "Class NonUnityProvider.TaskAsyncOperation Namespace RueI Assembly RueI.dll Represents an async operation using a Task. public class NonUnityProvider.TaskAsyncOperation : UnityAlternative.IAsyncOperation, IDisposable Inheritance object NonUnityProvider.TaskAsyncOperation Implements UnityAlternative.IAsyncOperation IDisposable 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) Constructors TaskAsyncOperation(TimeSpan, Action) Initializes a new instance of the NonUnityProvider.TaskAsyncOperation class, and then immediately runs. public TaskAsyncOperation(TimeSpan span, Action action) Parameters span TimeSpan How long until the action should be ran. action Action The action to run when finished. Properties IsRunning Gets a value indicating whether or not this operation is currently running. public bool IsRunning { get; } Property Value bool Methods Cancel() Cancels this operation. public void Cancel() Dispose() Disposes this async operation. public void Dispose()" }, "api/RueI.NonUnityProvider.html": { "href": "api/RueI.NonUnityProvider.html", @@ -602,7 +602,7 @@ "api/RueI.Parsing.Tags.RichTextTagAttribute.html": { "href": "api/RueI.Parsing.Tags.RichTextTagAttribute.html", "title": "Class RichTextTagAttribute | RueI", - "keywords": "Class RichTextTagAttribute Namespace RueI.Parsing.Tags Assembly RueI.dll Defines a RichTextTag for RueI. [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)] public class RichTextTagAttribute : Attribute, _Attribute Inheritance object Attribute RichTextTagAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.Equals(object) Attribute.GetHashCode() Attribute.Match(object) Attribute.IsDefaultAttribute() Attribute.TypeId object.ToString() object.Equals(object, object) object.ReferenceEquals(object, object) object.GetType() object.MemberwiseClone() Extension Methods UniversalExtensions.AddTo(T, ICollection)" + "keywords": "Class RichTextTagAttribute Namespace RueI.Parsing.Tags Assembly RueI.dll Defines a RichTextTag for RueI. [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)] public class RichTextTagAttribute : Attribute, _Attribute Inheritance object Attribute RichTextTagAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.Equals(object) Attribute.GetHashCode() Attribute.Match(object) Attribute.IsDefaultAttribute() Attribute.TypeId object.ToString() object.Equals(object, object) object.ReferenceEquals(object, object) object.GetType() object.MemberwiseClone() Extension Methods UniversalExtensions.AddTo(T, ICollection) Remarks You can apply this Attribute to classes that inherit from RichTextTag to define a custom RichTextTag easily. This attribute is used exclusive by the AddFromAssembly(Assembly) method." }, "api/RueI.Parsing.Tags.SharedTag-1.html": { "href": "api/RueI.Parsing.Tags.SharedTag-1.html", @@ -632,7 +632,7 @@ "api/RueI.Patches.HintPatch.html": { "href": "api/RueI.Patches.HintPatch.html", "title": "Class HintPatch | RueI", - "keywords": "Class HintPatch Namespace RueI.Patches Assembly RueI.dll Patches HintDisplay.Show to detect when hints are shown. [HarmonyPatch(typeof(HintDisplay), \"Show\")] public static class HintPatch Inheritance object HintPatch Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Methods Transpiler(IEnumerable, ILGenerator) Patches HintDisplay.Show to detect when hints are shown. [HarmonyTranspiler] public static IEnumerable Transpiler(IEnumerable instructions, ILGenerator generator) Parameters instructions IEnumerable The original instructions. generator ILGenerator An ILGenerator to use. Returns IEnumerable The new instructions." + "keywords": "Class HintPatch Namespace RueI.Patches Assembly RueI.dll Patches HintDisplay.Show to detect when hints are shown. [HarmonyPatch(typeof(HintDisplay), \"Show\")] public static class HintPatch Inheritance object HintPatch Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Remarks RueI patches the HintDisplay.Show method so that it can get an accurate state of the player's hint display at any given time. When a hint outside of RueI is shown, it schedules an update that occurs after 3 seconds. Methods Transpiler(IEnumerable, ILGenerator) Patches HintDisplay.Show to detect when hints are shown. [HarmonyTranspiler] public static IEnumerable Transpiler(IEnumerable instructions, ILGenerator generator) Parameters instructions IEnumerable The original instructions. generator ILGenerator An ILGenerator to use. Returns IEnumerable The new instructions." }, "api/RueI.Patches.PatchHelper.html": { "href": "api/RueI.Patches.PatchHelper.html", @@ -647,7 +647,7 @@ "api/RueI.RueIMain.html": { "href": "api/RueI.RueIMain.html", "title": "Class RueIMain | RueI", - "keywords": "Class RueIMain Namespace RueI Assembly RueI.dll Represents the main class for RueI. public static class RueIMain Inheritance object RueIMain Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Fields HARMONYID Gets the HarmonyLib.Harmony id for RueI. public const string HARMONYID = \"RueI_Hint_Dependency\" Field Value string Version Gets the current version of RueI. public static readonly Version Version Field Value Version Methods EnsureInit() Ensures that RueI is properly initialized. public static void EnsureInit()" + "keywords": "Class RueIMain Namespace RueI Assembly RueI.dll Represents the main class for RueI. public static class RueIMain Inheritance object RueIMain Inherited Members object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() Remarks The RueIMain class is responsible for properly initializing all of RueI. It handles Fields HARMONYID Gets the HarmonyLib.Harmony id for RueI. public const string HARMONYID = \"RueI_Hint_Dependency\" Field Value string Version Gets the current version of RueI. public static readonly Version Version Field Value Version Methods EnsureInit() Ensures that RueI is properly initialized. public static void EnsureInit()" }, "api/RueI.Ruetility.html": { "href": "api/RueI.Ruetility.html", @@ -657,17 +657,17 @@ "api/RueI.UnityAlternative.IAsyncOperation.html": { "href": "api/RueI.UnityAlternative.IAsyncOperation.html", "title": "Interface UnityAlternative.IAsyncOperation | RueI", - "keywords": "Interface UnityAlternative.IAsyncOperation Namespace RueI Assembly RueI.dll Represents a generalized handler for an async operation. public interface UnityAlternative.IAsyncOperation : IDisposable Inherited Members IDisposable.Dispose() Extension Methods UniversalExtensions.AddTo(T, ICollection) Properties IsRunning Gets a value indicating whether or not this operation is handling. bool IsRunning { get; } Property Value bool Methods Cancel() Cancels this operation. void Cancel()" + "keywords": "Interface UnityAlternative.IAsyncOperation Namespace RueI Assembly RueI.dll Represents a generalized handler for an async operation. public interface UnityAlternative.IAsyncOperation : IDisposable Inherited Members IDisposable.Dispose() Extension Methods UniversalExtensions.AddTo(T, ICollection) Properties IsRunning Gets a value indicating whether or not this operation is currently running. bool IsRunning { get; } Property Value bool Methods Cancel() Cancels this operation. void Cancel()" }, "api/RueI.UnityAlternative.html": { "href": "api/RueI.UnityAlternative.html", "title": "Class UnityAlternative | RueI", - "keywords": "Class UnityAlternative Namespace RueI Assembly RueI.dll Defines the base class for a provider of methods that may or may not use Unity. public abstract class UnityAlternative Inheritance object UnityAlternative Derived NonUnityProvider UnityProvider 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 Provider Gets the current UnityAlternative of the application. public static UnityAlternative Provider { get; } Property Value UnityAlternative Methods Log(string) Logs a message to the console. public abstract void Log(string message) Parameters message string The message to log. LogWarn(string) Logs a warning message to the console. public abstract void LogWarn(string message) Parameters message string The warn message to log. PatchAll(Harmony) Loads all patches. public abstract void PatchAll(Harmony harmony) Parameters harmony Harmony The HarmonyLib.Harmony instance to use. PerformAsync(TimeSpan, Action) Performs an async operation. public abstract UnityAlternative.IAsyncOperation PerformAsync(TimeSpan span, Action action) Parameters span TimeSpan How long until the action should be ran. action Action The action to run when finished. Returns UnityAlternative.IAsyncOperation A UnityAlternative.IAsyncOperation to use." + "keywords": "Class UnityAlternative Namespace RueI Assembly RueI.dll Defines the base class for a provider of methods that may or may not use Unity. public abstract class UnityAlternative Inheritance object UnityAlternative Derived NonUnityProvider UnityProvider 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 UnityAlternative class is primarily intended for internal use within RueI. This enables certain features to work even outside of SCP:SL and Unity, which is utilized primarily for unit-testing. Properties Provider Gets the current UnityAlternative of the application. public static UnityAlternative Provider { get; } Property Value UnityAlternative Methods Log(string) Logs a message to the console. public abstract void Log(string message) Parameters message string The message to log. LogWarn(string) Logs a warning message to the console. public abstract void LogWarn(string message) Parameters message string The warn message to log. PatchAll(Harmony) Loads all patches. public abstract void PatchAll(Harmony harmony) Parameters harmony Harmony The HarmonyLib.Harmony instance to use. PerformAsync(TimeSpan, Action) Performs an async operation. public abstract UnityAlternative.IAsyncOperation PerformAsync(TimeSpan span, Action action) Parameters span TimeSpan How long until the action should be ran. action Action The action to run when finished. Returns UnityAlternative.IAsyncOperation A UnityAlternative.IAsyncOperation to use." }, "api/RueI.UnityProvider.MECAsyncOperation.html": { "href": "api/RueI.UnityProvider.MECAsyncOperation.html", "title": "Class UnityProvider.MECAsyncOperation | RueI", - "keywords": "Class UnityProvider.MECAsyncOperation Namespace RueI Assembly RueI.dll Represents an async operation using a Task. public class UnityProvider.MECAsyncOperation : UnityAlternative.IAsyncOperation, IDisposable Inheritance object UnityProvider.MECAsyncOperation Implements UnityAlternative.IAsyncOperation IDisposable 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) Constructors MECAsyncOperation(TimeSpan, Action) Initializes a new instance of the UnityProvider.MECAsyncOperation class, and then immediately runs. public MECAsyncOperation(TimeSpan span, Action action) Parameters span TimeSpan How long until the action should be ran. action Action The action to run when finished. Properties IsRunning Gets a value indicating whether or not this operation is handling. public bool IsRunning { get; } Property Value bool Methods Cancel() Cancels this operation. public void Cancel() Dispose() Disposes this MEC operation. public void Dispose()" + "keywords": "Class UnityProvider.MECAsyncOperation Namespace RueI Assembly RueI.dll Represents an async operation using a Task. public class UnityProvider.MECAsyncOperation : UnityAlternative.IAsyncOperation, IDisposable Inheritance object UnityProvider.MECAsyncOperation Implements UnityAlternative.IAsyncOperation IDisposable 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) Constructors MECAsyncOperation(TimeSpan, Action) Initializes a new instance of the UnityProvider.MECAsyncOperation class, and then immediately runs. public MECAsyncOperation(TimeSpan span, Action action) Parameters span TimeSpan How long until the action should be ran. action Action The action to run when finished. Properties IsRunning Gets a value indicating whether or not this operation is currently running. public bool IsRunning { get; } Property Value bool Methods Cancel() Cancels this operation. public void Cancel() Dispose() Disposes this MEC operation. public void Dispose()" }, "api/RueI.UnityProvider.html": { "href": "api/RueI.UnityProvider.html",