diff --git a/branch/4.0.0-beta/api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html b/branch/4.0.0-beta/api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html index 8caa4ec3..5e9fa04c 100644 --- a/branch/4.0.0-beta/api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html +++ b/branch/4.0.0-beta/api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html @@ -389,7 +389,7 @@ public class MarkdownView : MonoBehaviour Improve this Doc - View Source + View Source

MarkdownView()

@@ -407,7 +407,7 @@ public class MarkdownView : MonoBehaviour Improve this Doc - View Source + View Source

HasEmbeddedImage

This function will be called whenever attempting to resolve an image URI, to ensure that the image exists in the embedded assembly.

@@ -440,7 +440,7 @@ public class MarkdownView : MonoBehaviour Improve this Doc - View Source + View Source

Markdown

@@ -475,7 +475,7 @@ public class MarkdownView : MonoBehaviour Improve this Doc - View Source + View Source

rectTransform

@@ -535,7 +535,7 @@ public class MarkdownView : MonoBehaviour Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Config.NameAttribute.html b/branch/4.0.0-beta/api/IPA.Config.Config.NameAttribute.html index 3fe40e86..a71f8f5e 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Config.NameAttribute.html +++ b/branch/4.0.0-beta/api/IPA.Config.Config.NameAttribute.html @@ -252,7 +252,7 @@ public sealed class NameAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    NameAttribute(String)

    @@ -288,7 +288,7 @@ public sealed class NameAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    Name

    @@ -346,7 +346,7 @@ public sealed class NameAttribute : Attribute, _Attribute Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Config.PreferAttribute.html b/branch/4.0.0-beta/api/IPA.Config.Config.PreferAttribute.html index d27517f4..afa4ecdd 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Config.PreferAttribute.html +++ b/branch/4.0.0-beta/api/IPA.Config.Config.PreferAttribute.html @@ -253,7 +253,7 @@ public sealed class PreferAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    PreferAttribute(String[])

    @@ -289,7 +289,7 @@ public sealed class PreferAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    PreferenceOrder

    @@ -347,7 +347,7 @@ public sealed class PreferAttribute : Attribute, _Attribute Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Config.html b/branch/4.0.0-beta/api/IPA.Config.Config.html index b6a5ac63..76266c55 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Config.html +++ b/branch/4.0.0-beta/api/IPA.Config.Config.html @@ -130,7 +130,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    Name

    @@ -161,7 +161,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    Provider

    @@ -194,7 +194,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    GetConfigFor(String, String[])

    @@ -250,7 +250,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    LoadAsync()

    @@ -281,7 +281,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    LoadSync()

    @@ -297,7 +297,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    Register(Type)

    @@ -331,7 +331,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    Register<T>()

    @@ -364,7 +364,7 @@ disk representation.

    Improve this Doc - View Source + View Source

    SetStore(IConfigStore)

    @@ -439,7 +439,7 @@ disk representation.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.ConfigProvider.html b/branch/4.0.0-beta/api/IPA.Config.ConfigProvider.html index bb854c23..54d47787 100644 --- a/branch/4.0.0-beta/api/IPA.Config.ConfigProvider.html +++ b/branch/4.0.0-beta/api/IPA.Config.ConfigProvider.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    Load()

    @@ -162,7 +162,7 @@ and returns it.

    Improve this Doc - View Source + View Source

    Store(Value)

    @@ -218,7 +218,7 @@ and returns it.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.Boolean.html b/branch/4.0.0-beta/api/IPA.Config.Data.Boolean.html index e10112d2..f7c177b8 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Data.Boolean.html +++ b/branch/4.0.0-beta/api/IPA.Config.Data.Boolean.html @@ -169,7 +169,7 @@ Improve this Doc - View Source + View Source

    Value

    @@ -202,7 +202,7 @@ Improve this Doc - View Source + View Source

    ToString()

    @@ -258,7 +258,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.FloatingPoint.html b/branch/4.0.0-beta/api/IPA.Config.Data.FloatingPoint.html index a972ab89..70d67adf 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Data.FloatingPoint.html +++ b/branch/4.0.0-beta/api/IPA.Config.Data.FloatingPoint.html @@ -170,7 +170,7 @@ Improve this Doc - View Source + View Source

    Value

    @@ -203,7 +203,7 @@ Improve this Doc - View Source + View Source

    AsInteger()

    @@ -235,7 +235,7 @@ Improve this Doc - View Source + View Source

    ToString()

    @@ -291,7 +291,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.Integer.html b/branch/4.0.0-beta/api/IPA.Config.Data.Integer.html index 65dbdd37..53f767ff 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Data.Integer.html +++ b/branch/4.0.0-beta/api/IPA.Config.Data.Integer.html @@ -170,7 +170,7 @@ worth of data.

    Improve this Doc - View Source + View Source

    Value

    @@ -203,7 +203,7 @@ worth of data.

    Improve this Doc - View Source + View Source

    AsFloat()

    @@ -235,7 +235,7 @@ worth of data.

    Improve this Doc - View Source + View Source

    ToString()

    @@ -291,7 +291,7 @@ worth of data.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.List.html b/branch/4.0.0-beta/api/IPA.Config.Data.List.html index 8df2a51e..c2fe1018 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Data.List.html +++ b/branch/4.0.0-beta/api/IPA.Config.Data.List.html @@ -177,7 +177,7 @@ Use Improve this Doc - View Source + View Source

    Count

    @@ -212,7 +212,7 @@ Use Improve this Doc - View Source + View Source

    Item[Int32]

    @@ -268,7 +268,7 @@ Use Improve this Doc - View Source + View Source

    Add(Value)

    @@ -306,7 +306,7 @@ Use Improve this Doc - View Source + View Source

    AddRange(IEnumerable<Value>)

    @@ -340,7 +340,7 @@ Use Improve this Doc - View Source + View Source

    Clear()

    @@ -360,7 +360,7 @@ Use Improve this Doc - View Source + View Source

    Contains(Value)

    @@ -413,7 +413,7 @@ Use Improve this Doc - View Source + View Source

    CopyTo(Value[], Int32)

    @@ -457,7 +457,7 @@ Use Improve this Doc - View Source + View Source

    GetEnumerator()

    @@ -493,7 +493,7 @@ Use Improve this Doc - View Source + View Source

    IndexOf(Value)

    @@ -547,7 +547,7 @@ Use Improve this Doc - View Source + View Source

    Insert(Int32, Value)

    @@ -591,7 +591,7 @@ Use Improve this Doc - View Source + View Source

    Remove(Value)

    @@ -645,7 +645,7 @@ Use Improve this Doc - View Source + View Source

    RemoveAt(Int32)

    @@ -683,7 +683,7 @@ Use Improve this Doc - View Source + View Source

    ToString()

    @@ -719,7 +719,7 @@ Use Improve this Doc - View Source + View Source

    ICollection<Value>.IsReadOnly

    @@ -749,7 +749,7 @@ Use Improve this Doc - View Source + View Source

    IEnumerable.GetEnumerator()

    @@ -826,7 +826,7 @@ Use Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.Map.html b/branch/4.0.0-beta/api/IPA.Config.Data.Map.html index 5636b546..b914562b 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Data.Map.html +++ b/branch/4.0.0-beta/api/IPA.Config.Data.Map.html @@ -177,7 +177,7 @@ Use Improve this Doc - View Source + View Source

    Count

    @@ -212,7 +212,7 @@ Use Improve this Doc - View Source + View Source

    Item[String]

    @@ -266,7 +266,7 @@ Use Improve this Doc - View Source + View Source

    Keys

    @@ -301,7 +301,7 @@ Use Improve this Doc - View Source + View Source

    Values

    @@ -342,7 +342,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    Add(String, Value)

    @@ -386,7 +386,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    Clear()

    @@ -406,7 +406,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    ContainsKey(String)

    @@ -459,7 +459,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    GetEnumerator()

    @@ -495,7 +495,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    Remove(String)

    @@ -549,7 +549,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    ToString()

    @@ -583,7 +583,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    TryGetValue(String, out Value)

    @@ -645,7 +645,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    ICollection<KeyValuePair<String, Value>>.Add(KeyValuePair<String, Value>)

    @@ -677,7 +677,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    ICollection<KeyValuePair<String, Value>>.Contains(KeyValuePair<String, Value>)

    @@ -724,7 +724,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    ICollection<KeyValuePair<String, Value>>.CopyTo(KeyValuePair<String, Value>[], Int32)

    @@ -761,7 +761,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    ICollection<KeyValuePair<String, Value>>.IsReadOnly

    @@ -791,7 +791,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    ICollection<KeyValuePair<String, Value>>.Remove(KeyValuePair<String, Value>)

    @@ -838,7 +838,7 @@ guarantee that order is maintained.

    Improve this Doc - View Source + View Source

    IEnumerable.GetEnumerator()

    @@ -912,7 +912,7 @@ guarantee that order is maintained.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.Text.html b/branch/4.0.0-beta/api/IPA.Config.Data.Text.html index fbbad0e2..27f25292 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Data.Text.html +++ b/branch/4.0.0-beta/api/IPA.Config.Data.Text.html @@ -170,7 +170,7 @@ String is so that it doesn't conflict with Improve this Doc - View Source + View Source

    Value

    @@ -203,7 +203,7 @@ String is so that it doesn't conflict with Improve this Doc - View Source + View Source

    ToString()

    @@ -259,7 +259,7 @@ String is so that it doesn't conflict with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.Value.html b/branch/4.0.0-beta/api/IPA.Config.Data.Value.html index 825820bc..e0d3eb47 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Data.Value.html +++ b/branch/4.0.0-beta/api/IPA.Config.Data.Value.html @@ -135,7 +135,7 @@ Also contains factory functions for all derived types.

    Improve this Doc - View Source + View Source

    Bool(Boolean)

    @@ -189,7 +189,7 @@ Also contains factory functions for all derived types.

    Improve this Doc - View Source + View Source

    Float(Decimal)

    @@ -243,7 +243,7 @@ Also contains factory functions for all derived types.

    Improve this Doc - View Source + View Source

    From(Boolean)

    @@ -297,7 +297,7 @@ Also contains factory functions for all derived types.

    Improve this Doc - View Source + View Source

    From(IDictionary<String, Value>)

    @@ -353,7 +353,7 @@ of St Improve this Doc - View Source + View Source

    From(IEnumerable<Value>)

    @@ -408,7 +408,7 @@ of Value.

    Improve this Doc - View Source + View Source

    From(IEnumerable<KeyValuePair<String, Value>>)

    @@ -464,7 +464,7 @@ of Improve this Doc - View Source + View Source

    From(Decimal)

    @@ -518,7 +518,7 @@ of Improve this Doc - View Source + View Source

    From(Int64)

    @@ -572,7 +572,7 @@ of Improve this Doc - View Source + View Source

    From(String)

    @@ -626,7 +626,7 @@ of Improve this Doc - View Source + View Source

    Integer(Int64)

    @@ -680,7 +680,7 @@ of Improve this Doc - View Source + View Source

    List()

    @@ -716,7 +716,7 @@ of Improve this Doc - View Source + View Source

    Map()

    @@ -753,7 +753,7 @@ of Improve this Doc - View Source + View Source

    Null()

    @@ -784,7 +784,7 @@ of Improve this Doc - View Source + View Source

    Text(String)

    @@ -838,7 +838,7 @@ of Improve this Doc - View Source + View Source

    ToString()

    @@ -894,7 +894,7 @@ of Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.IConfigProvider.html b/branch/4.0.0-beta/api/IPA.Config.IConfigProvider.html index 3737ecc6..58970a94 100644 --- a/branch/4.0.0-beta/api/IPA.Config.IConfigProvider.html +++ b/branch/4.0.0-beta/api/IPA.Config.IConfigProvider.html @@ -113,7 +113,7 @@ This is reasonable, as Integ Improve this Doc - View Source + View Source

    Extension

    @@ -150,7 +150,7 @@ This is reasonable, as Integ Improve this Doc - View Source + View Source

    Load(FileInfo)

    @@ -201,7 +201,7 @@ and returns it.

    Improve this Doc - View Source + View Source

    Store(Value, FileInfo)

    @@ -263,7 +263,7 @@ and returns it.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.IConfigStore.html b/branch/4.0.0-beta/api/IPA.Config.IConfigStore.html index 498dc0f8..5de69ea2 100644 --- a/branch/4.0.0-beta/api/IPA.Config.IConfigStore.html +++ b/branch/4.0.0-beta/api/IPA.Config.IConfigStore.html @@ -100,7 +100,7 @@ Improve this Doc - View Source + View Source

    SyncObject

    @@ -133,7 +133,7 @@ The writer will never signal this handle.

    Improve this Doc - View Source + View Source

    WriteSyncObject

    @@ -172,7 +172,7 @@ write lock with Improve this Doc - View Source + View Source

    ReadFrom(ConfigProvider)

    @@ -211,7 +211,7 @@ this is called.

    Improve this Doc - View Source + View Source

    WriteTo(ConfigProvider)

    @@ -272,7 +272,7 @@ this is called.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.IModPrefs.html b/branch/4.0.0-beta/api/IPA.Config.IModPrefs.html index e6b82047..c1a1188d 100644 --- a/branch/4.0.0-beta/api/IPA.Config.IModPrefs.html +++ b/branch/4.0.0-beta/api/IPA.Config.IModPrefs.html @@ -101,7 +101,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    GetBool(String, String, Boolean, Boolean)

    @@ -168,7 +168,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    GetFloat(String, String, Single, Boolean)

    @@ -235,7 +235,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    GetInt(String, String, Int32, Boolean)

    @@ -302,7 +302,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    GetString(String, String, String, Boolean)

    @@ -369,7 +369,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    HasKey(String, String)

    @@ -424,7 +424,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    SetBool(String, String, Boolean)

    @@ -470,7 +470,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    SetFloat(String, String, Single)

    @@ -516,7 +516,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    SetInt(String, String, Int32)

    @@ -562,7 +562,7 @@ public interface IModPrefs Improve this Doc - View Source + View Source

    SetString(String, String, String)

    @@ -630,7 +630,7 @@ public interface IModPrefs Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.ModPrefs.html b/branch/4.0.0-beta/api/IPA.Config.ModPrefs.html index f4781225..dd726408 100644 --- a/branch/4.0.0-beta/api/IPA.Config.ModPrefs.html +++ b/branch/4.0.0-beta/api/IPA.Config.ModPrefs.html @@ -134,7 +134,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    ModPrefs(PluginMetadata)

    @@ -170,7 +170,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    GetBool(String, String, Boolean, Boolean)

    @@ -237,7 +237,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    GetFloat(String, String, Single, Boolean)

    @@ -304,7 +304,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    GetInt(String, String, Int32, Boolean)

    @@ -371,7 +371,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    GetString(String, String, String, Boolean)

    @@ -438,7 +438,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    HasKey(String, String)

    @@ -493,7 +493,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    SetBool(String, String, Boolean)

    @@ -539,7 +539,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    SetFloat(String, String, Single)

    @@ -585,7 +585,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    SetInt(String, String, Int32)

    @@ -631,7 +631,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    SetString(String, String, String)

    @@ -679,7 +679,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.GetBool(String, String, Boolean, Boolean)

    @@ -741,7 +741,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.GetFloat(String, String, Single, Boolean)

    @@ -803,7 +803,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.GetInt(String, String, Int32, Boolean)

    @@ -865,7 +865,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.GetString(String, String, String, Boolean)

    @@ -927,7 +927,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.HasKey(String, String)

    @@ -979,7 +979,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.SetBool(String, String, Boolean)

    @@ -1021,7 +1021,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.SetFloat(String, String, Single)

    @@ -1063,7 +1063,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.SetInt(String, String, Int32)

    @@ -1105,7 +1105,7 @@ public class ModPrefs : IModPrefs Improve this Doc - View Source + View Source

    IModPrefs.SetString(String, String, String)

    @@ -1173,7 +1173,7 @@ public class ModPrefs : IModPrefs Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.IgnoreAttribute.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.IgnoreAttribute.html index 24c0ab2f..e33ed92d 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.IgnoreAttribute.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.IgnoreAttribute.html @@ -277,7 +277,7 @@ public sealed class IgnoreAttribute : Attribute, _Attribute Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.NonNullableAttribute.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.NonNullableAttribute.html index a1133abf..b7e550a6 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.NonNullableAttribute.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.NonNullableAttribute.html @@ -278,7 +278,7 @@ public sealed class NonNullableAttribute : Attribute, _Attribute Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html index f4ed07d5..7205fb35 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html @@ -276,7 +276,7 @@ However, if we were to add a Improve this Doc - View Source + View Source

    SerializedNameAttribute(String)

    @@ -312,7 +312,7 @@ However, if we were to add a Improve this Doc - View Source + View Source

    Name

    @@ -369,7 +369,7 @@ However, if we were to add a Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.UseConverterAttribute.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.UseConverterAttribute.html index 4e1dd938..ac8b64c2 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.UseConverterAttribute.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.UseConverterAttribute.html @@ -253,7 +253,7 @@ public sealed class UseConverterAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    UseConverterAttribute(Type)

    @@ -289,7 +289,7 @@ public sealed class UseConverterAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    ConverterTargetType

    @@ -321,7 +321,7 @@ public sealed class UseConverterAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    ConverterType

    @@ -352,7 +352,7 @@ public sealed class UseConverterAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    IsGenericConverter

    @@ -409,7 +409,7 @@ public sealed class UseConverterAttribute : Attribute, _Attribute Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-2.html index 14478789..525655f4 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-2.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-2.html @@ -168,7 +168,7 @@ Improve this Doc - View Source + View Source

    CollectionConverter()

    @@ -190,7 +190,7 @@ with Improve this Doc - View Source + View Source

    CollectionConverter(ValueConverter<T>)

    @@ -226,7 +226,7 @@ with Improve this Doc - View Source + View Source

    BaseConverter

    @@ -259,7 +259,7 @@ with Improve this Doc - View Source + View Source

    Create(Int32, Object)

    @@ -320,7 +320,7 @@ with Improve this Doc - View Source + View Source

    FromValue(Value, Object)

    @@ -383,7 +383,7 @@ owned by parent.< Improve this Doc - View Source + View Source

    PopulateFromValue(TCollection, List, Object)

    @@ -434,7 +434,7 @@ with the parent parentImprove this Doc - View Source + View Source

    ToValue(TCollection, Object)

    @@ -522,7 +522,7 @@ with the parent parentImprove this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html index e06175e4..5dd01d27 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html @@ -191,7 +191,7 @@ Improve this Doc - View Source + View Source

    CollectionConverter()

    @@ -243,7 +243,7 @@ with a default-constructed Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html index cbcb721e..49d76c10 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html @@ -145,7 +145,7 @@ Improve this Doc - View Source + View Source

    Default

    @@ -182,7 +182,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html index 416e98c6..fad1d741 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    FloatValue(Value)

    @@ -180,7 +180,7 @@ or null if Improve this Doc - View Source + View Source

    IntValue(Value)

    @@ -237,7 +237,7 @@ or null if Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html index 95efe34c..cabd753f 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html @@ -159,7 +159,7 @@ Improve this Doc - View Source + View Source

    Deserialize(Value, Object)

    @@ -219,7 +219,7 @@ Improve this Doc - View Source + View Source

    FromValue(Value, Object)

    @@ -281,7 +281,7 @@ Improve this Doc - View Source + View Source

    Serialize(T, Object)

    @@ -341,7 +341,7 @@ Improve this Doc - View Source + View Source

    ToValue(T, Object)

    @@ -433,7 +433,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html index 073069d7..d08a319e 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html @@ -182,7 +182,7 @@ Improve this Doc - View Source + View Source

    IListConverter()

    @@ -202,7 +202,7 @@ Improve this Doc - View Source + View Source

    IListConverter(ValueConverter<T>)

    @@ -238,7 +238,7 @@ Improve this Doc - View Source + View Source

    Create(Int32, Object)

    @@ -326,7 +326,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html index 74fba887..52e1291c 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html @@ -190,7 +190,7 @@ Improve this Doc - View Source + View Source

    IListConverter()

    @@ -242,7 +242,7 @@ with a default-constructed Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html index 3b889f43..72dec767 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html @@ -182,7 +182,7 @@ Improve this Doc - View Source + View Source

    ISetConverter()

    @@ -202,7 +202,7 @@ Improve this Doc - View Source + View Source

    ISetConverter(ValueConverter<T>)

    @@ -238,7 +238,7 @@ Improve this Doc - View Source + View Source

    Create(Int32, Object)

    @@ -326,7 +326,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html index 6512ab67..a61c6244 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html @@ -190,7 +190,7 @@ Improve this Doc - View Source + View Source

    ISetConverter()

    @@ -242,7 +242,7 @@ with a default-constructed Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html index 3f44845c..17256509 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html @@ -182,7 +182,7 @@ Improve this Doc - View Source + View Source

    ListConverter()

    @@ -202,7 +202,7 @@ Improve this Doc - View Source + View Source

    ListConverter(ValueConverter<T>)

    @@ -238,7 +238,7 @@ Improve this Doc - View Source + View Source

    Create(Int32, Object)

    @@ -326,7 +326,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html index e31977fe..09898afb 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html @@ -190,7 +190,7 @@ Improve this Doc - View Source + View Source

    ListConverter()

    @@ -242,7 +242,7 @@ with a default-constructed Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html index d0d0e387..ef51a086 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html @@ -160,7 +160,7 @@ Improve this Doc - View Source + View Source

    NullableConverter()

    @@ -183,7 +183,7 @@ Equivalent to

    Improve this Doc - View Source + View Source

    NullableConverter(ValueConverter<T>)

    @@ -219,7 +219,7 @@ Equivalent to

    Improve this Doc - View Source + View Source

    FromValue(Value, Object)

    @@ -277,7 +277,7 @@ Equivalent to

    Improve this Doc - View Source + View Source

    ToValue(Nullable<T>, Object)

    @@ -361,7 +361,7 @@ Equivalent to

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html index 2fe63f68..30eb1b42 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html @@ -172,7 +172,7 @@ to use as the underlying converter. Use this in the Improve this Doc - View Source + View Source

    NullableConverter()

    @@ -222,7 +222,7 @@ to use as the underlying converter. Use this in the Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html b/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html index 96454c18..579c4dc1 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html @@ -130,7 +130,7 @@ config stores.

    Improve this Doc - View Source + View Source

    AssemblyVisibilityTarget

    The name of the assembly that internals must be visible to to allow internal protection.

    @@ -162,7 +162,7 @@ config stores.

    Improve this Doc - View Source + View Source

    Generated<T>(Config, Boolean)

    @@ -281,7 +281,7 @@ TODO: describe details of generated stores Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html b/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html index cf94f975..8d2edec8 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html @@ -117,7 +117,7 @@ Converters do not need to perform null checks, as the serializer and de Improve this Doc - View Source + View Source

    Type

    @@ -150,7 +150,7 @@ Converters do not need to perform null checks, as the serializer and de Improve this Doc - View Source + View Source

    FromValue(Value, Object)

    @@ -206,7 +206,7 @@ Converters do not need to perform null checks, as the serializer and de Improve this Doc - View Source + View Source

    ToValue(Object, Object)

    @@ -284,7 +284,7 @@ Converters do not need to perform null checks, as the serializer and de Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html index aa552bff..a0d92c85 100644 --- a/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html +++ b/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html @@ -153,7 +153,7 @@ Improve this Doc - View Source + View Source

    FromValue(Value, Object)

    @@ -213,7 +213,7 @@ Improve this Doc - View Source + View Source

    ToValue(T, Object)

    @@ -275,7 +275,7 @@ Improve this Doc - View Source + View Source

    IValueConverter.FromValue(Value, Object)

    @@ -327,7 +327,7 @@ Improve this Doc - View Source + View Source

    IValueConverter.ToValue(Object, Object)

    @@ -379,7 +379,7 @@ Improve this Doc - View Source + View Source

    IValueConverter.Type

    @@ -439,7 +439,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.InitAttribute.html b/branch/4.0.0-beta/api/IPA.InitAttribute.html index 81d76e13..45bce630 100644 --- a/branch/4.0.0-beta/api/IPA.InitAttribute.html +++ b/branch/4.0.0-beta/api/IPA.InitAttribute.html @@ -289,7 +289,7 @@ Parameter injection is done with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.CannotRuntimeDisableException.html b/branch/4.0.0-beta/api/IPA.Loader.CannotRuntimeDisableException.html index 08f897b6..c948c1bd 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.CannotRuntimeDisableException.html +++ b/branch/4.0.0-beta/api/IPA.Loader.CannotRuntimeDisableException.html @@ -169,7 +169,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio Improve this Doc - View Source + View Source

    CannotRuntimeDisableException(PluginMetadata)

    @@ -203,7 +203,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio Improve this Doc - View Source + View Source

    CannotRuntimeDisableException(SerializationInfo, StreamingContext)

    @@ -258,7 +258,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio Improve this Doc - View Source + View Source

    Plugin

    @@ -318,7 +318,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html b/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html index 181144cf..118a5730 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html +++ b/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html @@ -132,7 +132,7 @@ Improve this Doc - View Source + View Source

    InvalidMessage

    @@ -165,7 +165,7 @@ This should also be set whenever either Improve this Doc - View Source + View Source

    StoreOnPlugin

    @@ -199,7 +199,7 @@ This should also be set whenever either Improve this Doc - View Source + View Source

    AfterInit(PluginMetadata)

    @@ -233,7 +233,7 @@ This should also be set whenever either Improve this Doc - View Source + View Source

    AfterInit(PluginMetadata, Object)

    @@ -273,7 +273,7 @@ This should also be set whenever either Improve this Doc - View Source + View Source

    BeforeInit(PluginMetadata)

    @@ -323,7 +323,7 @@ This should also be set whenever either Improve this Doc - View Source + View Source

    BeforeLoad(PluginMetadata)

    @@ -377,7 +377,7 @@ Any features it defines, for example, will still be loaded.

    Improve this Doc - View Source + View Source

    Evaluate()

    @@ -410,7 +410,7 @@ Any features it defines, for example, will still be loaded.

    Improve this Doc - View Source + View Source

    Initialize(PluginMetadata, String[])

    @@ -471,7 +471,7 @@ Any features it defines, for example, will still be loaded.

    Improve this Doc - View Source + View Source

    RequireLoaded(PluginMetadata)

    @@ -527,7 +527,7 @@ Any features it defines, for example, will still be loaded.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html index 56de2166..b6a98030 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html +++ b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html @@ -166,7 +166,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html index d2bd5e2b..e3b170ed 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html +++ b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html @@ -140,7 +140,7 @@ For all of the default injectors, only one of each will be generated, and any la Improve this Doc - View Source + View Source

    AddInjector(Type, PluginInitInjector.InjectParameter)

    @@ -186,7 +186,7 @@ For all of the default injectors, only one of each will be generated, and any la Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html index 523ba554..8d89d356 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html +++ b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html @@ -144,7 +144,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html index 7529b70b..110028db 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html +++ b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html @@ -144,7 +144,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html index ecc90c67..d5ff2519 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html +++ b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    AllPlugins

    @@ -161,7 +161,7 @@ Improve this Doc - View Source + View Source

    DisabledPlugins

    @@ -193,7 +193,7 @@ Improve this Doc - View Source + View Source

    Plugins

    @@ -228,7 +228,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    GetDisabledPlugin(String)

    @@ -278,7 +278,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    GetDisabledPluginFromId(String)

    @@ -328,7 +328,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    GetPlugin(String)

    @@ -378,7 +378,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    GetPluginFromId(String)

    @@ -428,7 +428,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    IsDisabled(PluginMetadata)

    @@ -478,7 +478,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    IsEnabled(PluginMetadata)

    @@ -528,7 +528,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    PluginStateTransaction()

    @@ -562,7 +562,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
    Improve this Doc - View Source + View Source

    PluginDisabled

    Called whenever a plugin is disabled.

    @@ -592,7 +592,7 @@ public static IEnumerable<IPlugin> Plugins { get; } Improve this Doc - View Source + View Source

    PluginEnabled

    Called whenever a plugin is enabled.

    @@ -628,7 +628,7 @@ public static IEnumerable<IPlugin> Plugins { get; } Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginMetadata.html b/branch/4.0.0-beta/api/IPA.Loader.PluginMetadata.html index 7d5455f4..f5c80cfd 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.PluginMetadata.html +++ b/branch/4.0.0-beta/api/IPA.Loader.PluginMetadata.html @@ -126,7 +126,7 @@ Improve this Doc - View Source + View Source

    Assembly

    @@ -158,7 +158,7 @@ Improve this Doc - View Source + View Source

    Features

    @@ -190,7 +190,7 @@ Improve this Doc - View Source + View Source

    File

    @@ -222,7 +222,7 @@ Improve this Doc - View Source + View Source

    Id

    @@ -254,7 +254,7 @@ Improve this Doc - View Source + View Source

    IsBare

    @@ -286,7 +286,7 @@ Improve this Doc - View Source + View Source

    Name

    @@ -318,7 +318,7 @@ Improve this Doc - View Source + View Source

    PluginType

    @@ -350,7 +350,7 @@ Improve this Doc - View Source + View Source

    RuntimeOptions

    @@ -381,7 +381,7 @@ Improve this Doc - View Source + View Source

    Version

    @@ -415,7 +415,7 @@ Improve this Doc - View Source + View Source

    ToString()

    @@ -471,7 +471,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Loader.StateTransitionTransaction.html b/branch/4.0.0-beta/api/IPA.Loader.StateTransitionTransaction.html index 8814aadb..e84bfe9d 100644 --- a/branch/4.0.0-beta/api/IPA.Loader.StateTransitionTransaction.html +++ b/branch/4.0.0-beta/api/IPA.Loader.StateTransitionTransaction.html @@ -133,7 +133,7 @@ Improve this Doc - View Source + View Source

    DisabledPlugins

    @@ -180,7 +180,7 @@ Improve this Doc - View Source + View Source

    EnabledPlugins

    @@ -227,7 +227,7 @@ Improve this Doc - View Source + View Source

    WillNeedRestart

    @@ -277,7 +277,7 @@ Improve this Doc - View Source + View Source

    Commit()

    @@ -349,7 +349,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc - View Source + View Source

    Disable(PluginMetadata, Boolean)

    @@ -430,7 +430,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc - View Source + View Source

    Disable(PluginMetadata, out IEnumerable<PluginMetadata>, Boolean)

    @@ -516,7 +516,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc - View Source + View Source

    Dispose()

    @@ -532,7 +532,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc - View Source + View Source

    Enable(PluginMetadata, Boolean)

    @@ -613,7 +613,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc - View Source + View Source

    Enable(PluginMetadata, out IEnumerable<PluginMetadata>, Boolean)

    @@ -699,7 +699,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc - View Source + View Source

    IsDisabled(PluginMetadata)

    @@ -774,7 +774,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc - View Source + View Source

    IsEnabled(PluginMetadata)

    @@ -875,7 +875,7 @@ the number of plugins being disabled, and the time they take. Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.LogPrinter.html b/branch/4.0.0-beta/api/IPA.Logging.LogPrinter.html index 25bbacbb..881faad4 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.LogPrinter.html +++ b/branch/4.0.0-beta/api/IPA.Logging.LogPrinter.html @@ -132,7 +132,7 @@ Improve this Doc - View Source + View Source

    Filter

    @@ -166,7 +166,7 @@ Improve this Doc - View Source + View Source

    EndPrint()

    @@ -183,7 +183,7 @@ Use this to dispose file handles and the like.

    Improve this Doc - View Source + View Source

    Print(Logger.Level, DateTime, String, String)

    @@ -235,7 +235,7 @@ Use this to dispose file handles and the like.

    Improve this Doc - View Source + View Source

    StartPrint()

    @@ -274,7 +274,7 @@ Use this to create file handles and the like.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Logger.Level.html b/branch/4.0.0-beta/api/IPA.Logging.Logger.Level.html index 71c336ba..d9e1bf5c 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Logger.Level.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Logger.Level.html @@ -172,7 +172,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Logger.LogLevel.html b/branch/4.0.0-beta/api/IPA.Logging.Logger.LogLevel.html index d70ee902..a2122157 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Logger.LogLevel.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Logger.LogLevel.html @@ -208,7 +208,7 @@ public enum LogLevel : byte Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Logger.html b/branch/4.0.0-beta/api/IPA.Logging.Logger.html index 7b6ee431..d3520245 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Logger.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Logger.html @@ -130,7 +130,7 @@ Improve this Doc - View Source + View Source

    LogFormat

    @@ -164,7 +164,7 @@ Improve this Doc - View Source + View Source

    Critical(Exception)

    @@ -203,7 +203,7 @@ Equivalent to Log(Level.Critical, e);

    Improve this Doc - View Source + View Source

    Critical(String)

    @@ -242,7 +242,7 @@ Equivalent to Log(Level.Critical, message);

    Improve this Doc - View Source + View Source

    Debug(Exception)

    @@ -281,7 +281,7 @@ Equivalent to Log(Level.Debug, e);

    Improve this Doc - View Source + View Source

    Debug(String)

    @@ -320,7 +320,7 @@ Equivalent to Log(Level.Debug, message);

    Improve this Doc - View Source + View Source

    Error(Exception)

    @@ -359,7 +359,7 @@ Equivalent to Log(Level.Error, e);

    Improve this Doc - View Source + View Source

    Error(String)

    @@ -398,7 +398,7 @@ Equivalent to Log(Level.Error, message);

    Improve this Doc - View Source + View Source

    Info(Exception)

    @@ -437,7 +437,7 @@ Equivalent to Log(Level.Info, e);

    Improve this Doc - View Source + View Source

    Info(String)

    @@ -476,7 +476,7 @@ Equivalent to Log(Level.Info, message);

    Improve this Doc - View Source + View Source

    Log(Logger.Level, Exception)

    @@ -516,7 +516,7 @@ Equivalent to Log(Level.Info, message);

    Improve this Doc - View Source + View Source

    Log(Logger.Level, String)

    @@ -556,7 +556,7 @@ Equivalent to Log(Level.Info, message);

    Improve this Doc - View Source + View Source

    Notice(Exception)

    @@ -595,7 +595,7 @@ Equivalent to Log(Level.Notice, e);

    Improve this Doc - View Source + View Source

    Notice(String)

    @@ -634,7 +634,7 @@ Equivalent to Log(Level.Notice, message);

    Improve this Doc - View Source + View Source

    Trace(Exception)

    @@ -673,7 +673,7 @@ Equivalent to Log(Level.Trace, e);

    Improve this Doc - View Source + View Source

    Trace(String)

    @@ -712,7 +712,7 @@ Equivalent to Log(Level.Trace, message);

    Improve this Doc - View Source + View Source

    Warn(Exception)

    @@ -751,7 +751,7 @@ Equivalent to Log(Level.Warning, e);

    Improve this Doc - View Source + View Source

    Warn(String)

    @@ -815,7 +815,7 @@ Equivalent to Log(Level.Warning, message);

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.LoggerExtensions.html b/branch/4.0.0-beta/api/IPA.Logging.LoggerExtensions.html index edfa1dad..32d04f1f 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.LoggerExtensions.html +++ b/branch/4.0.0-beta/api/IPA.Logging.LoggerExtensions.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    GetChildLogger(Logger, String)

    @@ -191,7 +191,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Printers.ColoredConsolePrinter.html b/branch/4.0.0-beta/api/IPA.Logging.Printers.ColoredConsolePrinter.html index f35180f5..cca5b756 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Printers.ColoredConsolePrinter.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Printers.ColoredConsolePrinter.html @@ -136,7 +136,7 @@ Improve this Doc - View Source + View Source

    Color

    @@ -168,7 +168,7 @@ Improve this Doc - View Source + View Source

    Filter

    @@ -204,7 +204,7 @@ Improve this Doc - View Source + View Source

    Print(Logger.Level, DateTime, String, String)

    @@ -280,7 +280,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Printers.ColorlessConsolePrinter.html b/branch/4.0.0-beta/api/IPA.Logging.Printers.ColorlessConsolePrinter.html index 43e8d2c5..7d2a6ed1 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Printers.ColorlessConsolePrinter.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Printers.ColorlessConsolePrinter.html @@ -136,7 +136,7 @@ Improve this Doc - View Source + View Source

    Filter

    @@ -172,7 +172,7 @@ Improve this Doc - View Source + View Source

    Print(Logger.Level, DateTime, String, String)

    @@ -248,7 +248,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Printers.GZFilePrinter.html b/branch/4.0.0-beta/api/IPA.Logging.Printers.GZFilePrinter.html index 5fb463c1..bc38acda 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Printers.GZFilePrinter.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Printers.GZFilePrinter.html @@ -143,7 +143,7 @@ Improve this Doc - View Source + View Source

    FileWriter

    The StreamWriter that writes to the GZip file.

    @@ -176,7 +176,7 @@ Improve this Doc - View Source + View Source

    Dispose()

    @@ -191,7 +191,7 @@ Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -225,7 +225,7 @@ Improve this Doc - View Source + View Source

    EndPrint()

    @@ -243,7 +243,7 @@ Improve this Doc - View Source + View Source

    GetFileInfo()

    @@ -275,7 +275,7 @@ Improve this Doc - View Source + View Source

    StartPrint()

    @@ -319,7 +319,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Printers.GlobalLogFilePrinter.html b/branch/4.0.0-beta/api/IPA.Logging.Printers.GlobalLogFilePrinter.html index fdaeb515..cee324c2 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Printers.GlobalLogFilePrinter.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Printers.GlobalLogFilePrinter.html @@ -150,7 +150,7 @@ Improve this Doc - View Source + View Source

    Filter

    @@ -186,7 +186,7 @@ Improve this Doc - View Source + View Source

    GetFileInfo()

    @@ -220,7 +220,7 @@ Improve this Doc - View Source + View Source

    Print(Logger.Level, DateTime, String, String)

    @@ -300,7 +300,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginLogFilePrinter.html b/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginLogFilePrinter.html index 7ea36178..25da70aa 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginLogFilePrinter.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginLogFilePrinter.html @@ -150,7 +150,7 @@ Improve this Doc - View Source + View Source

    PluginLogFilePrinter(String)

    @@ -186,7 +186,7 @@ Improve this Doc - View Source + View Source

    Filter

    @@ -222,7 +222,7 @@ Improve this Doc - View Source + View Source

    GetFileInfo()

    @@ -256,7 +256,7 @@ Improve this Doc - View Source + View Source

    Print(Logger.Level, DateTime, String, String)

    @@ -336,7 +336,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginSubLogPrinter.html b/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginSubLogPrinter.html index 401568b6..6290ab8a 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginSubLogPrinter.html +++ b/branch/4.0.0-beta/api/IPA.Logging.Printers.PluginSubLogPrinter.html @@ -150,7 +150,7 @@ Improve this Doc - View Source + View Source

    PluginSubLogPrinter(String, String)

    @@ -192,7 +192,7 @@ Improve this Doc - View Source + View Source

    Filter

    @@ -228,7 +228,7 @@ Improve this Doc - View Source + View Source

    GetFileInfo()

    @@ -262,7 +262,7 @@ Improve this Doc - View Source + View Source

    Print(Logger.Level, DateTime, String, String)

    @@ -342,7 +342,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html b/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html index 27c184b9..ee7d1694 100644 --- a/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html +++ b/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html @@ -181,7 +181,7 @@ The modification of printers on a parent are reflected down the chain.

    Improve this Doc - View Source + View Source

    ConsoleWriter

    @@ -213,7 +213,7 @@ The modification of printers on a parent are reflected down the chain.

    Improve this Doc - View Source + View Source

    PrintFilter

    @@ -247,7 +247,7 @@ The modification of printers on a parent are reflected down the chain.

    Improve this Doc - View Source + View Source

    AddPrinter(LogPrinter)

    @@ -281,7 +281,7 @@ The modification of printers on a parent are reflected down the chain.

    Improve this Doc - View Source + View Source

    Debug(String)

    @@ -321,7 +321,7 @@ The modification of printers on a parent are reflected down the chain.

    Improve this Doc - View Source + View Source

    Log(Logger.Level, String)

    @@ -388,7 +388,7 @@ The modification of printers on a parent are reflected down the chain.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Old.IEnhancedPlugin.html b/branch/4.0.0-beta/api/IPA.Old.IEnhancedPlugin.html index bf5ec2c7..a0c3b0ea 100644 --- a/branch/4.0.0-beta/api/IPA.Old.IEnhancedPlugin.html +++ b/branch/4.0.0-beta/api/IPA.Old.IEnhancedPlugin.html @@ -128,7 +128,7 @@ public interface IEnhancedPlugin : IPlugin Improve this Doc - View Source + View Source

    Filter

    @@ -164,7 +164,7 @@ public interface IEnhancedPlugin : IPlugin Improve this Doc - View Source + View Source

    OnLateUpdate()

    @@ -202,7 +202,7 @@ public interface IEnhancedPlugin : IPlugin Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Old.IPlugin.html b/branch/4.0.0-beta/api/IPA.Old.IPlugin.html index 5c341b09..77a3f9fa 100644 --- a/branch/4.0.0-beta/api/IPA.Old.IPlugin.html +++ b/branch/4.0.0-beta/api/IPA.Old.IPlugin.html @@ -102,7 +102,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    Name

    @@ -133,7 +133,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    Version

    @@ -166,7 +166,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    OnApplicationQuit()

    @@ -182,7 +182,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    OnApplicationStart()

    @@ -198,7 +198,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    OnFixedUpdate()

    @@ -214,7 +214,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    OnLevelWasInitialized(Int32)

    @@ -247,7 +247,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    OnLevelWasLoaded(Int32)

    @@ -280,7 +280,7 @@ public interface IPlugin Improve this Doc - View Source + View Source

    OnUpdate()

    @@ -318,7 +318,7 @@ public interface IPlugin Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html b/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html index efd65293..0501dcd8 100644 --- a/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html +++ b/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html @@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html b/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html index d0d3a1ca..4a988f84 100644 --- a/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html +++ b/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html @@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.OnExitAttribute.html b/branch/4.0.0-beta/api/IPA.OnExitAttribute.html index f020b76a..2277c790 100644 --- a/branch/4.0.0-beta/api/IPA.OnExitAttribute.html +++ b/branch/4.0.0-beta/api/IPA.OnExitAttribute.html @@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.OnStartAttribute.html b/branch/4.0.0-beta/api/IPA.OnStartAttribute.html index 3ad6c1f7..c9ea35ba 100644 --- a/branch/4.0.0-beta/api/IPA.OnStartAttribute.html +++ b/branch/4.0.0-beta/api/IPA.OnStartAttribute.html @@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.PluginAttribute.html b/branch/4.0.0-beta/api/IPA.PluginAttribute.html index 56efde27..78bc396f 100644 --- a/branch/4.0.0-beta/api/IPA.PluginAttribute.html +++ b/branch/4.0.0-beta/api/IPA.PluginAttribute.html @@ -252,7 +252,7 @@ public sealed class PluginAttribute : Attribute, _Attribute Improve this Doc - View Source + View Source

    PluginAttribute(RuntimeOptions)

    @@ -289,7 +289,7 @@ to indicate the runtime capabilities of the plugin.

    Improve this Doc - View Source + View Source

    RuntimeOptions

    @@ -354,7 +354,7 @@ to indicate the runtime capabilities of the plugin.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.RuntimeOptions.html b/branch/4.0.0-beta/api/IPA.RuntimeOptions.html index fa9720f6..54b77d95 100644 --- a/branch/4.0.0-beta/api/IPA.RuntimeOptions.html +++ b/branch/4.0.0-beta/api/IPA.RuntimeOptions.html @@ -171,7 +171,7 @@ With this option set, whether or not the plugin is disabled during a given run i Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.StoredAs.html b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.StoredAs.html index 013274f3..395ad23f 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.StoredAs.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.StoredAs.html @@ -142,7 +142,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.html b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.html index 03a8eec4..2c5f4e85 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersion.html @@ -126,7 +126,7 @@ not a valid SemVer.Version.

    Improve this Doc - View Source + View Source

    AlmostVersion(Version)

    @@ -160,7 +160,7 @@ not a valid SemVer.Version.

    Improve this Doc - View Source + View Source

    AlmostVersion(String)

    @@ -194,7 +194,7 @@ not a valid SemVer.Version.

    Improve this Doc - View Source + View Source

    AlmostVersion(String, AlmostVersion)

    @@ -235,7 +235,7 @@ same way as the AlmostVe Improve this Doc - View Source + View Source

    AlmostVersion(String, AlmostVersion.StoredAs)

    @@ -278,7 +278,7 @@ the storage mode specified in Improve this Doc - View Source + View Source

    SemverValue

    @@ -310,7 +310,7 @@ the storage mode specified in Improve this Doc - View Source + View Source

    StorageMode

    @@ -342,7 +342,7 @@ the storage mode specified in Improve this Doc - View Source + View Source

    StringValue

    @@ -376,7 +376,7 @@ the storage mode specified in Improve this Doc - View Source + View Source

    CompareTo(AlmostVersion)

    @@ -434,7 +434,7 @@ or Improve this Doc - View Source + View Source

    CompareTo(Version)

    @@ -492,7 +492,7 @@ be thrown.

    Improve this Doc - View Source + View Source

    Equals(Object)

    @@ -551,7 +551,7 @@ be thrown.

    Improve this Doc - View Source + View Source

    GetHashCode()

    @@ -589,7 +589,7 @@ be thrown.

    Improve this Doc - View Source + View Source

    ToString()

    @@ -630,7 +630,7 @@ stored as a SemVer.Version, it is equivalent to callin Improve this Doc - View Source + View Source

    Equality(AlmostVersion, AlmostVersion)

    @@ -695,7 +695,7 @@ does not.

    Improve this Doc - View Source + View Source

    Implicit(AlmostVersion to Version)

    @@ -749,7 +749,7 @@ If not applicable, returns null

    Improve this Doc - View Source + View Source

    Implicit(Version to AlmostVersion)

    @@ -802,7 +802,7 @@ If not applicable, returns null

    Improve this Doc - View Source + View Source

    Inequality(AlmostVersion, AlmostVersion)

    @@ -891,7 +891,7 @@ If not applicable, returns null

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html index 5e676ad0..45d6a64b 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html @@ -143,7 +143,7 @@ Improve this Doc - View Source + View Source

    FromValue(Value, Object)

    @@ -200,7 +200,7 @@ Improve this Doc - View Source + View Source

    ToValue(AlmostVersion, Object)

    @@ -284,7 +284,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Coroutines.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Coroutines.html index ef06bb3b..18b8dbe5 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Coroutines.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Coroutines.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    WaitForTask(Task)

    @@ -185,7 +185,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html index 7c3c1453..28ca6940 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html @@ -158,7 +158,7 @@ Improve this Doc - View Source + View Source

    IsRunning

    @@ -207,7 +207,7 @@ Improve this Doc - View Source + View Source

    Dispose()

    @@ -223,7 +223,7 @@ Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -257,7 +257,7 @@ Improve this Doc - View Source + View Source

    Exit()

    @@ -308,7 +308,7 @@ Improve this Doc - View Source + View Source

    GetScheduledTasks()

    @@ -358,7 +358,7 @@ Improve this Doc - View Source + View Source

    Join()

    @@ -393,7 +393,7 @@ Improve this Doc - View Source + View Source

    QueueTask(Task)

    @@ -446,7 +446,7 @@ scheduled for this Improve this Doc - View Source + View Source

    Start()

    @@ -478,7 +478,7 @@ scheduled for this Improve this Doc - View Source + View Source

    TryExecuteTaskInline(Task, Boolean)

    @@ -581,7 +581,7 @@ make sense to run it inline.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html index 66ea12ba..0e2c8d6b 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html @@ -126,7 +126,7 @@ Create this with Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -172,7 +172,7 @@ Create this with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html index a5c76da0..f63b651d 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html @@ -126,7 +126,7 @@ it is disposed. Create this with Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -172,7 +172,7 @@ it is disposed. Create this with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html index 3bd432ed..2ff0a052 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html @@ -126,7 +126,7 @@ when it is disposed. Create this with Improve this Doc - View Source + View Source

    Upgrade()

    @@ -165,7 +165,7 @@ upgrading the current thread's lock.

    Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -211,7 +211,7 @@ upgrading the current thread's lock.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html index 1b8d15da..235362f2 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html @@ -126,7 +126,7 @@ it is disposed. Create this with Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -172,7 +172,7 @@ it is disposed. Create this with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html index ac0905e3..7dc8eecd 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html @@ -126,7 +126,7 @@ Create this with Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -172,7 +172,7 @@ Create this with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html index a06aeba0..75380309 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html @@ -126,7 +126,7 @@ when it is disposed. Create this with Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -172,7 +172,7 @@ when it is disposed. Create this with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html index fad96fa9..b65cd560 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html @@ -126,7 +126,7 @@ Create this with Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -172,7 +172,7 @@ Create this with Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html index 7b79c3bb..8460ca81 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html @@ -137,7 +137,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc - View Source + View Source

    Lock(Mutex)

    @@ -187,7 +187,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc - View Source + View Source

    Lock(Semaphore)

    @@ -237,7 +237,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc - View Source + View Source

    Lock(SemaphoreSlim)

    @@ -287,7 +287,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc - View Source + View Source

    LockAsync(SemaphoreSlim)

    @@ -337,7 +337,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc - View Source + View Source

    LockRead(ReaderWriterLockSlim)

    @@ -387,7 +387,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc - View Source + View Source

    LockReadUpgradable(ReaderWriterLockSlim)

    @@ -437,7 +437,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc - View Source + View Source

    LockWrite(ReaderWriterLockSlim)

    @@ -493,7 +493,7 @@ with whichever member you want to use, according to your lock type. Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html index fe5696d1..e89987eb 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html @@ -155,7 +155,7 @@ Improve this Doc - View Source + View Source

    Cancelling

    @@ -187,7 +187,7 @@ Improve this Doc - View Source + View Source

    Default

    @@ -219,7 +219,7 @@ Improve this Doc - View Source + View Source

    Factory

    @@ -251,7 +251,7 @@ Improve this Doc - View Source + View Source

    IsRunning

    @@ -283,7 +283,7 @@ Improve this Doc - View Source + View Source

    YieldAfterTasks

    @@ -315,7 +315,7 @@ Improve this Doc - View Source + View Source

    YieldAfterTime

    @@ -349,7 +349,7 @@ Improve this Doc - View Source + View Source

    Cancel()

    @@ -387,7 +387,7 @@ All remaining tasks will be left in the queue.

    Improve this Doc - View Source + View Source

    Coroutine()

    @@ -451,7 +451,7 @@ exit on its own. Improve this Doc - View Source + View Source

    Dispose()

    @@ -467,7 +467,7 @@ exit on its own. Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -501,7 +501,7 @@ exit on its own. Improve this Doc - View Source + View Source

    GetScheduledTasks()

    @@ -551,7 +551,7 @@ exit on its own. Improve this Doc - View Source + View Source

    QueueTask(Task)

    @@ -604,7 +604,7 @@ scheduled for this Improve this Doc - View Source + View Source

    TryExecuteTaskInline(Task, Boolean)

    @@ -707,7 +707,7 @@ make sense to run it inline.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html b/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html index ddf054fb..b6504358 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html @@ -125,7 +125,7 @@ Improve this Doc - View Source + View Source

    IDisposable.Dispose()

    @@ -166,7 +166,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html b/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html index f098bea4..a39c17ea 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    EnterExecuteSection()

    @@ -145,7 +145,7 @@ Improve this Doc - View Source + View Source

    ExecuteSection()

    @@ -177,7 +177,7 @@ Improve this Doc - View Source + View Source

    ExitExecuteSection()

    @@ -199,7 +199,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html b/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html index 0c75276a..ce6ed50a 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    Append<T>(IEnumerable<T>, T)

    @@ -201,7 +201,7 @@ Improve this Doc - View Source + View Source

    NonNull<T>(IEnumerable<T>)

    @@ -268,7 +268,7 @@ Improve this Doc - View Source + View Source

    NonNull<T>(IEnumerable<Nullable<T>>)

    @@ -335,7 +335,7 @@ Improve this Doc - View Source + View Source

    NonNull<T, U>(IEnumerable<T>, Func<T, U>)

    @@ -413,7 +413,7 @@ Improve this Doc - View Source + View Source

    Prepend<T>(IEnumerable<T>, T)

    @@ -491,7 +491,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html b/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html index 12ec10c4..2b968671 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    GetDefault(Type)

    @@ -179,7 +179,7 @@ Improve this Doc - View Source + View Source

    IsSubPathOf(String, String)

    @@ -234,7 +234,7 @@ only matches if the base dir folder name is matched exactly ("c:\foobar\fil Improve this Doc - View Source + View Source

    Right(String, Int32)

    @@ -290,7 +290,7 @@ only matches if the base dir folder name is matched exactly ("c:\foobar\fil Improve this Doc - View Source + View Source

    Unwrap(Nullable<Boolean>)

    @@ -340,7 +340,7 @@ only matches if the base dir folder name is matched exactly ("c:\foobar\fil Improve this Doc - View Source + View Source

    WithEnding(String, String)

    @@ -403,7 +403,7 @@ results in satisfying .EndsWith(ending).

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.Accessor.html b/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.Accessor.html index decf7fdb..83b87a32 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.Accessor.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.Accessor.html @@ -154,7 +154,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.html b/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.html index 4e206106..a8742eb7 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.FieldAccessor-2.html @@ -150,7 +150,7 @@ Improve this Doc - View Source + View Source

    Access(ref T, String)

    @@ -226,7 +226,7 @@ Improve this Doc - View Source + View Source

    Get(T, String)

    @@ -304,7 +304,7 @@ Improve this Doc - View Source + View Source

    Get(ref T, String)

    @@ -386,7 +386,7 @@ as it prevents a copy.

    Improve this Doc - View Source + View Source

    GetAccessor(String)

    @@ -452,7 +452,7 @@ as it prevents a copy.

    Improve this Doc - View Source + View Source

    Set(T, String, U)

    @@ -523,7 +523,7 @@ as it prevents a copy.

    Improve this Doc - View Source + View Source

    Set(ref T, String, U)

    @@ -604,7 +604,7 @@ as it prevents a copy.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Getter.html b/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Getter.html index 408b0817..dcacf17f 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Getter.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Getter.html @@ -154,7 +154,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Setter.html b/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Setter.html index 028a5455..2368fc6a 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Setter.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.Setter.html @@ -144,7 +144,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.html b/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.html index ab45c383..e008fb74 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.PropertyAccessor-2.html @@ -150,7 +150,7 @@ Improve this Doc - View Source + View Source

    Get(T, String)

    @@ -227,7 +227,7 @@ Improve this Doc - View Source + View Source

    Get(ref T, String)

    @@ -308,7 +308,7 @@ it avoids a copy.

    Improve this Doc - View Source + View Source

    GetGetter(String)

    @@ -374,7 +374,7 @@ it avoids a copy.

    Improve this Doc - View Source + View Source

    GetSetter(String)

    @@ -440,7 +440,7 @@ it avoids a copy.

    Improve this Doc - View Source + View Source

    Set(T, String, U)

    @@ -510,7 +510,7 @@ it avoids a copy.

    Improve this Doc - View Source + View Source

    Set(ref T, String, U)

    @@ -586,7 +586,7 @@ it avoids a copy.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html b/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html index 409f0c72..10c61d52 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html @@ -150,7 +150,7 @@ Improve this Doc - View Source + View Source

    Ref(T)

    @@ -186,7 +186,7 @@ Improve this Doc - View Source + View Source

    Error

    @@ -218,7 +218,7 @@ Improve this Doc - View Source + View Source

    Value

    @@ -252,7 +252,7 @@ Improve this Doc - View Source + View Source

    CompareTo(T)

    @@ -302,7 +302,7 @@ Improve this Doc - View Source + View Source

    CompareTo(Ref<T>)

    @@ -352,7 +352,7 @@ Improve this Doc - View Source + View Source

    Verify()

    @@ -370,7 +370,7 @@ Improve this Doc - View Source + View Source

    Implicit(T to Ref<T>)

    @@ -420,7 +420,7 @@ Improve this Doc - View Source + View Source

    Implicit(Ref<T> to T)

    @@ -499,7 +499,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Ref.html b/branch/4.0.0-beta/api/IPA.Utilities.Ref.html index 45beff54..8c78a5af 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Ref.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Ref.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    Create<T>(T)

    @@ -201,7 +201,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html b/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html index 384272e5..47be69e0 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    CopyComponent(Component, Type, GameObject, Type)

    @@ -197,7 +197,7 @@ Improve this Doc - View Source + View Source

    CopyComponent<T>(Component, GameObject, Type)

    @@ -280,7 +280,7 @@ Improve this Doc - View Source + View Source

    GetField<U, T>(T, String)

    @@ -377,7 +377,7 @@ Improve this Doc - View Source + View Source

    GetProperty<U, T>(T, String)

    @@ -474,7 +474,7 @@ Improve this Doc - View Source + View Source

    InvokeMethod<U, T>(T, String, Object[])

    @@ -573,7 +573,7 @@ Improve this Doc - View Source + View Source

    SetField<T, U>(T, String, U)

    @@ -660,7 +660,7 @@ Improve this Doc - View Source + View Source

    SetProperty<T, U>(T, String, U)

    @@ -753,7 +753,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.Release.html b/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.Release.html index a287d08f..dc97486a 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.Release.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.Release.html @@ -142,7 +142,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.html b/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.html index c7629e34..14e0c2ab 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.UnityGame.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    GameVersion

    @@ -161,7 +161,7 @@ Improve this Doc - View Source + View Source

    InstallPath

    @@ -193,7 +193,7 @@ Improve this Doc - View Source + View Source

    LibraryPath

    @@ -225,7 +225,7 @@ Improve this Doc - View Source + View Source

    NativeLibraryPath

    @@ -257,7 +257,7 @@ Improve this Doc - View Source + View Source

    OnMainThread

    @@ -289,7 +289,7 @@ Improve this Doc - View Source + View Source

    PluginsPath

    @@ -321,7 +321,7 @@ Improve this Doc - View Source + View Source

    ReleaseType

    @@ -356,7 +356,7 @@ Improve this Doc - View Source + View Source

    UserDataPath

    @@ -394,7 +394,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Utils.html b/branch/4.0.0-beta/api/IPA.Utilities.Utils.html index 61bc9ddd..e813a3e5 100644 --- a/branch/4.0.0-beta/api/IPA.Utilities.Utils.html +++ b/branch/4.0.0-beta/api/IPA.Utilities.Utils.html @@ -129,7 +129,7 @@ Improve this Doc - View Source + View Source

    CanUseDateTimeNowSafely

    @@ -163,7 +163,7 @@ Improve this Doc - View Source + View Source

    ByteArrayToString(Byte[])

    @@ -213,7 +213,7 @@ Improve this Doc - View Source + View Source

    CopyAll(DirectoryInfo, DirectoryInfo, String, Func<Exception, FileInfo, Boolean>)

    @@ -265,7 +265,7 @@ Improve this Doc - View Source + View Source

    CurrentTime()

    @@ -299,7 +299,7 @@ the value will be greater than the previous result. Not suitable for timing.

    Improve this Doc - View Source + View Source

    GetRelativePath(String, String)

    @@ -355,7 +355,7 @@ the value will be greater than the previous result. Not suitable for timing.

    Improve this Doc - View Source + View Source

    StringToByteArray(String)

    @@ -405,7 +405,7 @@ the value will be greater than the previous result. Not suitable for timing.

    Improve this Doc - View Source + View Source

    UnsafeCompare(Byte[], Byte[])

    @@ -461,7 +461,7 @@ the value will be greater than the previous result. Not suitable for timing.

    Improve this Doc - View Source + View Source

    VersionCompareNoPrerelease(Version, Version)

    @@ -523,7 +523,7 @@ the value will be greater than the previous result. Not suitable for timing.

    Improve this Doc
  • - View Source + View Source
  • diff --git a/branch/4.0.0-beta/api/index.html b/branch/4.0.0-beta/api/index.html index e9d574fa..9b149b7b 100644 --- a/branch/4.0.0-beta/api/index.html +++ b/branch/4.0.0-beta/api/index.html @@ -90,7 +90,7 @@ Select a namespace and a class on the left to get started.

    diff --git a/branch/4.0.0-beta/articles/command-line.html b/branch/4.0.0-beta/articles/command-line.html index 35228a82..c169ffde 100644 --- a/branch/4.0.0-beta/articles/command-line.html +++ b/branch/4.0.0-beta/articles/command-line.html @@ -183,7 +183,7 @@ avaliable. If there is, it will be downloaded and installed on the next run. Thi diff --git a/branch/4.0.0-beta/articles/contributing.html b/branch/4.0.0-beta/articles/contributing.html index 91ce81f6..7e2bb87f 100644 --- a/branch/4.0.0-beta/articles/contributing.html +++ b/branch/4.0.0-beta/articles/contributing.html @@ -117,7 +117,7 @@ should reference the copy in there. When building for Release, it just uses the diff --git a/branch/4.0.0-beta/articles/dev-resources/description.html b/branch/4.0.0-beta/articles/dev-resources/description.html index a504bb21..16f983b2 100644 --- a/branch/4.0.0-beta/articles/dev-resources/description.html +++ b/branch/4.0.0-beta/articles/dev-resources/description.html @@ -91,7 +91,7 @@ diff --git a/branch/4.0.0-beta/articles/index.html b/branch/4.0.0-beta/articles/index.html index a70b8540..a500089a 100644 --- a/branch/4.0.0-beta/articles/index.html +++ b/branch/4.0.0-beta/articles/index.html @@ -94,7 +94,7 @@ diff --git a/branch/4.0.0-beta/articles/start-dev.html b/branch/4.0.0-beta/articles/start-dev.html index a086c62a..b630793a 100644 --- a/branch/4.0.0-beta/articles/start-dev.html +++ b/branch/4.0.0-beta/articles/start-dev.html @@ -517,7 +517,7 @@ namespace Demo diff --git a/branch/4.0.0-beta/articles/start-user.html b/branch/4.0.0-beta/articles/start-user.html index 49b9caa5..f0efab09 100644 --- a/branch/4.0.0-beta/articles/start-user.html +++ b/branch/4.0.0-beta/articles/start-user.html @@ -161,7 +161,7 @@ the game directory, though your plugins will be moved to a different folder when diff --git a/branch/4.0.0-beta/index.html b/branch/4.0.0-beta/index.html index 755e78ed..96e013ee 100644 --- a/branch/4.0.0-beta/index.html +++ b/branch/4.0.0-beta/index.html @@ -101,7 +101,7 @@ diff --git a/branch/4.0.0-beta/index.json b/branch/4.0.0-beta/index.json index cb07b57c..9ef1ba87 100644 --- a/branch/4.0.0-beta/index.json +++ b/branch/4.0.0-beta/index.json @@ -1,48 +1,53 @@ { - "api/IPA.Loader.PluginInitInjector.InjectParameter.html": { - "href": "api/IPA.Loader.PluginInitInjector.InjectParameter.html", - "title": "Delegate PluginInitInjector.InjectParameter", - "keywords": "Delegate PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate object InjectParameter(object previous, ParameterInfo param, PluginMetadata meta); Parameters Type Name Description Object previous the previous return value of the function, or null if never called for plugin. ParameterInfo param the ParameterInfo of the parameter being injected. PluginMetadata meta the PluginMetadata for the plugin being loaded. Returns Type Description Object the value to inject into that parameter. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Logging.Printers.ColoredConsolePrinter.html": { + "href": "api/IPA.Logging.Printers.ColoredConsolePrinter.html", + "title": "Class ColoredConsolePrinter", + "keywords": "Class ColoredConsolePrinter Prints a pretty message to the console. Inheritance Object LogPrinter ColoredConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColoredConsolePrinter : LogPrinter Properties | Improve this Doc View Source Color The color to print messages as. Declaration public ConsoleColor Color { get; set; } Property Value Type Description ConsoleColor the color to print this message as | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter to apply to this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the console window. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Config.Stores.Converters.ListConverter-2.html": { - "href": "api/IPA.Config.Stores.Converters.ListConverter-2.html", - "title": "Class ListConverter", - "keywords": "Class ListConverter A ListConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter < List > CollectionConverter > ListConverter ListConverter Implements IValueConverter Inherited Members ListConverter.Create(Int32, Object) CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(List, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(List, Object) ValueConverter>.ToValue(List, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class ListConverter : ListConverter, IValueConverter where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TConverter the type of the converter to use for T Constructors | Improve this Doc View Source ListConverter() Creates an ListConverter using a default constructed TConverter element type. Equivalent to calling ListConverter(ValueConverter) with a default-constructed TConverter . Declaration public ListConverter() See Also ListConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also ListConverter " + "api/IPA.Logging.Logger.Level.html": { + "href": "api/IPA.Logging.Logger.Level.html", + "title": "Enum Logger.Level", + "keywords": "Enum Logger.Level An enum specifying the level of the message. Resembles Syslog. Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public enum Level : byte Fields Name Description Critical A critical error message. Debug A debug message. Error An error message. Info An informational message. None No associated level. These never get shown. Notice A notice. More significant than Info, but less than a warning. Trace A trace message. These are ignored incredibly early. Warning A warning message. Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" }, - "api/IPA.Config.Stores.Converters.ListConverter-1.html": { - "href": "api/IPA.Config.Stores.Converters.ListConverter-1.html", - "title": "Class ListConverter", - "keywords": "Class ListConverter A CollectionConverter for a List . Inheritance Object ValueConverter < List > CollectionConverter > ListConverter ListConverter Implements IValueConverter Inherited Members CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(List, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(List, Object) ValueConverter>.ToValue(List, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class ListConverter : CollectionConverter>, IValueConverter Type Parameters Name Description T the element type of the List Constructors | Improve this Doc View Source ListConverter() Creates an ListConverter using the default converter for T . Declaration public ListConverter() See Also CollectionConverter() | Improve this Doc View Source ListConverter(ValueConverter) Creates an ListConverter using the specified underlying converter for values. Declaration public ListConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the underlying ValueConverter to use for the values Methods | Improve this Doc View Source Create(Int32, Object) Creates a new List for deserialization. Declaration protected override List Create(int size, object parent) Parameters Type Name Description Int32 size the size to initialize it to Object parent the object that will own the new object Returns Type Description List the new List Overrides IPA.Config.Stores.Converters.CollectionConverter>.Create(System.Int32, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " + "api/IPA.Loader.html": { + "href": "api/IPA.Loader.html", + "title": "", + "keywords": "Classes CannotRuntimeDisableException Indicates that a plugin cannot be disabled at runtime. Generally not considered an error, however. PluginInitInjector The type that handles value injecting into a plugin's initialization methods. PluginManager The manager class for all plugins. PluginMetadata A class which describes a loaded plugin. StateTransitionTransaction A class to represent a transaction for changing the state of loaded mods. Delegates PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event." }, - "api/IPA.Config.Stores.Converters.ISetConverter-2.html": { - "href": "api/IPA.Config.Stores.Converters.ISetConverter-2.html", - "title": "Class ISetConverter", - "keywords": "Class ISetConverter An ISetConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter < ISet > CollectionConverter > ISetConverter ISetConverter Implements IValueConverter Inherited Members ISetConverter.Create(Int32, Object) CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(ISet, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(ISet, Object) ValueConverter>.ToValue(ISet, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class ISetConverter : ISetConverter, IValueConverter where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TConverter the type of the converter to use for T Constructors | Improve this Doc View Source ISetConverter() Creates an ISetConverter using a default constructed TConverter element type. Equivalent to calling ISetConverter(ValueConverter) with a default-constructed TConverter . Declaration public ISetConverter() See Also ISetConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also ISetConverter " + "api/IPA.Loader.StateTransitionTransaction.html": { + "href": "api/IPA.Loader.StateTransitionTransaction.html", + "title": "Class StateTransitionTransaction", + "keywords": "Class StateTransitionTransaction A class to represent a transaction for changing the state of loaded mods. Inheritance Object StateTransitionTransaction Implements IDisposable Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public sealed class StateTransitionTransaction : IDisposable Properties | Improve this Doc View Source DisabledPlugins Gets a list of plugins that are disabled according to this transaction's current state. Declaration public IEnumerable DisabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > Exceptions Type Condition ObjectDisposedException if this object has been disposed | Improve this Doc View Source EnabledPlugins Gets a list of plugins that are enabled according to this transaction's current state. Declaration public IEnumerable EnabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > Exceptions Type Condition ObjectDisposedException if this object has been disposed | Improve this Doc View Source WillNeedRestart Gets whether or not a game restart will be necessary to fully apply this transaction. Declaration public bool WillNeedRestart { get; } Property Value Type Description Boolean true if any mod who's state is changed cannot be changed at runtime, false otherwise Exceptions Type Condition ObjectDisposedException if this object has been disposed Methods | Improve this Doc View Source Commit() Commits this transaction to actual state, enabling and disabling plugins as necessary. Declaration public Task Commit() Returns Type Description Task a Task which completes whenever all disables complete Remarks After this completes, this transaction will be disposed. The Task that is returned will error if any of the mods being disabled error. It is up to the caller to handle these in a sane way, like logging them. If nothing else, do something like this: // get your transaction... var complete = transaction.Commit(); await complete.ContinueWith(t => { if (t.IsFaulted) Logger.log.Error($\"Error disabling plugins: {t.Exception}\"); }); If you are running in a coroutine, you can use WaitForTask(Task) instead of await . If you are running on the Unity main thread, this will block until all enabling is done, and will return a task representing the disables. Otherwise, the task returned represents both, and will not complete until Unity has done (possibly) several updates, depending on the number of plugins being disabled, and the time they take. Exceptions Type Condition ObjectDisposedException if this object has been disposed InvalidOperationException if the plugins' state no longer matches this transaction's original state | Improve this Doc View Source Disable(PluginMetadata, Boolean) Disables a plugin in this transaction. Declaration public bool Disable(PluginMetadata meta, bool autoDependents = true) Parameters Type Name Description PluginMetadata meta the plugin to disable Boolean autoDependents whether or not to automatically disable all dependents of the plugin Returns Type Description Boolean true if the transaction's state was changed, false otherwise Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable See Also Disable(PluginMetadata, out IEnumerable, Boolean) | Improve this Doc View Source Disable(PluginMetadata, out IEnumerable, Boolean) Disables a plugin in this transaction. Declaration public bool Disable(PluginMetadata meta, out IEnumerable enabledDependents, bool autoDependents = false) Parameters Type Name Description PluginMetadata meta the plugin to disable IEnumerable < PluginMetadata > enabledDependents null if successful, otherwise a set of plugins that need to be disabled first Boolean autoDependents whether or not to automatically disable all dependents of the plugin Returns Type Description Boolean true if the transaction's state was changed, false otherwise Remarks enabledDependents will only be set when autoDependents is false . Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable | Improve this Doc View Source Dispose() Disposes and discards this transaction without committing it. Declaration public void Dispose() | Improve this Doc View Source Enable(PluginMetadata, Boolean) Enables a plugin in this transaction. Declaration public bool Enable(PluginMetadata meta, bool autoDeps = true) Parameters Type Name Description PluginMetadata meta the plugin to enable Boolean autoDeps whether or not to automatically enable all dependencies of the plugin Returns Type Description Boolean true if the transaction's state was changed, false otherwise Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable See Also Enable(PluginMetadata, out IEnumerable, Boolean) | Improve this Doc View Source Enable(PluginMetadata, out IEnumerable, Boolean) Enables a plugin in this transaction. Declaration public bool Enable(PluginMetadata meta, out IEnumerable disabledDeps, bool autoDeps = false) Parameters Type Name Description PluginMetadata meta the plugin to enable IEnumerable < PluginMetadata > disabledDeps null if successful, otherwise a set of plugins that need to be enabled first Boolean autoDeps whether or not to automatically enable all dependencies Returns Type Description Boolean true if the transaction's state was changed, false otherwise Remarks disabledDeps will only be set when autoDeps is false . Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable | Improve this Doc View Source IsDisabled(PluginMetadata) Checks if a plugin is disabled according to this transaction's current state. Declaration public bool IsDisabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is disabled, false otherwise Remarks This should be roughly equivalent to DisabledPlugins.Contains(meta) , but more performant. This should also always return the inverse of IsEnabled(PluginMetadata) for valid plugins. Exceptions Type Condition ObjectDisposedException if this object has been disposed See Also DisabledPlugins IsEnabled(PluginMetadata) | Improve this Doc View Source IsEnabled(PluginMetadata) Checks if a plugin is enabled according to this transaction's current state. Declaration public bool IsEnabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is enabled, false otherwise Remarks This should be roughly equivalent to EnabledPlugins.Contains(meta) , but more performant. This should also always return the inverse of IsDisabled(PluginMetadata) for valid plugins. Exceptions Type Condition ObjectDisposedException if this object has been disposed See Also EnabledPlugins IsDisabled(PluginMetadata) Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Config.Stores.Converters.ISetConverter-1.html": { - "href": "api/IPA.Config.Stores.Converters.ISetConverter-1.html", - "title": "Class ISetConverter", - "keywords": "Class ISetConverter A CollectionConverter for an ISet , creating a HashSet when deserializing. Inheritance Object ValueConverter < ISet > CollectionConverter > ISetConverter ISetConverter Implements IValueConverter Inherited Members CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(ISet, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(ISet, Object) ValueConverter>.ToValue(ISet, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class ISetConverter : CollectionConverter>, IValueConverter Type Parameters Name Description T the element type of the ISet Constructors | Improve this Doc View Source ISetConverter() Creates an ISetConverter using the default converter for T . Declaration public ISetConverter() See Also CollectionConverter() | Improve this Doc View Source ISetConverter(ValueConverter) Creates an ISetConverter using the specified underlying converter for values. Declaration public ISetConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the underlying ValueConverter to use for the values Methods | Improve this Doc View Source Create(Int32, Object) Creates a new ISet (a HashSet ) for deserialization. Declaration protected override ISet Create(int size, object parent) Parameters Type Name Description Int32 size the size to initialize it to Object parent the object that will own the new object Returns Type Description ISet the new ISet Overrides IPA.Config.Stores.Converters.CollectionConverter>.Create(System.Int32, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " + "api/IPA.Loader.PluginMetadata.html": { + "href": "api/IPA.Loader.PluginMetadata.html", + "title": "Class PluginMetadata", + "keywords": "Class PluginMetadata A class which describes a loaded plugin. Inheritance Object PluginMetadata Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public class PluginMetadata Properties | Improve this Doc View Source Assembly The assembly the plugin was loaded from. Declaration public Assembly Assembly { get; } Property Value Type Description Assembly the loaded Assembly that contains the plugin main type | Improve this Doc View Source Features The features this plugin requests. Declaration public IReadOnlyList Features { get; } Property Value Type Description IReadOnlyList < Feature > the list of features requested by the plugin | Improve this Doc View Source File The file the plugin was loaded from. Declaration public FileInfo File { get; } Property Value Type Description FileInfo the file the plugin was loaded from | Improve this Doc View Source Id The BeatMods ID of the plugin, or null if it doesn't have one. Declaration public string Id { get; } Property Value Type Description String the updater ID of the plugin | Improve this Doc View Source IsBare Whether or not this metadata object represents a bare manifest. Declaration public bool IsBare { get; } Property Value Type Description Boolean true if it is bare, false otherwise | Improve this Doc View Source Name The human readable name of the plugin. Declaration public string Name { get; } Property Value Type Description String the name of the plugin | Improve this Doc View Source PluginType The TypeDefinition for the main type of the plugin. Declaration public TypeDefinition PluginType { get; } Property Value Type Description Mono.Cecil.TypeDefinition the Cecil definition for the plugin main type | Improve this Doc View Source RuntimeOptions The RuntimeOptions that the plugin specified in its PluginAttribute . Declaration public RuntimeOptions RuntimeOptions { get; } Property Value Type Description RuntimeOptions | Improve this Doc View Source Version The version of the plugin. Declaration public Version Version { get; } Property Value Type Description SemVer.Version the version of the plugin Methods | Improve this Doc View Source ToString() Gets all of the metadata as a readable string. Declaration public override string ToString() Returns Type Description String the readable printable metadata string Overrides Object.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Config.Stores.Converters.Converter-1.html": { - "href": "api/IPA.Config.Stores.Converters.Converter-1.html", - "title": "Class Converter", - "keywords": "Class Converter Provides generic utilities for converters for certain types. Inheritance Object Converter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public static class Converter Type Parameters Name Description T the type of the ValueConverter that this works on Properties | Improve this Doc View Source Default Gets the default ValueConverter for the current type. Declaration public static ValueConverter Default { get; } Property Value Type Description ValueConverter " + "api/IPA.Loader.Features.Feature.html": { + "href": "api/IPA.Loader.Features.Feature.html", + "title": "Class Feature", + "keywords": "Class Feature The root interface for a mod Feature. Inheritance Object Feature Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader.Features Assembly : IPA.Loader.dll Syntax public abstract class Feature Remarks Avoid storing any data in any subclasses. If you do, it may result in a failure to load the feature. Properties | Improve this Doc View Source InvalidMessage The message to be logged when the feature is not valid for a plugin. This should also be set whenever either BeforeLoad(PluginMetadata) or BeforeInit(PluginMetadata) returns false. Declaration public virtual string InvalidMessage { get; protected set; } Property Value Type Description String the message to show when the feature is marked invalid | Improve this Doc View Source StoreOnPlugin Defines whether or not this feature will be accessible from the plugin metadata once loaded. Declaration protected virtual bool StoreOnPlugin { get; } Property Value Type Description Boolean true if this Feature will be stored on the plugin metadata, false otherwise Methods | Improve this Doc View Source AfterInit(PluginMetadata) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin that was just initialized | Improve this Doc View Source AfterInit(PluginMetadata, Object) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginMetadata plugin, object pluginInstance) Parameters Type Name Description PluginMetadata plugin the plugin that was just initialized Object pluginInstance the instance of the plugin being initialized | Improve this Doc View Source BeforeInit(PluginMetadata) Called before a plugin's Init method is called. This will not be called if there is no Init method. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeInit(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin to be initialized Returns Type Description Boolean whether or not to call the Init method | Improve this Doc View Source BeforeLoad(PluginMetadata) Called before a plugin is loaded. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeLoad(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin about to be loaded Returns Type Description Boolean whether or not the plugin should be loaded Remarks The assembly will still be loaded, but the plugin will not be constructed if this returns false . Any features it defines, for example, will still be loaded. | Improve this Doc View Source Evaluate() Evaluates the Feature for use in conditional meta-Features. This should be re-calculated on every call, unless it can be proven to not change. This will be called on every feature that returns true from Initialize(PluginMetadata, String[]) Declaration public virtual bool Evaluate() Returns Type Description Boolean the truthiness of the Feature. | Improve this Doc View Source Initialize(PluginMetadata, String[]) Initializes the feature with the parameters provided in the definition. Note: When no parenthesis are provided, parameters is an empty array. Declaration public abstract bool Initialize(PluginMetadata meta, string[] parameters) Parameters Type Name Description PluginMetadata meta the metadata of the plugin that is being prepared String [] parameters the parameters passed to the feature definition, or null Returns Type Description Boolean true if the feature is valid for the plugin, false otherwise Remarks This gets called BEFORE your Init method. Returning false does not prevent the plugin from being loaded. It simply prevents the feature from being used. | Improve this Doc View Source RequireLoaded(PluginMetadata) Ensures a plugin's assembly is loaded. Do not use unless you need to. Declaration protected void RequireLoaded(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin to ensure is loaded. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Config.Stores.Converters.CollectionConverter-3.html": { - "href": "api/IPA.Config.Stores.Converters.CollectionConverter-3.html", - "title": "Class CollectionConverter", - "keywords": "Class CollectionConverter A CollectionConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter CollectionConverter CollectionConverter Implements IValueConverter Inherited Members CollectionConverter.BaseConverter CollectionConverter.Create(Int32, Object) CollectionConverter.PopulateFromValue(TCollection, List, Object) CollectionConverter.FromValue(Value, Object) CollectionConverter.ToValue(TCollection, Object) ValueConverter.ToValue(TCollection, Object) ValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class CollectionConverter : CollectionConverter, IValueConverter where TCollection : ICollection where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TCollection the type of the colleciton TConverter the type of the converter to use for T Constructors | Improve this Doc View Source CollectionConverter() Creates a CollectionConverter using a default constructed TConverter element type. Equivalent to calling CollectionConverter(ValueConverter) with a default-constructed TConverter . Declaration public CollectionConverter() See Also CollectionConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " + "api/IPA.Loader.CannotRuntimeDisableException.html": { + "href": "api/IPA.Loader.CannotRuntimeDisableException.html", + "title": "Class CannotRuntimeDisableException", + "keywords": "Class CannotRuntimeDisableException Indicates that a plugin cannot be disabled at runtime. Generally not considered an error, however. Inheritance Object Exception CannotRuntimeDisableException Implements ISerializable _Exception Inherited Members Exception.GetBaseException() Exception.ToString() Exception.GetObjectData(SerializationInfo, StreamingContext) Exception.GetType() Exception.Message Exception.Data Exception.InnerException Exception.TargetSite Exception.StackTrace Exception.HelpLink Exception.Source Exception.HResult Exception.SerializeObjectState Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax [Serializable] public class CannotRuntimeDisableException : Exception, ISerializable, _Exception Constructors | Improve this Doc View Source CannotRuntimeDisableException(PluginMetadata) Creates an exception for the given plugin metadata. Declaration public CannotRuntimeDisableException(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin that cannot be disabled | Improve this Doc View Source CannotRuntimeDisableException(SerializationInfo, StreamingContext) Creates an exception from a serialization context. Not currently implemented. Declaration protected CannotRuntimeDisableException(SerializationInfo serializationInfo, StreamingContext streamingContext) Parameters Type Name Description SerializationInfo serializationInfo StreamingContext streamingContext Exceptions Type Condition NotImplementedException Properties | Improve this Doc View Source Plugin The plugin that cannot be disabled at runtime. Declaration public PluginMetadata Plugin { get; } Property Value Type Description PluginMetadata Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Config.Stores.Converters.CollectionConverter-2.html": { - "href": "api/IPA.Config.Stores.Converters.CollectionConverter-2.html", - "title": "Class CollectionConverter", - "keywords": "Class CollectionConverter A base class for all ICollection type converters, providing most of the functionality. Inheritance Object ValueConverter CollectionConverter CollectionConverter IListConverter ISetConverter ListConverter Implements IValueConverter Inherited Members ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class CollectionConverter : ValueConverter, IValueConverter where TCollection : ICollection Type Parameters Name Description T the type of the items in the collection TCollection the instantiated type of collection Constructors | Improve this Doc View Source CollectionConverter() Creates a CollectionConverter using the default converter for the element type. Equivalent to calling CollectionConverter(ValueConverter) with Default . Declaration public CollectionConverter() See Also CollectionConverter(ValueConverter) | Improve this Doc View Source CollectionConverter(ValueConverter) Creates a CollectionConverter using the specified underlying converter. Declaration public CollectionConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the ValueConverter to use to convert the values Properties | Improve this Doc View Source BaseConverter Gets the converter for the collection's value type. Declaration protected ValueConverter BaseConverter { get; } Property Value Type Description ValueConverter Methods | Improve this Doc View Source Create(Int32, Object) Creates a collection of type TCollection using the size and parent . Declaration protected virtual TCollection Create(int size, object parent) Parameters Type Name Description Int32 size the initial size of the collecion Object parent the object that will own the new collection Returns Type Description TCollection a new instance of TCollection See Also FromValue ( Value , Object ) | Improve this Doc View Source FromValue(Value, Object) Deserializes a List in value into a new TCollection owned by parent . Declaration public override TCollection FromValue(Value value, object parent) Parameters Type Name Description Value value the List to convert to a TCollection Object parent the object that will own the resulting TCollection Returns Type Description TCollection a new TCollection holding the deserialized content of value Overrides IPA.Config.Stores.ValueConverter.FromValue(IPA.Config.Data.Value, System.Object) See Also FromValue ( Value , Object ) | Improve this Doc View Source PopulateFromValue(TCollection, List, Object) Populates the colleciton col with the deserialized values from list with the parent parent . Declaration protected void PopulateFromValue(TCollection col, List list, object parent) Parameters Type Name Description TCollection col the collection to populate List list the values to populate it with Object parent the object that will own the new objects See Also FromValue ( Value , Object ) | Improve this Doc View Source ToValue(TCollection, Object) Serializes a TCollection into a List . Declaration public override Value ToValue(TCollection obj, object parent) Parameters Type Name Description TCollection obj the TCollection to serialize Object parent the object owning obj Returns Type Description Value the List that obj was serialized into Overrides IPA.Config.Stores.ValueConverter.ToValue(TCollection, System.Object) See Also ToValue (T, Object ) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Config.Stores.html": { + "href": "api/IPA.Config.Stores.html", + "title": "", + "keywords": "Classes GeneratedExtension A class providing an extension for Config to make it easy to use generated config stores. ValueConverter A strongly-typed IValueConverter . Interfaces IValueConverter The base interface for a value converter for use by objects generated by Generated(Config, Boolean) ." }, - "api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html": { - "href": "api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html", - "title": "Class SerializedNameAttribute", - "keywords": "Class SerializedNameAttribute Specifies a name for the serialized field or property in an object being wrapped by Generated(Config, Boolean) that is different from the member name itself. Inheritance Object Attribute SerializedNameAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Attributes Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class SerializedNameAttribute : Attribute, _Attribute Examples When serializing the following object, we might get the JSON that follows. public class PluginConfig { public virtual bool BooleanField { get; set; } = true; } { \"BooleanField\": true } However, if we were to add a SerializedNameAttribute to that field, we would get the following. public class PluginConfig { [SerializedName(\"bool\")] public virtual bool BooleanField { get; set; } = true; } { \"bool\": true } Constructors | Improve this Doc View Source SerializedNameAttribute(String) Creates a new SerializedNameAttribute with the given Name . Declaration public SerializedNameAttribute(string name) Parameters Type Name Description String name the value to assign to Name Properties | Improve this Doc View Source Name Gets the name to replace the member name with. Declaration public string Name { get; } Property Value Type Description String Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Config.Stores.ValueConverter-1.html": { + "href": "api/IPA.Config.Stores.ValueConverter-1.html", + "title": "Class ValueConverter", + "keywords": "Class ValueConverter A strongly-typed IValueConverter . Inheritance Object ValueConverter CollectionConverter CustomObjectConverter NullableConverter AlmostVersionConverter Implements IValueConverter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores Assembly : IPA.Loader.dll Syntax public abstract class ValueConverter : IValueConverter Type Parameters Name Description T the type of object to handle Methods | Improve this Doc View Source FromValue(Value, Object) Converts the given Value to the object type handled by this converter. Declaration public abstract T FromValue(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the object that will own the result Returns Type Description T the deserialized object See Also FromValue ( Value , Object ) | Improve this Doc View Source ToValue(T, Object) Converts the given object to a Value . Declaration public abstract Value ToValue(T obj, object parent) Parameters Type Name Description T obj the object to convert Object parent the owning object of obj Returns Type Description Value a representation of obj as a Value structure See Also ToValue ( Object , Object ) Explicit Interface Implementations | Improve this Doc View Source IValueConverter.FromValue(Value, Object) Declaration object IValueConverter.FromValue(Value value, object parent) Parameters Type Name Description Value value Object parent Returns Type Description Object | Improve this Doc View Source IValueConverter.ToValue(Object, Object) Declaration Value IValueConverter.ToValue(object obj, object parent) Parameters Type Name Description Object obj Object parent Returns Type Description Value | Improve this Doc View Source IValueConverter.Type Declaration Type IValueConverter.Type { get; } Returns Type Description Type Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also IValueConverter" + }, + "api/IPA.Config.Stores.Converters.html": { + "href": "api/IPA.Config.Stores.Converters.html", + "title": "", + "keywords": "Classes CollectionConverter A base class for all ICollection type converters, providing most of the functionality. CollectionConverter A CollectionConverter which default constructs a converter for use as the value converter. Converter Provides utility functions for custom converters. Converter Provides generic utilities for converters for certain types. CustomObjectConverter A ValueConverter for objects normally serialized to config via Generated(Config, Boolean) . IListConverter A CollectionConverter for an IList , creating a List when deserializing. IListConverter An IListConverter which default constructs a converter for use as the value converter. ISetConverter A CollectionConverter for an ISet , creating a HashSet when deserializing. ISetConverter An ISetConverter which default constructs a converter for use as the value converter. ListConverter A CollectionConverter for a List . ListConverter A ListConverter which default constructs a converter for use as the value converter. NullableConverter A converter for a Nullable . NullableConverter A converter for a Nullable that default-constructs a converter of type TConverter to use as the underlying converter. Use this in the UseConverterAttribute ." }, "api/IPA.Config.Stores.Attributes.NonNullableAttribute.html": { "href": "api/IPA.Config.Stores.Attributes.NonNullableAttribute.html", @@ -54,6 +59,26 @@ "title": "Interface IModPrefs", "keywords": "Interface IModPrefs Allows to get and set preferences for your mod. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [Obsolete(\"Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.\")] public interface IModPrefs Methods | Improve this Doc View Source GetBool(String, String, Boolean, Boolean) Gets a bool from the ini. Declaration bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Boolean | Improve this Doc View Source GetFloat(String, String, Single, Boolean) Gets a float from the ini. Declaration float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Single defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Single | Improve this Doc View Source GetInt(String, String, Int32, Boolean) Gets an int from the ini. Declaration int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Int32 | Improve this Doc View Source GetString(String, String, String, Boolean) Gets a string from the ini. Declaration string GetString(string section, string name, string defaultValue = \"\", bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. String defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description String | Improve this Doc View Source HasKey(String, String) Checks whether or not a key exists in the ini. Declaration bool HasKey(string section, string name) Parameters Type Name Description String section Section of the key. String name Name of the key. Returns Type Description Boolean | Improve this Doc View Source SetBool(String, String, Boolean) Sets a bool in the ini. Declaration void SetBool(string section, string name, bool value) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean value Value that should be written. | Improve this Doc View Source SetFloat(String, String, Single) Sets a float in the ini. Declaration void SetFloat(string section, string name, float value) Parameters Type Name Description String section Section of the key. String name Name of the key. Single value Value that should be written. | Improve this Doc View Source SetInt(String, String, Int32) Sets an int in the ini. Declaration void SetInt(string section, string name, int value) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 value Value that should be written. | Improve this Doc View Source SetString(String, String, String) Sets a string in the ini. Declaration void SetString(string section, string name, string value) Parameters Type Name Description String section Section of the key. String name Name of the key. String value Value that should be written. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, + "api/IPA.Config.IConfigStore.html": { + "href": "api/IPA.Config.IConfigStore.html", + "title": "Interface IConfigStore", + "keywords": "Interface IConfigStore A storage for a config structure. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public interface IConfigStore Properties | Improve this Doc View Source SyncObject A synchronization object for the save thread to wait on for changes. It should be signaled whenever the internal state of the object is changed. The writer will never signal this handle. Declaration WaitHandle SyncObject { get; } Property Value Type Description WaitHandle | Improve this Doc View Source WriteSyncObject A synchronization object for the load thread and accessors to maintain safe synchronization. Any readers should take a read lock with EnterReadLock() or EnterUpgradeableReadLock() , and any writers should take a write lock with EnterWriteLock() . Declaration ReaderWriterLockSlim WriteSyncObject { get; } Property Value Type Description ReaderWriterLockSlim Remarks Read and write are read and write to this object , not to the file on disk. Methods | Improve this Doc View Source ReadFrom(ConfigProvider) Reads the config structure from the given IConfigProvider into the current IConfigStore . Declaration void ReadFrom(ConfigProvider provider) Parameters Type Name Description ConfigProvider provider the provider to read from Remarks The calling code will have entered a write lock on WriteSyncObject when this is called. | Improve this Doc View Source WriteTo(ConfigProvider) Writes the config structure stored by the current IConfigStore to the given IConfigProvider . Declaration void WriteTo(ConfigProvider provider) Parameters Type Name Description ConfigProvider provider the provider to write to Remarks The calling code will have entered a read lock on WriteSyncObject when this is called. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.Data.html": { + "href": "api/IPA.Config.Data.html", + "title": "", + "keywords": "Classes Boolean A Value representing a boolean value. FloatingPoint A Value representing a floating point value. This may hold a Decimal 's worth of data. Integer A Value representing an integer. This may hold a Int64 's worth of data. List A list of Value s for serialization by an IConfigProvider . Use List() or From(IEnumerable) to create. Map A ordered map of String to Value for serialization by an IConfigProvider . Use Map() or From(IDictionary) to create. Text A Value representing a piece of text. The only reason this is not named String is so that it doesn't conflict with String . Value A base value type for config data abstract representations, to be serialized with an IConfigProvider . If a Value is null , then that represents just that: a null in whatever serialization is being used. Also contains factory functions for all derived types." + }, + "api/IPA.Config.Data.Text.html": { + "href": "api/IPA.Config.Data.Text.html", + "title": "Class Text", + "keywords": "Class Text A Value representing a piece of text. The only reason this is not named String is so that it doesn't conflict with String . Inheritance Object Value Text Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class Text : Value Properties | Improve this Doc View Source Value The actual value of this Text object. Declaration public string Value { get; set; } Property Value Type Description String Methods | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a quoted, unescaped string form of Value Overrides Value.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.Data.List.html": { + "href": "api/IPA.Config.Data.List.html", + "title": "Class List", + "keywords": "Class List A list of Value s for serialization by an IConfigProvider . Use List() or From(IEnumerable) to create. Inheritance Object Value List Implements IList < Value > ICollection < Value > IEnumerable < Value > IEnumerable Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class List : Value, IList, ICollection, IEnumerable, IEnumerable Properties | Improve this Doc View Source Count Gets the number of elements in the List . Declaration public int Count { get; } Property Value Type Description Int32 See Also Count | Improve this Doc View Source Item[Int32] Gets the value at the given index in this List . Declaration public Value this[int index] { get; set; } Parameters Type Name Description Int32 index the index to retrieve the Value at Property Value Type Description Value the Value at index See Also Item [ Int32 ] Methods | Improve this Doc View Source Add(Value) Adds a Value to the end of this List . Declaration public void Add(Value item) Parameters Type Name Description Value item the Value to add See Also Add (T) | Improve this Doc View Source AddRange(IEnumerable) Adds a range of Value s to the end of this List . Declaration public void AddRange(IEnumerable vals) Parameters Type Name Description IEnumerable < Value > vals the range of Value s to add | Improve this Doc View Source Clear() Clears the List . Declaration public void Clear() See Also Clear () | Improve this Doc View Source Contains(Value) Checks if the List contains a certian item. Declaration public bool Contains(Value item) Parameters Type Name Description Value item the Value to check for Returns Type Description Boolean true if the item was founc, otherwise false See Also Contains (T) | Improve this Doc View Source CopyTo(Value[], Int32) Copies the Value s in the List to the Array in array . Declaration public void CopyTo(Value[] array, int arrayIndex) Parameters Type Name Description Value [] array the Array to copy to Int32 arrayIndex the starting index to copy to See Also CopyTo (T[], Int32 ) | Improve this Doc View Source GetEnumerator() Gets an enumerator to enumerate the List . Declaration public IEnumerator GetEnumerator() Returns Type Description IEnumerator < Value > an IEnumerator for this List See Also GetEnumerator () | Improve this Doc View Source IndexOf(Value) Gets the index that a given Value is in the List . Declaration public int IndexOf(Value item) Parameters Type Name Description Value item the Value to search for Returns Type Description Int32 the index that the item was at, or -1. See Also IndexOf (T) | Improve this Doc View Source Insert(Int32, Value) Inserts a Value at an index. Declaration public void Insert(int index, Value item) Parameters Type Name Description Int32 index the index to insert at Value item the Value to insert See Also Insert ( Int32 , T) | Improve this Doc View Source Remove(Value) Removes a Value from the List . Declaration public bool Remove(Value item) Parameters Type Name Description Value item the Value to remove Returns Type Description Boolean true if the item was removed, false otherwise See Also Remove (T) | Improve this Doc View Source RemoveAt(Int32) Removes a Value at an index. Declaration public void RemoveAt(int index) Parameters Type Name Description Int32 index the index to remove a Value at See Also RemoveAt ( Int32 ) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a comma-seperated list of the result of ToString() wrapped in square brackets Overrides Value.ToString() Explicit Interface Implementations | Improve this Doc View Source ICollection.IsReadOnly Declaration bool ICollection.IsReadOnly { get; } Returns Type Description Boolean | Improve this Doc View Source IEnumerable.GetEnumerator() Declaration IEnumerator IEnumerable.GetEnumerator() Returns Type Description IEnumerator Implements System.Collections.Generic.IList System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable Extension Methods EnumerableExtensions.Prepend(IEnumerable, T) EnumerableExtensions.Append(IEnumerable, T) EnumerableExtensions.NonNull(IEnumerable) EnumerableExtensions.NonNull(IEnumerable, Func) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, "api/IPA.Config.Data.FloatingPoint.html": { "href": "api/IPA.Config.Data.FloatingPoint.html", "title": "Class FloatingPoint", @@ -64,45 +89,20 @@ "title": "Class ConfigProvider", "keywords": "Class ConfigProvider A wrapper for an IConfigProvider and the FileInfo to use with it. Inheritance Object ConfigProvider Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public class ConfigProvider Methods | Improve this Doc View Source Load() Loads a Value from disk in whatever format this provider provides and returns it. Declaration public Value Load() Returns Type Description Value the Value loaded | Improve this Doc View Source Store(Value) Stores the Value given to disk in the format specified. Declaration public void Store(Value value) Parameters Type Name Description Value value the Value to store Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Config.Config.PreferAttribute.html": { - "href": "api/IPA.Config.Config.PreferAttribute.html", - "title": "Class Config.PreferAttribute", - "keywords": "Class Config.PreferAttribute Specifies that a particular parameter is preferred to use a particular IConfigProvider . If it is not available, also specifies backups. If none are available, the default is used. Inheritance Object Attribute Config.PreferAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Parameter)] public sealed class PreferAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source PreferAttribute(String[]) Constructs the attribute with a specific preference list. Each entry is the extension without a '.' Declaration public PreferAttribute(params string[] preference) Parameters Type Name Description String [] preference The preferences in order of preference. Properties | Improve this Doc View Source PreferenceOrder The order of preference for the config type. Declaration public string[] PreferenceOrder { get; } Property Value Type Description String [] the list of config extensions in order of preference Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/BSIPA_ModList.UI.ViewControllers.html": { - "href": "api/BSIPA_ModList.UI.ViewControllers.html", - "title": "", - "keywords": "Classes MarkdownView A UI component that renders CommonMark Markdown in-game." - }, - "api/IPA.Config.Stores.Attributes.html": { - "href": "api/IPA.Config.Stores.Attributes.html", - "title": "", - "keywords": "Classes IgnoreAttribute Causes a field or property in an object being wrapped by Generated(Config, Boolean) to be ignored during serialization and deserialization. NonNullableAttribute Indicates that a field or property in an object being wrapped by Generated(Config, Boolean) that would otherwise be nullable (i.e. a reference type or a Nullable type) should never be null, and the member will be ignored if the deserialized value is null . SerializedNameAttribute Specifies a name for the serialized field or property in an object being wrapped by Generated(Config, Boolean) that is different from the member name itself. UseConverterAttribute Indicates that a given field or property in an object being wrapped by Generated(Config, Boolean) should be serialized and deserialized using the provided converter instead of the default mechanism." - }, - "api/IPA.Config.ModPrefs.html": { - "href": "api/IPA.Config.ModPrefs.html", - "title": "Class ModPrefs", - "keywords": "Class ModPrefs Allows to get and set preferences for your mod. Inheritance Object ModPrefs Implements IModPrefs Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [Obsolete(\"Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.\")] public class ModPrefs : IModPrefs Constructors | Improve this Doc View Source ModPrefs(PluginMetadata) Constructs a ModPrefs object for the provide plugin. Declaration public ModPrefs(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin to get the preferences file for Methods | Improve this Doc View Source GetBool(String, String, Boolean, Boolean) Gets a bool from the ini. Declaration public static bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Boolean | Improve this Doc View Source GetFloat(String, String, Single, Boolean) Gets a float from the ini. Declaration public static float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Single defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Single | Improve this Doc View Source GetInt(String, String, Int32, Boolean) Gets an int from the ini. Declaration public static int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Int32 | Improve this Doc View Source GetString(String, String, String, Boolean) Gets a string from the ini. Declaration public static string GetString(string section, string name, string defaultValue = \"\", bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. String defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description String | Improve this Doc View Source HasKey(String, String) Checks whether or not a key exists in the ini. Declaration public static bool HasKey(string section, string name) Parameters Type Name Description String section Section of the key. String name Name of the key. Returns Type Description Boolean | Improve this Doc View Source SetBool(String, String, Boolean) Sets a bool in the ini. Declaration public static void SetBool(string section, string name, bool value) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean value Value that should be written. | Improve this Doc View Source SetFloat(String, String, Single) Sets a float in the ini. Declaration public static void SetFloat(string section, string name, float value) Parameters Type Name Description String section Section of the key. String name Name of the key. Single value Value that should be written. | Improve this Doc View Source SetInt(String, String, Int32) Sets an int in the ini. Declaration public static void SetInt(string section, string name, int value) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 value Value that should be written. | Improve this Doc View Source SetString(String, String, String) Sets a string in the ini. Declaration public static void SetString(string section, string name, string value) Parameters Type Name Description String section Section of the key. String name Name of the key. String value Value that should be written. Explicit Interface Implementations | Improve this Doc View Source IModPrefs.GetBool(String, String, Boolean, Boolean) Declaration bool IModPrefs.GetBool(string section, string name, bool defaultValue, bool autoSave) Parameters Type Name Description String section String name Boolean defaultValue Boolean autoSave Returns Type Description Boolean | Improve this Doc View Source IModPrefs.GetFloat(String, String, Single, Boolean) Declaration float IModPrefs.GetFloat(string section, string name, float defaultValue, bool autoSave) Parameters Type Name Description String section String name Single defaultValue Boolean autoSave Returns Type Description Single | Improve this Doc View Source IModPrefs.GetInt(String, String, Int32, Boolean) Declaration int IModPrefs.GetInt(string section, string name, int defaultValue, bool autoSave) Parameters Type Name Description String section String name Int32 defaultValue Boolean autoSave Returns Type Description Int32 | Improve this Doc View Source IModPrefs.GetString(String, String, String, Boolean) Declaration string IModPrefs.GetString(string section, string name, string defaultValue, bool autoSave) Parameters Type Name Description String section String name String defaultValue Boolean autoSave Returns Type Description String | Improve this Doc View Source IModPrefs.HasKey(String, String) Declaration bool IModPrefs.HasKey(string section, string name) Parameters Type Name Description String section String name Returns Type Description Boolean | Improve this Doc View Source IModPrefs.SetBool(String, String, Boolean) Declaration void IModPrefs.SetBool(string section, string name, bool value) Parameters Type Name Description String section String name Boolean value | Improve this Doc View Source IModPrefs.SetFloat(String, String, Single) Declaration void IModPrefs.SetFloat(string section, string name, float value) Parameters Type Name Description String section String name Single value | Improve this Doc View Source IModPrefs.SetInt(String, String, Int32) Declaration void IModPrefs.SetInt(string section, string name, int value) Parameters Type Name Description String section String name Int32 value | Improve this Doc View Source IModPrefs.SetString(String, String, String) Declaration void IModPrefs.SetString(string section, string name, string value) Parameters Type Name Description String section String name String value Implements IModPrefs Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Config.Data.Map.html": { - "href": "api/IPA.Config.Data.Map.html", - "title": "Class Map", - "keywords": "Class Map A ordered map of String to Value for serialization by an IConfigProvider . Use Map() or From(IDictionary) to create. Inheritance Object Value Map Implements IDictionary < String , Value > ICollection < KeyValuePair < String , Value >> IEnumerable < KeyValuePair < String , Value >> IEnumerable Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class Map : Value, IDictionary, ICollection>, IEnumerable>, IEnumerable Properties | Improve this Doc View Source Count Gets the number of key-value pairs in this Map . Declaration public int Count { get; } Property Value Type Description Int32 See Also Count | Improve this Doc View Source Item[String] Accesses the Value at key in the map. Declaration public Value this[string key] { get; set; } Parameters Type Name Description String key the key to get the value associated with Property Value Type Description Value the value associated with the key See Also Item [TKey] | Improve this Doc View Source Keys Gets a collection of the keys for the Map . Declaration public ICollection Keys { get; } Property Value Type Description ICollection < String > See Also Keys | Improve this Doc View Source Values Gets a collection of the values in the Map . Declaration public ICollection Values { get; } Property Value Type Description ICollection < Value > Remarks Unlike all other iterables given by Map , this does not guarantee that order is maintained. See Also Values Methods | Improve this Doc View Source Add(String, Value) Adds a new Value with a given key. Declaration public void Add(string key, Value value) Parameters Type Name Description String key the key to put the value at Value value the Value to add See Also Add (TKey, TValue) | Improve this Doc View Source Clear() Clears the Map of its key-value pairs. Declaration public void Clear() See Also Clear () | Improve this Doc View Source ContainsKey(String) Checks if the Map contains a given key . Declaration public bool ContainsKey(string key) Parameters Type Name Description String key the key to check for Returns Type Description Boolean true if the key exists, otherwise false See Also ContainsKey (TKey) | Improve this Doc View Source GetEnumerator() Enumerates the Map 's key-value pairs. Declaration public IEnumerator> GetEnumerator() Returns Type Description IEnumerator < KeyValuePair < String , Value >> an IEnumerator of key-value pairs in this Map See Also GetEnumerator () | Improve this Doc View Source Remove(String) Removes the object associated with a key in this Map . Declaration public bool Remove(string key) Parameters Type Name Description String key the key to remove Returns Type Description Boolean true if the key existed, false otherwise See Also Remove (TKey) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a JSON-like set of key-value pairs Overrides Value.ToString() | Improve this Doc View Source TryGetValue(String, out Value) Gets the value associated with the specified key. Declaration public bool TryGetValue(string key, out Value value) Parameters Type Name Description String key the key of the value to get Value value the target location of the retrieved object Returns Type Description Boolean true if the key was found and value set, false otherwise See Also TryGetValue (TKey, TValue) Explicit Interface Implementations | Improve this Doc View Source ICollection>.Add(KeyValuePair) Declaration void ICollection>.Add(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item | Improve this Doc View Source ICollection>.Contains(KeyValuePair) Declaration bool ICollection>.Contains(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item Returns Type Description Boolean | Improve this Doc View Source ICollection>.CopyTo(KeyValuePair[], Int32) Declaration void ICollection>.CopyTo(KeyValuePair[] array, int arrayIndex) Parameters Type Name Description KeyValuePair < String , Value >[] array Int32 arrayIndex | Improve this Doc View Source ICollection>.IsReadOnly Declaration bool ICollection>.IsReadOnly { get; } Returns Type Description Boolean | Improve this Doc View Source ICollection>.Remove(KeyValuePair) Declaration bool ICollection>.Remove(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item Returns Type Description Boolean | Improve this Doc View Source IEnumerable.GetEnumerator() Declaration IEnumerator IEnumerable.GetEnumerator() Returns Type Description IEnumerator Implements System.Collections.Generic.IDictionary System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable Extension Methods EnumerableExtensions.Prepend(IEnumerable, T) EnumerableExtensions.Append(IEnumerable, T) EnumerableExtensions.NonNull(IEnumerable, Func) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.html": { - "href": "api/IPA.html", - "title": "", - "keywords": "Classes InitAttribute Marks a method or a constructor as an inialization method. OnDisableAttribute Indicates that the target method should be called when the plugin is disabled. OnEnableAttribute Indicates that the target method should be called when the plugin is enabled. OnExitAttribute Indicates that the target method should be called when the game exits. OnStartAttribute Indicates that the target method should be called when the game starts. PluginAttribute Marks a class as being a BSIPA plugin. Enums RuntimeOptions Options that a plugin must specify to describe how it expects to be run." + "api/IPA.Utilities.FieldAccessor-2.Accessor.html": { + "href": "api/IPA.Utilities.FieldAccessor-2.Accessor.html", + "title": "Delegate FieldAccessor.Accessor", + "keywords": "Delegate FieldAccessor.Accessor A delegate for a field accessor taking a T ref and returning a U ref. Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public delegate U Accessor(ref T obj); Parameters Type Name Description T obj the object to access the field of Returns Type Description U a reference to the field's value Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Utilities.html": { - "href": "api/IPA.Utilities.html", - "title": "", - "keywords": "Classes AlmostVersion A type that wraps SemVer.Version so that the string of the version is stored when the string is not a valid SemVer.Version . AlmostVersionConverter A ValueConverter for AlmostVersion s. CriticalSection Provides utilities for managing various critical sections. EnumerableExtensions Extensions for IEnumerable that don't currently exist in System.Linq . Extensions A class providing various extension methods. FieldAccessor A type containing utilities for accessing non-public fields of objects. PropertyAccessor A type containing utilities for accessing non-public properties of an object. Ref Utilities to create Ref using type inference. Ref A class to store a reference for passing to methods which cannot take ref parameters. ReflectionUtil A utility class providing reflection helper methods. UnityGame Provides some basic utility methods and properties of Beat Saber Utils A class providing static utility functions that in any other language would just exist . Structs CriticalSection.AutoExecuteSection A struct that allows using blocks to manage an execute section. Enums AlmostVersion.StoredAs Represents a storage type of either parsed SemVer.Version object or raw String . UnityGame.Release The different types of releases of the game. Delegates FieldAccessor.Accessor A delegate for a field accessor taking a T ref and returning a U ref. PropertyAccessor.Getter A getter for a property. PropertyAccessor.Setter A setter for a property." + "api/IPA.Utilities.Extensions.html": { + "href": "api/IPA.Utilities.Extensions.html", + "title": "Class Extensions", + "keywords": "Class Extensions A class providing various extension methods. Inheritance Object Extensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Extensions Methods | Improve this Doc View Source GetDefault(Type) Gets the default value for a given Type . Declaration public static object GetDefault(this Type type) Parameters Type Name Description Type type the Type to get the default value for Returns Type Description Object the default value of type | Improve this Doc View Source IsSubPathOf(String, String) Returns true if path starts with the path baseDirPath . The comparison is case-insensitive, handles / and \\ slashes as folder separators and only matches if the base dir folder name is matched exactly (\"c:\\foobar\\file.txt\" is not a sub path of \"c:\\foo\"). Declaration public static bool IsSubPathOf(this string path, string baseDirPath) Parameters Type Name Description String path String baseDirPath Returns Type Description Boolean | Improve this Doc View Source Right(String, Int32) Gets the rightmost length characters from a string. Declaration public static string Right(this string value, int length) Parameters Type Name Description String value The string to retrieve the substring from. Int32 length The number of characters to retrieve. Returns Type Description String The substring. | Improve this Doc View Source Unwrap(Nullable) Unwraps a Nullable where T is Boolean such that if the value is null, it gives false . Declaration public static bool Unwrap(this bool? self) Parameters Type Name Description Nullable < Boolean > self the bool? to unwrap Returns Type Description Boolean the unwrapped value, or false if it was null | Improve this Doc View Source WithEnding(String, String) Returns str with the minimal concatenation of ending (starting from end) that results in satisfying .EndsWith(ending). Declaration public static string WithEnding(this string str, string ending) Parameters Type Name Description String str String ending Returns Type Description String Examples \"hel\".WithEnding(\"llo\") returns \"hello\", which is the result of \"hel\" + \"lo\"." }, - "api/IPA.Utilities.Utils.html": { - "href": "api/IPA.Utilities.Utils.html", - "title": "Class Utils", - "keywords": "Class Utils A class providing static utility functions that in any other language would just exist . Inheritance Object Utils Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Utils Properties | Improve this Doc View Source CanUseDateTimeNowSafely Whether you can safely use Now without Mono throwing a fit. Declaration public static bool CanUseDateTimeNowSafely { get; } Property Value Type Description Boolean true if you can use Now safely, false otherwise Methods | Improve this Doc View Source ByteArrayToString(Byte[]) Converts a byte array to a hex string. Declaration public static string ByteArrayToString(byte[] ba) Parameters Type Name Description Byte [] ba the byte array Returns Type Description String the hex form of the array | Improve this Doc View Source CopyAll(DirectoryInfo, DirectoryInfo, String, Func) Copies all files from source to target . Declaration public static void CopyAll(DirectoryInfo source, DirectoryInfo target, string appendFileName = \"\", Func onCopyException = null) Parameters Type Name Description DirectoryInfo source the source directory DirectoryInfo target the destination directory String appendFileName the filename of the file to append together Func < Exception , FileInfo , Boolean > onCopyException a delegate called when there is an error copying. Return true to keep going. | Improve this Doc View Source CurrentTime() Gets the current DateTime if supported, otherwise, if Mono would throw a fit, returns MinValue plus some value, such that each time it is called the value will be greater than the previous result. Not suitable for timing. Declaration public static DateTime CurrentTime() Returns Type Description DateTime the current DateTime if supported, otherwise some indeterminant increasing value. | Improve this Doc View Source GetRelativePath(String, String) Gets a path relative to the provided folder. Declaration public static string GetRelativePath(string file, string folder) Parameters Type Name Description String file the file to relativize String folder the source folder Returns Type Description String a path to get from folder to file | Improve this Doc View Source StringToByteArray(String) Converts a hex string to a byte array. Declaration public static byte[] StringToByteArray(string hex) Parameters Type Name Description String hex the hex stream Returns Type Description Byte [] the corresponding byte array | Improve this Doc View Source UnsafeCompare(Byte[], Byte[]) Uses unsafe code to compare 2 byte arrays quickly. Declaration public static bool UnsafeCompare(byte[] a1, byte[] a2) Parameters Type Name Description Byte [] a1 array 1 Byte [] a2 array 2 Returns Type Description Boolean whether or not they are byte-for-byte equal | Improve this Doc View Source VersionCompareNoPrerelease(Version, Version) Compares a pair of SemVer.Version s ignoring both the prerelease and build fields. Declaration public static int VersionCompareNoPrerelease(Version l, Version r) Parameters Type Name Description SemVer.Version l the left value SemVer.Version r the right value Returns Type Description Int32 < 0 if l is less than r, 0 if they are equal in the numeric portion, or > 0 if l is greater than r" + "api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html": { + "href": "api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html", + "title": "Class UnityMainThreadTaskScheduler", + "keywords": "Class UnityMainThreadTaskScheduler A task scheduler that runs tasks on the Unity main thread via coroutines. Inheritance Object TaskScheduler UnityMainThreadTaskScheduler Implements IDisposable Inherited Members TaskScheduler.TryDequeue(Task) TaskScheduler.FromCurrentSynchronizationContext() TaskScheduler.TryExecuteTask(Task) TaskScheduler.MaximumConcurrencyLevel TaskScheduler.Current TaskScheduler.Id TaskScheduler.UnobservedTaskException Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public class UnityMainThreadTaskScheduler : TaskScheduler, IDisposable Properties | Improve this Doc View Source Cancelling Gets whether or not this scheduler is in the process of shutting down. Declaration public bool Cancelling { get; } Property Value Type Description Boolean true if the scheduler is shutting down, false otherwise | Improve this Doc View Source Default Gets the default main thread scheduler that is managed by BSIPA. Declaration public static TaskScheduler Default { get; } Property Value Type Description TaskScheduler a scheduler that is managed by BSIPA | Improve this Doc View Source Factory Gets a factory for creating tasks on Default . Declaration public static TaskFactory Factory { get; } Property Value Type Description TaskFactory a factory for creating tasks on the default scheduler | Improve this Doc View Source IsRunning Gets whether or not this scheduler is currently executing tasks. Declaration public bool IsRunning { get; } Property Value Type Description Boolean true if the scheduler is running, false otherwise | Improve this Doc View Source YieldAfterTasks Gets or sets the number of tasks to execute before yielding back to Unity. Declaration public int YieldAfterTasks { get; set; } Property Value Type Description Int32 the number of tasks to execute per resume | Improve this Doc View Source YieldAfterTime Gets or sets the amount of time to execute tasks for before yielding back to Unity. Default is 0.5ms. Declaration public TimeSpan YieldAfterTime { get; set; } Property Value Type Description TimeSpan the amount of time to execute tasks for before yielding back to Unity Methods | Improve this Doc View Source Cancel() Cancels the scheduler. If the scheduler is currently executing tasks, that batch will finish first. All remaining tasks will be left in the queue. Declaration public void Cancel() Exceptions Type Condition ObjectDisposedException if this scheduler is disposed InvalidOperationException if the scheduler is not running | Improve this Doc View Source Coroutine() When used as a Unity coroutine, runs the scheduler. Otherwise, this is an invalid call. Declaration public IEnumerator Coroutine() Returns Type Description IEnumerator a Unity coroutine Remarks Do not ever call UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator) on this coroutine, nor UnityEngine.MonoBehaviour.StopAllCoroutines() on the behaviour hosting this coroutine. This has no way to detect this, and this object will become invalid. If you need to stop this coroutine, first call Cancel() , then wait for it to exit on its own. Exceptions Type Condition ObjectDisposedException if this scheduler is disposed InvalidOperationException if the scheduler is already running | Improve this Doc View Source Dispose() Disposes this object. This puts the object into an unusable state. Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes this object. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing whether or not to dispose managed objects | Improve this Doc View Source GetScheduledTasks() Throws a NotSupportedException . Declaration protected override IEnumerable GetScheduledTasks() Returns Type Description IEnumerable < Task > nothing Overrides TaskScheduler.GetScheduledTasks() Exceptions Type Condition NotSupportedException Always. | Improve this Doc View Source QueueTask(Task) Queues a given Task to this scheduler. The Task must> be scheduled for this TaskScheduler by the runtime. Declaration protected override void QueueTask(Task task) Parameters Type Name Description Task task the Task to queue Overrides TaskScheduler.QueueTask(Task) Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source TryExecuteTaskInline(Task, Boolean) Rejects any attempts to execute a task inline. Declaration protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued) Parameters Type Name Description Task task the task to attempt to execute Boolean taskWasPreviouslyQueued whether the task was previously queued to this scheduler Returns Type Description Boolean false Overrides TaskScheduler.TryExecuteTaskInline(Task, Boolean) Remarks This task scheduler always runs its tasks on the thread that it manages, therefore it doesn't make sense to run it inline. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, "api/IPA.Utilities.Async.Synchronization.html": { "href": "api/IPA.Utilities.Async.Synchronization.html", @@ -119,10 +119,120 @@ "title": "Struct Synchronization.SemaphoreSlimAsyncLocker", "keywords": "Struct Synchronization.SemaphoreSlimAsyncLocker A locker for a SemaphoreSlim that was created asynchronously and automatically releases when it is disposed. Create this with LockAsync(SemaphoreSlim) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct SemaphoreSlimAsyncLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization LockAsync(SemaphoreSlim)" }, - "api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html": { - "href": "api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html", - "title": "Struct Synchronization.SemaphoreLocker", - "keywords": "Struct Synchronization.SemaphoreLocker A locker for a Semaphore that automatically releases when it is disposed. Create this with Lock(Semaphore) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct SemaphoreLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization Lock(Semaphore)" + "api/IPA.Utilities.Async.Synchronization.MutexLocker.html": { + "href": "api/IPA.Utilities.Async.Synchronization.MutexLocker.html", + "title": "Struct Synchronization.MutexLocker", + "keywords": "Struct Synchronization.MutexLocker A locker for a Mutex that automatically releases when it is disposed. Create this with Lock(Mutex) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct MutexLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization Lock(Mutex)" + }, + "api/IPA.Utilities.Async.SingleThreadTaskScheduler.html": { + "href": "api/IPA.Utilities.Async.SingleThreadTaskScheduler.html", + "title": "Class SingleThreadTaskScheduler", + "keywords": "Class SingleThreadTaskScheduler A single-threaded task scheduler that runs all of its tasks on the same thread. Inheritance Object TaskScheduler SingleThreadTaskScheduler Implements IDisposable Inherited Members TaskScheduler.TryDequeue(Task) TaskScheduler.FromCurrentSynchronizationContext() TaskScheduler.TryExecuteTask(Task) TaskScheduler.MaximumConcurrencyLevel TaskScheduler.Default TaskScheduler.Current TaskScheduler.Id TaskScheduler.UnobservedTaskException Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public class SingleThreadTaskScheduler : TaskScheduler, IDisposable Properties | Improve this Doc View Source IsRunning Gets whether or not the underlying thread has been started. Declaration public bool IsRunning { get; } Property Value Type Description Boolean Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Methods | Improve this Doc View Source Dispose() Disposes this object. This puts the object into an unusable state. Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes this object. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing whether or not to dispose managed objects | Improve this Doc View Source Exit() Terminates the runner thread, and waits for the currently running task to complete. Declaration public IEnumerable Exit() Returns Type Description IEnumerable < Task > an IEnumerable of Task s that did not execute Remarks After this method returns, this object has been disposed and is no longer in a valid state. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source GetScheduledTasks() Throws a NotSupportedException . Declaration protected override IEnumerable GetScheduledTasks() Returns Type Description IEnumerable < Task > nothing Overrides TaskScheduler.GetScheduledTasks() Exceptions Type Condition NotSupportedException Always. | Improve this Doc View Source Join() Waits for the runner thread to complete all tasks in the queue, then exits. Declaration public void Join() Remarks After this method returns, this object has been disposed and is no longer in a valid state. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source QueueTask(Task) Queues a given Task to this scheduler. The Task must> be scheduled for this TaskScheduler by the runtime. Declaration protected override void QueueTask(Task task) Parameters Type Name Description Task task the Task to queue Overrides TaskScheduler.QueueTask(Task) Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source Start() Starts the thread that executes tasks scheduled with this TaskScheduler Declaration public void Start() Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source TryExecuteTaskInline(Task, Boolean) Rejects any attempts to execute a task inline. Declaration protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued) Parameters Type Name Description Task task the task to attempt to execute Boolean taskWasPreviouslyQueued whether the task was previously queued to this scheduler Returns Type Description Boolean false Overrides TaskScheduler.TryExecuteTaskInline(Task, Boolean) Remarks This task scheduler always runs its tasks on the thread that it manages, therefore it doesn't make sense to run it inline. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.OnEnableAttribute.html": { + "href": "api/IPA.OnEnableAttribute.html", + "title": "Class OnEnableAttribute", + "keywords": "Class OnEnableAttribute Indicates that the target method should be called when the plugin is enabled. Inheritance Object Attribute OnEnableAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnEnableAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Remarks This attribute is interchangable with OnStartAttribute , and is treated identically. They are seperate to allow plugin code to more clearly describe the intent of the methods. Typically, this will be used when the RuntimeOptions parameter of the plugins's PluginAttribute is DynamicInit . The method marked by this attribute will always be called from the Unity main thread. Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also PluginAttribute OnStartAttribute" + }, + "api/IPA.OnDisableAttribute.html": { + "href": "api/IPA.OnDisableAttribute.html", + "title": "Class OnDisableAttribute", + "keywords": "Class OnDisableAttribute Indicates that the target method should be called when the plugin is disabled. Inheritance Object Attribute OnDisableAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnDisableAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Remarks This attribute is interchangable with OnExitAttribute , and is treated identically. They are seperate to allow plugin code to more clearly describe the intent of the methods. Typically, this will be used when the RuntimeOptions parameter of the plugins's PluginAttribute is DynamicInit . The method marked by this attribute will always be called from the Unity main thread. Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also PluginAttribute OnExitAttribute" + }, + "api/IPA.Logging.StandardLogger.html": { + "href": "api/IPA.Logging.StandardLogger.html", + "title": "Class StandardLogger", + "keywords": "Class StandardLogger The default (and standard) Logger implementation. Inheritance Object Logger StandardLogger Inherited Members Logger.LogFormat Logger.Log(Logger.Level, Exception) Logger.Trace(String) Logger.Trace(Exception) Logger.Debug(Exception) Logger.Info(String) Logger.Info(Exception) Logger.Notice(String) Logger.Notice(Exception) Logger.Warn(String) Logger.Warn(Exception) Logger.Error(String) Logger.Error(Exception) Logger.Critical(String) Logger.Critical(Exception) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public class StandardLogger : Logger Remarks StandardLogger uses a multi-threaded approach to logging. All actual I/O is done on another thread, where all messaged are guaranteed to be logged in the order they appeared. It is up to the printers to format them. This logger supports child loggers. Use GetChildLogger(Logger, String) to safely get a child. The modification of printers on a parent are reflected down the chain. Properties | Improve this Doc View Source ConsoleWriter The TextWriter for writing directly to the console window, or stdout if no window open. Declaration public static TextWriter ConsoleWriter { get; } Property Value Type Description TextWriter a TextWriter for the current primary text output | Improve this Doc View Source PrintFilter All levels defined by this filter will be sent to loggers. All others will be ignored. Declaration public static Logger.LogLevel PrintFilter { get; } Property Value Type Description Logger.LogLevel the global filter level Methods | Improve this Doc View Source AddPrinter(LogPrinter) Adds a log printer to the logger. Declaration public void AddPrinter(LogPrinter printer) Parameters Type Name Description LogPrinter printer the printer to add | Improve this Doc View Source Debug(String) An override to Debug(String) which shows the method that called it. Declaration public override void Debug(string message) Parameters Type Name Description String message the message to log Overrides Logger.Debug(String) See Also Log ( Logger.Level , String ) | Improve this Doc View Source Log(Logger.Level, String) Logs a specific message at a given level. Declaration public override void Log(Logger.Level level, string message) Parameters Type Name Description Logger.Level level the message level String message the message to log Overrides Logger.Log(Logger.Level, String) Extension Methods LoggerExtensions.GetChildLogger(Logger, String) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Logging.Printers.html": { + "href": "api/IPA.Logging.Printers.html", + "title": "", + "keywords": "Classes ColoredConsolePrinter Prints a pretty message to the console. ColorlessConsolePrinter A colorless version of ColoredConsolePrinter , that indiscriminantly prints to standard out. GlobalLogFilePrinter A printer for all messages to a unified log location. GZFilePrinter A LogPrinter abstract class that provides the utilities to write to a GZip file. PluginLogFilePrinter Prints log messages to the file specified by the name. PluginSubLogPrinter Prints log messages to the file specified by the name." + }, + "api/IPA.Logging.Logger.html": { + "href": "api/IPA.Logging.Logger.html", + "title": "Class Logger", + "keywords": "Class Logger The logger base class. Provides the format for console logs. Inheritance Object Logger StandardLogger Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public abstract class Logger Properties | Improve this Doc View Source LogFormat The standard format for log messages. Declaration public static string LogFormat { get; protected set; } Property Value Type Description String the format for the standard loggers to print in Methods | Improve this Doc View Source Critical(Exception) Sends an exception as a critical message. Equivalent to Log(Level.Critical, e); Declaration public virtual void Critical(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Critical(String) Sends a critical message. Equivalent to Log(Level.Critical, message); Declaration public virtual void Critical(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Debug(Exception) Sends an exception as a debug message. Equivalent to Log(Level.Debug, e); Declaration public virtual void Debug(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Debug(String) Sends a debug message. Equivalent to Log(Level.Debug, message); Declaration public virtual void Debug(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Error(Exception) Sends an exception as an error message. Equivalent to Log(Level.Error, e); Declaration public virtual void Error(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Error(String) Sends an error message. Equivalent to Log(Level.Error, message); Declaration public virtual void Error(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Info(Exception) Sends an exception as an info message. Equivalent to Log(Level.Info, e); Declaration public virtual void Info(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Info(String) Sends an info message. Equivalent to Log(Level.Info, message); Declaration public virtual void Info(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Log(Logger.Level, Exception) A basic log function taking an exception to log. Declaration public virtual void Log(Logger.Level level, Exception e) Parameters Type Name Description Logger.Level level the level of the message Exception e the exception to log | Improve this Doc View Source Log(Logger.Level, String) A basic log function. Declaration public abstract void Log(Logger.Level level, string message) Parameters Type Name Description Logger.Level level the level of the message String message the message to log | Improve this Doc View Source Notice(Exception) Sends an exception as a notice message. Equivalent to Log(Level.Notice, e); Declaration public virtual void Notice(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Notice(String) Sends a notice message. Equivalent to Log(Level.Notice, message); Declaration public virtual void Notice(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Trace(Exception) Sends an exception as a trace message. Equivalent to Log(Level.Trace, e); Declaration public virtual void Trace(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Trace(String) Sends a trace message. Equivalent to Log(Level.Trace, message); Declaration public virtual void Trace(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Warn(Exception) Sends an exception as a warning message. Equivalent to Log(Level.Warning, e); Declaration public virtual void Warn(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Warn(String) Sends a warning message. Equivalent to Log(Level.Warning, message); Declaration public virtual void Warn(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) Extension Methods LoggerExtensions.GetChildLogger(Logger, String) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Logging.Logger.LogLevel.html": { + "href": "api/IPA.Logging.Logger.LogLevel.html", + "title": "Enum Logger.LogLevel", + "keywords": "Enum Logger.LogLevel An enum providing log level filters. Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax [Flags] public enum LogLevel : byte Fields Name Description All Shows all messages. CriticalOnly Only shows Critical messages. DebugOnly Only shows Debug messages. DebugUp Shows all messages debug and up. ErrorOnly Only shows Error messages. ErrorUp Shows all messages error and up. InfoOnly Only shows info messages. InfoUp Shows all messages info and up. None Allow no messages through. NoticeOnly Only shows notice messages. NoticeUp Shows all messages Notice and up. TraceOnly Only shows Trace messages. Undefined Used for when the level is undefined. WarningOnly Only shows Warning messages. WarningUp Shows all messages warning and up. Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" + }, + "api/IPA.Loader.PluginManager.html": { + "href": "api/IPA.Loader.PluginManager.html", + "title": "Class PluginManager", + "keywords": "Class PluginManager The manager class for all plugins. Inheritance Object PluginManager Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginManager Properties | Improve this Doc View Source AllPlugins Gets a list of all enabled BSIPA plugins. Declaration public static IEnumerable AllPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > a collection of all enabled plugins as PluginMetadata s | Improve this Doc View Source DisabledPlugins Gets a list of disabled BSIPA plugins. Declaration public static IEnumerable DisabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > a collection of all disabled plugins as PluginMetadata | Improve this Doc View Source Plugins An IEnumerable of old IPA plugins. Declaration [Obsolete(\"I mean, IPlugin shouldn't be used, so why should this? Not renaming to extend support for old plugins.\")] public static IEnumerable Plugins { get; } Property Value Type Description IEnumerable < IPlugin > all legacy plugin instances Methods | Improve this Doc View Source GetDisabledPlugin(String) Gets a disabled plugin's metadata by its name. Declaration public static PluginMetadata GetDisabledPlugin(string name) Parameters Type Name Description String name the name of the disabled plugin to get Returns Type Description PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetDisabledPluginFromId(String) Gets a disabled plugin's metadata by its ID. Declaration public static PluginMetadata GetDisabledPluginFromId(string name) Parameters Type Name Description String name the ID of the disabled plugin to get Returns Type Description PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetPlugin(String) Gets info about the enabled plugin with the specified name. Declaration public static PluginMetadata GetPlugin(string name) Parameters Type Name Description String name the name of the plugin to get (must be an exact match) Returns Type Description PluginMetadata the plugin metadata for the requested plugin or null if it doesn't exist or is disabled | Improve this Doc View Source GetPluginFromId(String) Gets info about the enabled plugin with the specified ID. Declaration public static PluginMetadata GetPluginFromId(string name) Parameters Type Name Description String name the ID name of the plugin to get (must be an exact match) Returns Type Description PluginMetadata the plugin metadata for the requested plugin or null if it doesn't exist or is disabled | Improve this Doc View Source IsDisabled(PluginMetadata) Checks if a given plugin is disabled. Declaration public static bool IsDisabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is disabled, false otherwise. | Improve this Doc View Source IsEnabled(PluginMetadata) Checks if a given plugin is enabled. Declaration public static bool IsEnabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is enabled, false otherwise. | Improve this Doc View Source PluginStateTransaction() Creates a new transaction for mod enabling and disabling mods simultaneously. Declaration public static StateTransitionTransaction PluginStateTransaction() Returns Type Description StateTransitionTransaction a new StateTransitionTransaction that captures the current state of loaded mods Events | Improve this Doc View Source PluginDisabled Called whenever a plugin is disabled. Declaration public static event PluginManager.PluginDisableDelegate PluginDisabled Event Type Type Description PluginManager.PluginDisableDelegate | Improve this Doc View Source PluginEnabled Called whenever a plugin is enabled. Declaration public static event PluginManager.PluginEnableDelegate PluginEnabled Event Type Type Description PluginManager.PluginEnableDelegate" + }, + "api/IPA.Loader.PluginManager.PluginEnableDelegate.html": { + "href": "api/IPA.Loader.PluginManager.PluginEnableDelegate.html", + "title": "Delegate PluginManager.PluginEnableDelegate", + "keywords": "Delegate PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate void PluginEnableDelegate(PluginMetadata plugin, bool needsRestart); Parameters Type Name Description PluginMetadata plugin the plugin that was enabled Boolean needsRestart whether it needs a restart to take effect Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Loader.PluginManager.PluginDisableDelegate.html": { + "href": "api/IPA.Loader.PluginManager.PluginDisableDelegate.html", + "title": "Delegate PluginManager.PluginDisableDelegate", + "keywords": "Delegate PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate void PluginDisableDelegate(PluginMetadata plugin, bool needsRestart); Parameters Type Name Description PluginMetadata plugin the plugin that was disabled Boolean needsRestart whether it needs a restart to take effect Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Loader.PluginInitInjector.html": { + "href": "api/IPA.Loader.PluginInitInjector.html", + "title": "Class PluginInitInjector", + "keywords": "Class PluginInitInjector The type that handles value injecting into a plugin's initialization methods. Inheritance Object PluginInitInjector Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginInitInjector Remarks The default injectors and what they provide are shown in this table. Parameter Type Injected Value Logger A StandardLogger specialized for the plugin being injected PluginMetadata The PluginMetadata of the plugin being injected Config A Config object for the plugin being injected. These parameters may have Config.NameAttribute and Config.PreferAttribute to control how it is constructed. For all of the default injectors, only one of each will be generated, and any later parameters will recieve the same value as the first one. Methods | Improve this Doc View Source AddInjector(Type, PluginInitInjector.InjectParameter) Adds an injector to be used when calling future plugins' Init methods. Declaration public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector) Parameters Type Name Description Type type the type of the parameter. PluginInitInjector.InjectParameter injector the function to call for injection." + }, + "api/IPA.Loader.PluginInitInjector.InjectParameter.html": { + "href": "api/IPA.Loader.PluginInitInjector.InjectParameter.html", + "title": "Delegate PluginInitInjector.InjectParameter", + "keywords": "Delegate PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate object InjectParameter(object previous, ParameterInfo param, PluginMetadata meta); Parameters Type Name Description Object previous the previous return value of the function, or null if never called for plugin. ParameterInfo param the ParameterInfo of the parameter being injected. PluginMetadata meta the PluginMetadata for the plugin being loaded. Returns Type Description Object the value to inject into that parameter. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Loader.Features.html": { + "href": "api/IPA.Loader.Features.html", + "title": "", + "keywords": "Classes Feature The root interface for a mod Feature." + }, + "api/IPA.Config.Stores.Converters.NullableConverter-1.html": { + "href": "api/IPA.Config.Stores.Converters.NullableConverter-1.html", + "title": "Class NullableConverter", + "keywords": "Class NullableConverter A converter for a Nullable . Inheritance Object ValueConverter < Nullable > NullableConverter NullableConverter Implements IValueConverter Inherited Members ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class NullableConverter : ValueConverter, IValueConverter where T : struct Type Parameters Name Description T the underlying type of the Nullable Constructors | Improve this Doc View Source NullableConverter() Creates a converter with the default converter for the base type. Equivalent to new NullableConverter(Converter.Default) Declaration public NullableConverter() See Also NullableConverter(ValueConverter) Default | Improve this Doc View Source NullableConverter(ValueConverter) Creates a converter with the given underlying ValueConverter . Declaration public NullableConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the undlerlying ValueConverter to use Methods | Improve this Doc View Source FromValue(Value, Object) Converts a Value tree to a value. Declaration public override T? FromValue(Value value, object parent) Parameters Type Name Description Value value the Value tree to convert Object parent the object which will own the created object Returns Type Description Nullable the object represented by value Overrides IPA.Config.Stores.ValueConverter>.FromValue(IPA.Config.Data.Value, System.Object) | Improve this Doc View Source ToValue(Nullable, Object) Converts a nullable T to a Value tree. Declaration public override Value ToValue(T? obj, object parent) Parameters Type Name Description Nullable obj the value to serialize Object parent the object which owns obj Returns Type Description Value a Value tree representing obj . Overrides IPA.Config.Stores.ValueConverter>.ToValue(System.Nullable, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.Stores.Converters.ListConverter-2.html": { + "href": "api/IPA.Config.Stores.Converters.ListConverter-2.html", + "title": "Class ListConverter", + "keywords": "Class ListConverter A ListConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter < List > CollectionConverter > ListConverter ListConverter Implements IValueConverter Inherited Members ListConverter.Create(Int32, Object) CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(List, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(List, Object) ValueConverter>.ToValue(List, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class ListConverter : ListConverter, IValueConverter where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TConverter the type of the converter to use for T Constructors | Improve this Doc View Source ListConverter() Creates an ListConverter using a default constructed TConverter element type. Equivalent to calling ListConverter(ValueConverter) with a default-constructed TConverter . Declaration public ListConverter() See Also ListConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also ListConverter " + }, + "api/IPA.Config.Stores.Converters.Converter.html": { + "href": "api/IPA.Config.Stores.Converters.Converter.html", + "title": "Class Converter", + "keywords": "Class Converter Provides utility functions for custom converters. Inheritance Object Converter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public static class Converter Methods | Improve this Doc View Source FloatValue(Value) Gets the floaing point value of a Value , coercing an Integer if necessary, or null if val is not an Integer or FloatingPoint . Declaration public static decimal? FloatValue(Value val) Parameters Type Name Description Value val the Value to get the floaing point value of Returns Type Description Nullable < Decimal > the floaing point value of val , or null | Improve this Doc View Source IntValue(Value) Gets the integral value of a Value , coercing a FloatingPoint if necessary, or null if val is not an Integer or FloatingPoint . Declaration public static long? IntValue(Value val) Parameters Type Name Description Value val the Value to get the integral value of Returns Type Description Nullable < Int64 > the integral value of val , or null" + }, + "api/IPA.Config.Stores.Converters.Converter-1.html": { + "href": "api/IPA.Config.Stores.Converters.Converter-1.html", + "title": "Class Converter", + "keywords": "Class Converter Provides generic utilities for converters for certain types. Inheritance Object Converter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public static class Converter Type Parameters Name Description T the type of the ValueConverter that this works on Properties | Improve this Doc View Source Default Gets the default ValueConverter for the current type. Declaration public static ValueConverter Default { get; } Property Value Type Description ValueConverter " + }, + "api/IPA.Config.Stores.Attributes.IgnoreAttribute.html": { + "href": "api/IPA.Config.Stores.Attributes.IgnoreAttribute.html", + "title": "Class IgnoreAttribute", + "keywords": "Class IgnoreAttribute Causes a field or property in an object being wrapped by Generated(Config, Boolean) to be ignored during serialization and deserialization. Inheritance Object Attribute IgnoreAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Attributes Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class IgnoreAttribute : Attribute, _Attribute Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.ModPrefs.html": { + "href": "api/IPA.Config.ModPrefs.html", + "title": "Class ModPrefs", + "keywords": "Class ModPrefs Allows to get and set preferences for your mod. Inheritance Object ModPrefs Implements IModPrefs Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [Obsolete(\"Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.\")] public class ModPrefs : IModPrefs Constructors | Improve this Doc View Source ModPrefs(PluginMetadata) Constructs a ModPrefs object for the provide plugin. Declaration public ModPrefs(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin to get the preferences file for Methods | Improve this Doc View Source GetBool(String, String, Boolean, Boolean) Gets a bool from the ini. Declaration public static bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Boolean | Improve this Doc View Source GetFloat(String, String, Single, Boolean) Gets a float from the ini. Declaration public static float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Single defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Single | Improve this Doc View Source GetInt(String, String, Int32, Boolean) Gets an int from the ini. Declaration public static int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Int32 | Improve this Doc View Source GetString(String, String, String, Boolean) Gets a string from the ini. Declaration public static string GetString(string section, string name, string defaultValue = \"\", bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. String defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description String | Improve this Doc View Source HasKey(String, String) Checks whether or not a key exists in the ini. Declaration public static bool HasKey(string section, string name) Parameters Type Name Description String section Section of the key. String name Name of the key. Returns Type Description Boolean | Improve this Doc View Source SetBool(String, String, Boolean) Sets a bool in the ini. Declaration public static void SetBool(string section, string name, bool value) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean value Value that should be written. | Improve this Doc View Source SetFloat(String, String, Single) Sets a float in the ini. Declaration public static void SetFloat(string section, string name, float value) Parameters Type Name Description String section Section of the key. String name Name of the key. Single value Value that should be written. | Improve this Doc View Source SetInt(String, String, Int32) Sets an int in the ini. Declaration public static void SetInt(string section, string name, int value) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 value Value that should be written. | Improve this Doc View Source SetString(String, String, String) Sets a string in the ini. Declaration public static void SetString(string section, string name, string value) Parameters Type Name Description String section Section of the key. String name Name of the key. String value Value that should be written. Explicit Interface Implementations | Improve this Doc View Source IModPrefs.GetBool(String, String, Boolean, Boolean) Declaration bool IModPrefs.GetBool(string section, string name, bool defaultValue, bool autoSave) Parameters Type Name Description String section String name Boolean defaultValue Boolean autoSave Returns Type Description Boolean | Improve this Doc View Source IModPrefs.GetFloat(String, String, Single, Boolean) Declaration float IModPrefs.GetFloat(string section, string name, float defaultValue, bool autoSave) Parameters Type Name Description String section String name Single defaultValue Boolean autoSave Returns Type Description Single | Improve this Doc View Source IModPrefs.GetInt(String, String, Int32, Boolean) Declaration int IModPrefs.GetInt(string section, string name, int defaultValue, bool autoSave) Parameters Type Name Description String section String name Int32 defaultValue Boolean autoSave Returns Type Description Int32 | Improve this Doc View Source IModPrefs.GetString(String, String, String, Boolean) Declaration string IModPrefs.GetString(string section, string name, string defaultValue, bool autoSave) Parameters Type Name Description String section String name String defaultValue Boolean autoSave Returns Type Description String | Improve this Doc View Source IModPrefs.HasKey(String, String) Declaration bool IModPrefs.HasKey(string section, string name) Parameters Type Name Description String section String name Returns Type Description Boolean | Improve this Doc View Source IModPrefs.SetBool(String, String, Boolean) Declaration void IModPrefs.SetBool(string section, string name, bool value) Parameters Type Name Description String section String name Boolean value | Improve this Doc View Source IModPrefs.SetFloat(String, String, Single) Declaration void IModPrefs.SetFloat(string section, string name, float value) Parameters Type Name Description String section String name Single value | Improve this Doc View Source IModPrefs.SetInt(String, String, Int32) Declaration void IModPrefs.SetInt(string section, string name, int value) Parameters Type Name Description String section String name Int32 value | Improve this Doc View Source IModPrefs.SetString(String, String, String) Declaration void IModPrefs.SetString(string section, string name, string value) Parameters Type Name Description String section String name String value Implements IModPrefs Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.IConfigProvider.html": { + "href": "api/IPA.Config.IConfigProvider.html", + "title": "Interface IConfigProvider", + "keywords": "Interface IConfigProvider An interface for configuration providers. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public interface IConfigProvider Remarks Implementers must provide a default constructor. Do not assume that File will ever be set for a given object. Implementers are expected to preserve the typing of values passed to Store(Value, FileInfo) when returned from Load(FileInfo) . The only exceptions to this are the numeric types, Integer and FloatingPoint , since they can be coerced to each other with AsFloat() and AsInteger() respectively. The provider should however store and recover Integer with as much precision as is possible. For example, a JSON provider may decide to decode all numbers that have an integral value, even if they were originally FloatingPoint , as Integer . This is reasonable, as Integer is more precise, particularly with larger values, than FloatingPoint . Properties | Improve this Doc View Source Extension Gets the extension without a dot to use for files handled by this provider. Declaration string Extension { get; } Property Value Type Description String Remarks This must work immediately, and is used to generate the FileInfo used to set File . Methods | Improve this Doc View Source Load(FileInfo) Loads a Value from disk in whatever format this provider provides and returns it. Declaration Value Load(FileInfo file) Parameters Type Name Description FileInfo file the file to read from Returns Type Description Value the Value loaded | Improve this Doc View Source Store(Value, FileInfo) Stores the Value given to disk in the format specified. Declaration void Store(Value value, FileInfo file) Parameters Type Name Description Value value the Value to store FileInfo file the file to write to Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.Data.Value.html": { + "href": "api/IPA.Config.Data.Value.html", + "title": "Class Value", + "keywords": "Class Value A base value type for config data abstract representations, to be serialized with an IConfigProvider . If a Value is null , then that represents just that: a null in whatever serialization is being used. Also contains factory functions for all derived types. Inheritance Object Value Boolean FloatingPoint Integer List Map Text Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public abstract class Value Methods | Improve this Doc View Source Bool(Boolean) Creates a new Boolean wrapping a Boolean . Declaration public static Boolean Bool(bool val) Parameters Type Name Description Boolean val the value to wrap Returns Type Description Boolean a Boolean wrapping val See Also From(Boolean) | Improve this Doc View Source Float(Decimal) Creates a new FloatingPoint wrapping a Decimal . Declaration public static FloatingPoint Float(decimal val) Parameters Type Name Description Decimal val the value to wrap Returns Type Description FloatingPoint a FloatingPoint wrapping val See Also From(Decimal) | Improve this Doc View Source From(Boolean) Creates a new Value wrapping a Boolean . Declaration public static Boolean From(bool val) Parameters Type Name Description Boolean val the value to wrap Returns Type Description Boolean a Boolean wrapping val See Also Bool(Boolean) | Improve this Doc View Source From(IDictionary) Creates a new Map holding the content of an IDictionary of String to Value . Declaration public static Map From(IDictionary vals) Parameters Type Name Description IDictionary < String , Value > vals the dictionary of Value s to initialize the Map wtih Returns Type Description Map a Map containing the content of vals See Also Map() From(IEnumerable>) | Improve this Doc View Source From(IEnumerable) Creates a new List holding the content of an IEnumerable of Value . Declaration public static List From(IEnumerable vals) Parameters Type Name Description IEnumerable < Value > vals the Value s to initialize the List with Returns Type Description List a List containing the content of vals See Also List() | Improve this Doc View Source From(IEnumerable>) Creates a new Map holding the content of an IEnumerable of KeyValuePair of String to Value . Declaration public static Map From(IEnumerable> vals) Parameters Type Name Description IEnumerable < KeyValuePair < String , Value >> vals the enumerable of KeyValuePair of name to Value Returns Type Description Map a Map containing the content of vals See Also Map() From(IDictionary) | Improve this Doc View Source From(Decimal) Creates a new Value wrapping a Double . Declaration public static FloatingPoint From(decimal val) Parameters Type Name Description Decimal val the value to wrap Returns Type Description FloatingPoint a FloatingPoint wrapping val See Also Float(Decimal) | Improve this Doc View Source From(Int64) Creates a new Value wrapping a Int64 . Declaration public static Integer From(long val) Parameters Type Name Description Int64 val the value to wrap Returns Type Description Integer a Integer wrapping val See Also Integer(Int64) | Improve this Doc View Source From(String) Creates a new Value representing a String . Declaration public static Text From(string val) Parameters Type Name Description String val the value to wrap Returns Type Description Text a Text wrapping val See Also Text(String) | Improve this Doc View Source Integer(Int64) Creates a new Integer wrapping a Int64 . Declaration public static Integer Integer(long val) Parameters Type Name Description Int64 val the value to wrap Returns Type Description Integer a Integer wrapping val See Also From(Int64) | Improve this Doc View Source List() Creates an empty List() . Declaration public static List List() Returns Type Description List an empty List() See Also From(IEnumerable) | Improve this Doc View Source Map() Creates an empty Map() . Declaration public static Map Map() Returns Type Description Map an empty Map() See Also From(IDictionary) From(IEnumerable>) | Improve this Doc View Source Null() Creates a Null Value . Declaration public static Value Null() Returns Type Description Value null | Improve this Doc View Source Text(String) Creates a new Text object wrapping a String . Declaration public static Text Text(string val) Parameters Type Name Description String val the value to wrap Returns Type Description Text a Text wrapping val See Also From(String) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public abstract override string ToString() Returns Type Description String a human-readable string containing the value provided Overrides Object.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.Config.NameAttribute.html": { + "href": "api/IPA.Config.Config.NameAttribute.html", + "title": "Class Config.NameAttribute", + "keywords": "Class Config.NameAttribute Specifies a preferred config name, instead of using the plugin's name. Inheritance Object Attribute Config.NameAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Parameter)] public sealed class NameAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source NameAttribute(String) Constructs the attribute with a specific name. Declaration public NameAttribute(string name) Parameters Type Name Description String name the name to use for the config. Properties | Improve this Doc View Source Name The name to use for the config. Declaration public string Name { get; } Property Value Type Description String the name to use for the config Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html": { "href": "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html", @@ -139,15 +249,50 @@ "title": "Struct Synchronization.ReaderWriterLockSlimReadLocker", "keywords": "Struct Synchronization.ReaderWriterLockSlimReadLocker A locker for a read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockRead(ReaderWriterLockSlim) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct ReaderWriterLockSlimReadLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization LockRead(ReaderWriterLockSlim)" }, - "api/IPA.Utilities.Async.Synchronization.MutexLocker.html": { - "href": "api/IPA.Utilities.Async.Synchronization.MutexLocker.html", - "title": "Struct Synchronization.MutexLocker", - "keywords": "Struct Synchronization.MutexLocker A locker for a Mutex that automatically releases when it is disposed. Create this with Lock(Mutex) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct MutexLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization Lock(Mutex)" + "api/IPA.Utilities.AlmostVersion.html": { + "href": "api/IPA.Utilities.AlmostVersion.html", + "title": "Class AlmostVersion", + "keywords": "Class AlmostVersion A type that wraps SemVer.Version so that the string of the version is stored when the string is not a valid SemVer.Version . Inheritance Object AlmostVersion Implements IComparable < AlmostVersion > IComparable < SemVer.Version > Inherited Members Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public class AlmostVersion : IComparable, IComparable Constructors | Improve this Doc View Source AlmostVersion(Version) Creates an AlmostVersion from the SemVer.Version provided in ver . Declaration public AlmostVersion(Version ver) Parameters Type Name Description SemVer.Version ver the SemVer.Version to store | Improve this Doc View Source AlmostVersion(String) Creates a new AlmostVersion with the version string provided in vertext . Declaration public AlmostVersion(string vertext) Parameters Type Name Description String vertext the version string to store | Improve this Doc View Source AlmostVersion(String, AlmostVersion) Creates a new AlmostVersion from the version string in vertext stored the same way as the AlmostVersion passed in copyMode . Declaration public AlmostVersion(string vertext, AlmostVersion copyMode) Parameters Type Name Description String vertext the text to parse as an AlmostVersion AlmostVersion copyMode an AlmostVersion to copy the storage mode of | Improve this Doc View Source AlmostVersion(String, AlmostVersion.StoredAs) Creates an AlmostVersion from the version string in vertext stored using the storage mode specified in mode . Declaration public AlmostVersion(string vertext, AlmostVersion.StoredAs mode) Parameters Type Name Description String vertext the text to parse as an AlmostVersion AlmostVersion.StoredAs mode the storage mode to store the version in Properties | Improve this Doc View Source SemverValue The value of the AlmostVersion if it was stored as a SemVer.Version . Declaration public Version SemverValue { get; } Property Value Type Description SemVer.Version the stored value as a SemVer.Version , or null if not stored as a version. | Improve this Doc View Source StorageMode The way the value is stored, whether it be as a SemVer.Version or a String . Declaration public AlmostVersion.StoredAs StorageMode { get; } Property Value Type Description AlmostVersion.StoredAs the storage mode used to store this value | Improve this Doc View Source StringValue The value of the AlmostVersion if it was stored as a String . Declaration public string StringValue { get; } Property Value Type Description String the stored value as a String , or null if not stored as a string. Methods | Improve this Doc View Source CompareTo(AlmostVersion) Compares langword_csharp_this to the AlmostVersion in other using SemVer.Version.CompareTo(SemVer.Version) or CompareTo(String) , depending on the current store. Declaration public int CompareTo(AlmostVersion other) Parameters Type Name Description AlmostVersion other the AlmostVersion to compare to Returns Type Description Int32 less than 0 if other is considered bigger than langword_csharp_this , 0 if equal, and greater than zero if smaller Remarks The storage methods of the two objects must be the same, or this will throw an InvalidOperationException . See Also CompareTo(Version) | Improve this Doc View Source CompareTo(Version) Compares langword_csharp_this to the SemVer.Version in other using SemVer.Version.CompareTo(SemVer.Version) . Declaration public int CompareTo(Version other) Parameters Type Name Description SemVer.Version other the SemVer.Version to compare to Returns Type Description Int32 less than 0 if other is considered bigger than langword_csharp_this , 0 if equal, and greater than zero if smaller Remarks The storage method of langword_csharp_this must be SemVer , else an InvalidOperationException will be thrown. See Also CompareTo(AlmostVersion) | Improve this Doc View Source Equals(Object) Performs a strict equality check between langword_csharp_this and obj . Declaration public override bool Equals(object obj) Parameters Type Name Description Object obj the object to compare to Returns Type Description Boolean true if they are equal, false otherwise Overrides Object.Equals(Object) Remarks This may return false where Equality(AlmostVersion, AlmostVersion) returns true See Also Equals ( Object ) | Improve this Doc View Source GetHashCode() Default generated hash code function generated by VS. Declaration public override int GetHashCode() Returns Type Description Int32 a value unique to each object, except those that are considered equal by Equals(Object) Overrides Object.GetHashCode() See Also GetHashCode () | Improve this Doc View Source ToString() Gets a string representation of the current version. If the value is stored as a string, this returns it. If it is stored as a SemVer.Version , it is equivalent to calling SemVer.Version.ToString . Declaration public override string ToString() Returns Type Description String a string representation of the current version Overrides Object.ToString() See Also ToString () Operators | Improve this Doc View Source Equality(AlmostVersion, AlmostVersion) Compares two versions, only taking into account the numeric part of the version if they are stored as SemVer.Version s, or strict equality if they are stored as String s. Declaration public static bool operator ==(AlmostVersion l, AlmostVersion r) Parameters Type Name Description AlmostVersion l the first value to compare AlmostVersion r the second value to compare Returns Type Description Boolean true if they are mostly equal, false otherwise Remarks This is a looser equality than Equals(Object) , meaning that this may return true where Equals(Object) does not. See Also Equals(Object) | Improve this Doc View Source Implicit(AlmostVersion to Version) Implicitly converts an AlmostVersion to SemVer.Version , if applicable, using SemverValue . If not applicable, returns null Declaration public static implicit operator Version(AlmostVersion av) Parameters Type Name Description AlmostVersion av the AlmostVersion to convert to a SemVer.Version Returns Type Description SemVer.Version See Also SemverValue | Improve this Doc View Source Implicit(Version to AlmostVersion) Implicitly converts a SemVer.Version to AlmostVersion using AlmostVersion(Version) . Declaration public static implicit operator AlmostVersion(Version ver) Parameters Type Name Description SemVer.Version ver the SemVer.Version to convert Returns Type Description AlmostVersion See Also AlmostVersion(Version) | Improve this Doc View Source Inequality(AlmostVersion, AlmostVersion) The opposite of Equality(AlmostVersion, AlmostVersion) . Equivalent to !(l == r) . Declaration public static bool operator !=(AlmostVersion l, AlmostVersion r) Parameters Type Name Description AlmostVersion l the first value to compare AlmostVersion r the second value to compare Returns Type Description Boolean true if they are not mostly equal, false otherwise See Also Equality(AlmostVersion, AlmostVersion) Implements System.IComparable System.IComparable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.OnExitAttribute.html": { - "href": "api/IPA.OnExitAttribute.html", - "title": "Class OnExitAttribute", - "keywords": "Class OnExitAttribute Indicates that the target method should be called when the game exits. Inheritance Object Attribute OnExitAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnExitAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Remarks This attribute is interchangable with OnDisableAttribute , and is treated identically. They are seperate to allow plugin code to more clearly describe the intent of the methods. Typically, this will be used when the RuntimeOptions parameter of the plugins's PluginAttribute is SingleStartInit . The method marked by this attribute will always be called from the Unity main thread. Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also PluginAttribute OnDisableAttribute" + "api/IPA.Utilities.AlmostVersion.StoredAs.html": { + "href": "api/IPA.Utilities.AlmostVersion.StoredAs.html", + "title": "Enum AlmostVersion.StoredAs", + "keywords": "Enum AlmostVersion.StoredAs Represents a storage type of either parsed SemVer.Version object or raw String . Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public enum StoredAs Fields Name Description SemVer The version was stored as a SemVer.Version . String The version was stored as a String . Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" + }, + "api/IPA.RuntimeOptions.html": { + "href": "api/IPA.RuntimeOptions.html", + "title": "Enum RuntimeOptions", + "keywords": "Enum RuntimeOptions Options that a plugin must specify to describe how it expects to be run. Namespace : IPA Assembly : IPA.Loader.dll Syntax public enum RuntimeOptions Fields Name Description DynamicInit Indicates that this plugin supports runtime enabling and disabling. When this is set, the plugin may be disabled at reasonable points during runtime. As with SingleStartInit , it will be initialized and enabled with the game if it is enabled on startup, and disabled with the game if it is enabled on shutdown. When a plugin with this set is enabled mid-game, the first time it is enabled, its initialization methods will be called, then its enable methods. All subsequent enables will NOT re-initialize, however the enable methods will be called. When a plugin with this set is disabled mid-game, the plugin instance will NOT be destroyed, and will instead be re-used for subsequent enables. The plugin is expected to handle this gracefully, and behave in a way that makes sense. SingleStartInit Indicates that this plugin expects to be initialized and enabled with the game, and disabled with the game. With this option set, whether or not the plugin is disabled during a given run is constant for that entire run. See Also PluginAttribute InitAttribute OnEnableAttribute OnDisableAttribute OnStartAttribute OnExitAttribute Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" + }, + "api/IPA.PluginAttribute.html": { + "href": "api/IPA.PluginAttribute.html", + "title": "Class PluginAttribute", + "keywords": "Class PluginAttribute Marks a class as being a BSIPA plugin. Inheritance Object Attribute PluginAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)] public sealed class PluginAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source PluginAttribute(RuntimeOptions) Initializes a PluginAttribute with the given RuntimeOptions to indicate the runtime capabilities of the plugin. Declaration public PluginAttribute(RuntimeOptions runtimeOptions) Parameters Type Name Description RuntimeOptions runtimeOptions the options to use for this plugin Properties | Improve this Doc View Source RuntimeOptions The RuntimeOptions passed into the constructor of this attribute. Declaration public RuntimeOptions RuntimeOptions { get; } Property Value Type Description RuntimeOptions Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also InitAttribute OnEnableAttribute OnDisableAttribute OnStartAttribute OnExitAttribute" + }, + "api/IPA.Old.html": { + "href": "api/IPA.Old.html", + "title": "", + "keywords": "Interfaces IEnhancedPlugin An enhanced version of the standard IPA plugin. IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed in Plugins." + }, + "api/IPA.Old.IPlugin.html": { + "href": "api/IPA.Old.IPlugin.html", + "title": "Interface IPlugin", + "keywords": "Interface IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed in Plugins. Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IBeatSaberPlugin\")] public interface IPlugin Properties | Improve this Doc View Source Name Gets the name of the plugin. Declaration string Name { get; } Property Value Type Description String | Improve this Doc View Source Version Gets the version of the plugin. Declaration string Version { get; } Property Value Type Description String Methods | Improve this Doc View Source OnApplicationQuit() Gets invoked when the application is closed. Declaration void OnApplicationQuit() | Improve this Doc View Source OnApplicationStart() Gets invoked when the application is started. Declaration void OnApplicationStart() | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | Improve this Doc View Source OnLevelWasInitialized(Int32) Gets invoked after the first update cycle after a level was loaded. Declaration void OnLevelWasInitialized(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnLevelWasLoaded(Int32) Gets invoked whenever a level is loaded. Declaration void OnLevelWasLoaded(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Old.IEnhancedPlugin.html": { + "href": "api/IPA.Old.IEnhancedPlugin.html", + "title": "Interface IEnhancedPlugin", + "keywords": "Interface IEnhancedPlugin An enhanced version of the standard IPA plugin. Inherited Members IPlugin.Name IPlugin.Version IPlugin.OnApplicationStart() IPlugin.OnApplicationQuit() IPlugin.OnLevelWasLoaded(Int32) IPlugin.OnLevelWasInitialized(Int32) IPlugin.OnUpdate() IPlugin.OnFixedUpdate() Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IPA.IEnhancedPlugin\")] public interface IEnhancedPlugin : IPlugin Properties | Improve this Doc View Source Filter Gets a list of executables this plugin should be executed on (without the file ending) Declaration string[] Filter { get; } Property Value Type Description String [] Examples { \"PlayClub\", \"PlayClubStudio\" } Methods | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Logging.html": { + "href": "api/IPA.Logging.html", + "title": "", + "keywords": "Classes Logger The logger base class. Provides the format for console logs. LoggerExtensions A class providing extensions for various loggers. LogPrinter The log printer's base class. StandardLogger The default (and standard) Logger implementation. Enums Logger.Level An enum specifying the level of the message. Resembles Syslog. Logger.LogLevel An enum providing log level filters." + }, + "api/IPA.Logging.Printers.GZFilePrinter.html": { + "href": "api/IPA.Logging.Printers.GZFilePrinter.html", + "title": "Class GZFilePrinter", + "keywords": "Class GZFilePrinter A LogPrinter abstract class that provides the utilities to write to a GZip file. Inheritance Object LogPrinter GZFilePrinter GlobalLogFilePrinter PluginLogFilePrinter PluginSubLogPrinter Implements IDisposable Inherited Members LogPrinter.Filter LogPrinter.Print(Logger.Level, DateTime, String, String) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public abstract class GZFilePrinter : LogPrinter, IDisposable Fields | Improve this Doc View Source FileWriter The StreamWriter that writes to the GZip file. Declaration protected StreamWriter FileWriter Field Value Type Description StreamWriter the writer to the underlying filestream Methods | Improve this Doc View Source Dispose() Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes the file printer. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing does nothing | Improve this Doc View Source EndPrint() Called at the end of any print session. Declaration public override sealed void EndPrint() Overrides LogPrinter.EndPrint() | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the file to write to. Declaration protected abstract FileInfo GetFileInfo() Returns Type Description FileInfo the file to write to | Improve this Doc View Source StartPrint() Called at the start of any print session. Declaration public override sealed void StartPrint() Overrides LogPrinter.StartPrint() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, "other_api/config/schema.html": { "href": "other_api/config/schema.html", @@ -199,85 +344,115 @@ "title": "BSIPA - Home", "keywords": "BSIPA - The Unity mod injector for the new age (pending confirmation). Assuming, that is, that Unity 2017 is \"new age\". How To Install See Installing How To Uninstall See Uninstalling Arguments See The Command Line . How To Develop See Developing for more information. How To Keep The Game Patched BSIPA will automatically repatch the game when it updates, as long as winhttp.dll is present in the install directory." }, - "api/IPA.Old.html": { - "href": "api/IPA.Old.html", + "api/IPA.html": { + "href": "api/IPA.html", "title": "", - "keywords": "Interfaces IEnhancedPlugin An enhanced version of the standard IPA plugin. IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed in Plugins." - }, - "api/IPA.Old.IEnhancedPlugin.html": { - "href": "api/IPA.Old.IEnhancedPlugin.html", - "title": "Interface IEnhancedPlugin", - "keywords": "Interface IEnhancedPlugin An enhanced version of the standard IPA plugin. Inherited Members IPlugin.Name IPlugin.Version IPlugin.OnApplicationStart() IPlugin.OnApplicationQuit() IPlugin.OnLevelWasLoaded(Int32) IPlugin.OnLevelWasInitialized(Int32) IPlugin.OnUpdate() IPlugin.OnFixedUpdate() Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IPA.IEnhancedPlugin\")] public interface IEnhancedPlugin : IPlugin Properties | Improve this Doc View Source Filter Gets a list of executables this plugin should be executed on (without the file ending) Declaration string[] Filter { get; } Property Value Type Description String [] Examples { \"PlayClub\", \"PlayClubStudio\" } Methods | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "keywords": "Classes InitAttribute Marks a method or a constructor as an inialization method. OnDisableAttribute Indicates that the target method should be called when the plugin is disabled. OnEnableAttribute Indicates that the target method should be called when the plugin is enabled. OnExitAttribute Indicates that the target method should be called when the game exits. OnStartAttribute Indicates that the target method should be called when the game starts. PluginAttribute Marks a class as being a BSIPA plugin. Enums RuntimeOptions Options that a plugin must specify to describe how it expects to be run." }, - "api/IPA.Logging.html": { - "href": "api/IPA.Logging.html", + "api/IPA.Utilities.html": { + "href": "api/IPA.Utilities.html", "title": "", - "keywords": "Classes Logger The logger base class. Provides the format for console logs. LoggerExtensions A class providing extensions for various loggers. LogPrinter The log printer's base class. StandardLogger The default (and standard) Logger implementation. Enums Logger.Level An enum specifying the level of the message. Resembles Syslog. Logger.LogLevel An enum providing log level filters." + "keywords": "Classes AlmostVersion A type that wraps SemVer.Version so that the string of the version is stored when the string is not a valid SemVer.Version . AlmostVersionConverter A ValueConverter for AlmostVersion s. CriticalSection Provides utilities for managing various critical sections. EnumerableExtensions Extensions for IEnumerable that don't currently exist in System.Linq . Extensions A class providing various extension methods. FieldAccessor A type containing utilities for accessing non-public fields of objects. PropertyAccessor A type containing utilities for accessing non-public properties of an object. Ref Utilities to create Ref using type inference. Ref A class to store a reference for passing to methods which cannot take ref parameters. ReflectionUtil A utility class providing reflection helper methods. UnityGame Provides some basic utility methods and properties of Beat Saber Utils A class providing static utility functions that in any other language would just exist . Structs CriticalSection.AutoExecuteSection A struct that allows using blocks to manage an execute section. Enums AlmostVersion.StoredAs Represents a storage type of either parsed SemVer.Version object or raw String . UnityGame.Release The different types of releases of the game. Delegates FieldAccessor.Accessor A delegate for a field accessor taking a T ref and returning a U ref. PropertyAccessor.Getter A getter for a property. PropertyAccessor.Setter A setter for a property." }, - "api/IPA.Logging.StandardLogger.html": { - "href": "api/IPA.Logging.StandardLogger.html", - "title": "Class StandardLogger", - "keywords": "Class StandardLogger The default (and standard) Logger implementation. Inheritance Object Logger StandardLogger Inherited Members Logger.LogFormat Logger.Log(Logger.Level, Exception) Logger.Trace(String) Logger.Trace(Exception) Logger.Debug(Exception) Logger.Info(String) Logger.Info(Exception) Logger.Notice(String) Logger.Notice(Exception) Logger.Warn(String) Logger.Warn(Exception) Logger.Error(String) Logger.Error(Exception) Logger.Critical(String) Logger.Critical(Exception) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public class StandardLogger : Logger Remarks StandardLogger uses a multi-threaded approach to logging. All actual I/O is done on another thread, where all messaged are guaranteed to be logged in the order they appeared. It is up to the printers to format them. This logger supports child loggers. Use GetChildLogger(Logger, String) to safely get a child. The modification of printers on a parent are reflected down the chain. Properties | Improve this Doc View Source ConsoleWriter The TextWriter for writing directly to the console window, or stdout if no window open. Declaration public static TextWriter ConsoleWriter { get; } Property Value Type Description TextWriter a TextWriter for the current primary text output | Improve this Doc View Source PrintFilter All levels defined by this filter will be sent to loggers. All others will be ignored. Declaration public static Logger.LogLevel PrintFilter { get; } Property Value Type Description Logger.LogLevel the global filter level Methods | Improve this Doc View Source AddPrinter(LogPrinter) Adds a log printer to the logger. Declaration public void AddPrinter(LogPrinter printer) Parameters Type Name Description LogPrinter printer the printer to add | Improve this Doc View Source Debug(String) An override to Debug(String) which shows the method that called it. Declaration public override void Debug(string message) Parameters Type Name Description String message the message to log Overrides Logger.Debug(String) See Also Log ( Logger.Level , String ) | Improve this Doc View Source Log(Logger.Level, String) Logs a specific message at a given level. Declaration public override void Log(Logger.Level level, string message) Parameters Type Name Description Logger.Level level the message level String message the message to log Overrides Logger.Log(Logger.Level, String) Extension Methods LoggerExtensions.GetChildLogger(Logger, String) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Utilities.Ref.html": { + "href": "api/IPA.Utilities.Ref.html", + "title": "Class Ref", + "keywords": "Class Ref Utilities to create Ref using type inference. Inheritance Object Ref Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Ref Methods | Improve this Doc View Source Create(T) Creates a Ref . Declaration public static Ref Create(T val) Parameters Type Name Description T val the default value. Returns Type Description Ref the new Ref . Type Parameters Name Description T the type to reference." }, - "api/IPA.Logging.LoggerExtensions.html": { - "href": "api/IPA.Logging.LoggerExtensions.html", - "title": "Class LoggerExtensions", - "keywords": "Class LoggerExtensions A class providing extensions for various loggers. Inheritance Object LoggerExtensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public static class LoggerExtensions Methods | Improve this Doc View Source GetChildLogger(Logger, String) Gets a child logger, if supported. Currently the only defined and supported logger is StandardLogger , and most plugins will only ever receive this anyway. Declaration public static Logger GetChildLogger(this Logger logger, string name) Parameters Type Name Description Logger logger the parent Logger String name the name of the child Returns Type Description Logger the child logger" + "api/IPA.Utilities.Ref-1.html": { + "href": "api/IPA.Utilities.Ref-1.html", + "title": "Class Ref", + "keywords": "Class Ref A class to store a reference for passing to methods which cannot take ref parameters. Inheritance Object Ref Implements IComparable IComparable < Ref > Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public class Ref : IComparable, IComparable> Type Parameters Name Description T the type of the value Constructors | Improve this Doc View Source Ref(T) Constructor. Declaration public Ref(T reference) Parameters Type Name Description T reference the initial value of the reference Properties | Improve this Doc View Source Error An exception that was generated while creating the value. Declaration public Exception Error { get; set; } Property Value Type Description Exception the error held in this Ref | Improve this Doc View Source Value The value of the reference Declaration public T Value { get; set; } Property Value Type Description T the value wrapped by this Ref Methods | Improve this Doc View Source CompareTo(T) Compares the wrapped object to the other object. Declaration public int CompareTo(T other) Parameters Type Name Description T other the object to compare to Returns Type Description Int32 the value of the comparison | Improve this Doc View Source CompareTo(Ref) Compares the wrapped object to the other wrapped object. Declaration public int CompareTo(Ref other) Parameters Type Name Description Ref other the wrapped object to compare to Returns Type Description Int32 the value of the comparison | Improve this Doc View Source Verify() Throws error if one was set. Declaration public void Verify() Operators | Improve this Doc View Source Implicit(T to Ref) Converts a value T to a reference to that object. Will overwrite the reference in the left hand expression if there is one. Declaration public static implicit operator Ref(T toConvert) Parameters Type Name Description T toConvert the value to wrap in the Ref Returns Type Description Ref the Ref wrapping the value | Improve this Doc View Source Implicit(Ref to T) Converts to referenced type, returning the stored reference. Declaration public static implicit operator T(Ref self) Parameters Type Name Description Ref self the object to be de-referenced Returns Type Description T the value referenced by the object Implements System.IComparable System.IComparable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Logging.Logger.html": { - "href": "api/IPA.Logging.Logger.html", - "title": "Class Logger", - "keywords": "Class Logger The logger base class. Provides the format for console logs. Inheritance Object Logger StandardLogger Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public abstract class Logger Properties | Improve this Doc View Source LogFormat The standard format for log messages. Declaration public static string LogFormat { get; protected set; } Property Value Type Description String the format for the standard loggers to print in Methods | Improve this Doc View Source Critical(Exception) Sends an exception as a critical message. Equivalent to Log(Level.Critical, e); Declaration public virtual void Critical(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Critical(String) Sends a critical message. Equivalent to Log(Level.Critical, message); Declaration public virtual void Critical(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Debug(Exception) Sends an exception as a debug message. Equivalent to Log(Level.Debug, e); Declaration public virtual void Debug(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Debug(String) Sends a debug message. Equivalent to Log(Level.Debug, message); Declaration public virtual void Debug(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Error(Exception) Sends an exception as an error message. Equivalent to Log(Level.Error, e); Declaration public virtual void Error(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Error(String) Sends an error message. Equivalent to Log(Level.Error, message); Declaration public virtual void Error(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Info(Exception) Sends an exception as an info message. Equivalent to Log(Level.Info, e); Declaration public virtual void Info(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Info(String) Sends an info message. Equivalent to Log(Level.Info, message); Declaration public virtual void Info(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Log(Logger.Level, Exception) A basic log function taking an exception to log. Declaration public virtual void Log(Logger.Level level, Exception e) Parameters Type Name Description Logger.Level level the level of the message Exception e the exception to log | Improve this Doc View Source Log(Logger.Level, String) A basic log function. Declaration public abstract void Log(Logger.Level level, string message) Parameters Type Name Description Logger.Level level the level of the message String message the message to log | Improve this Doc View Source Notice(Exception) Sends an exception as a notice message. Equivalent to Log(Level.Notice, e); Declaration public virtual void Notice(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Notice(String) Sends a notice message. Equivalent to Log(Level.Notice, message); Declaration public virtual void Notice(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Trace(Exception) Sends an exception as a trace message. Equivalent to Log(Level.Trace, e); Declaration public virtual void Trace(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Trace(String) Sends a trace message. Equivalent to Log(Level.Trace, message); Declaration public virtual void Trace(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Warn(Exception) Sends an exception as a warning message. Equivalent to Log(Level.Warning, e); Declaration public virtual void Warn(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Warn(String) Sends a warning message. Equivalent to Log(Level.Warning, message); Declaration public virtual void Warn(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) Extension Methods LoggerExtensions.GetChildLogger(Logger, String) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Utilities.PropertyAccessor-2.html": { + "href": "api/IPA.Utilities.PropertyAccessor-2.html", + "title": "Class PropertyAccessor", + "keywords": "Class PropertyAccessor A type containing utilities for accessing non-public properties of an object. Inheritance Object PropertyAccessor Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class PropertyAccessor Type Parameters Name Description T the type that the properties are on U the type of the property to access Methods | Improve this Doc View Source Get(T, String) Gets the value of the property identified by name on obj . Declaration public static U Get(T obj, string name) Parameters Type Name Description T obj the instance to access String name the name of the property Returns Type Description U the value of the property Exceptions Type Condition MissingMemberException when the property does not exist See Also Get(ref T, String) GetGetter(String) | Improve this Doc View Source Get(ref T, String) Gets the value of the property identified by name on obj . Declaration public static U Get(ref T obj, string name) Parameters Type Name Description T obj the instance to access String name the name of the property Returns Type Description U the value of the property Remarks The only reason to use this over Get(T, String) is if you are using a value type because it avoids a copy. Exceptions Type Condition MissingMemberException when the property does not exist See Also Get(T, String) GetGetter(String) | Improve this Doc View Source GetGetter(String) Gets a PropertyAccessor.Getter for the property identified by name . Declaration public static PropertyAccessor.Getter GetGetter(string name) Parameters Type Name Description String name the name of the property Returns Type Description PropertyAccessor.Getter <> a PropertyAccessor.Getter that can access that property Exceptions Type Condition MissingMemberException when the property does not exist | Improve this Doc View Source GetSetter(String) Gets a PropertyAccessor.Setter for the property identified by name . Declaration public static PropertyAccessor.Setter GetSetter(string name) Parameters Type Name Description String name the name of the property Returns Type Description PropertyAccessor.Setter <> a PropertyAccessor.Setter that can access that property Exceptions Type Condition MissingMemberException when the property does not exist | Improve this Doc View Source Set(T, String, U) Sets the value of the property identified by name on obj . Declaration public static void Set(T obj, string name, U val) Parameters Type Name Description T obj the instance to access String name the name of the property U val the new value of the property Remarks This overload cannot be safely used for value types. Use Set(ref T, String, U) instead. Exceptions Type Condition MissingMemberException when the property does not exist See Also Set(ref T, String, U) GetSetter(String) | Improve this Doc View Source Set(ref T, String, U) Sets the value of the property identified by name on obj . Declaration public static void Set(ref T obj, string name, U val) Parameters Type Name Description T obj the instance to access String name the name of the property U val the new value of the property Remarks This overload must be used for value types. Exceptions Type Condition MissingMemberException when the property does not exist See Also Set(T, String, U) GetSetter(String)" }, - "api/IPA.Logging.Logger.LogLevel.html": { - "href": "api/IPA.Logging.Logger.LogLevel.html", - "title": "Enum Logger.LogLevel", - "keywords": "Enum Logger.LogLevel An enum providing log level filters. Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax [Flags] public enum LogLevel : byte Fields Name Description All Shows all messages. CriticalOnly Only shows Critical messages. DebugOnly Only shows Debug messages. DebugUp Shows all messages debug and up. ErrorOnly Only shows Error messages. ErrorUp Shows all messages error and up. InfoOnly Only shows info messages. InfoUp Shows all messages info and up. None Allow no messages through. NoticeOnly Only shows notice messages. NoticeUp Shows all messages Notice and up. TraceOnly Only shows Trace messages. Undefined Used for when the level is undefined. WarningOnly Only shows Warning messages. WarningUp Shows all messages warning and up. Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" + "api/IPA.Utilities.PropertyAccessor-2.Setter.html": { + "href": "api/IPA.Utilities.PropertyAccessor-2.Setter.html", + "title": "Delegate PropertyAccessor.Setter", + "keywords": "Delegate PropertyAccessor.Setter A setter for a property. Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public delegate void Setter(ref T obj, U val); Parameters Type Name Description T obj the object it is a member of U val the new property value Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Logging.Logger.Level.html": { - "href": "api/IPA.Logging.Logger.Level.html", - "title": "Enum Logger.Level", - "keywords": "Enum Logger.Level An enum specifying the level of the message. Resembles Syslog. Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public enum Level : byte Fields Name Description Critical A critical error message. Debug A debug message. Error An error message. Info An informational message. None No associated level. These never get shown. Notice A notice. More significant than Info, but less than a warning. Trace A trace message. These are ignored incredibly early. Warning A warning message. Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" + "api/IPA.Utilities.EnumerableExtensions.html": { + "href": "api/IPA.Utilities.EnumerableExtensions.html", + "title": "Class EnumerableExtensions", + "keywords": "Class EnumerableExtensions Extensions for IEnumerable that don't currently exist in System.Linq . Inheritance Object EnumerableExtensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class EnumerableExtensions Methods | Improve this Doc View Source Append(IEnumerable, T) Adds a value to the end of the sequence. Declaration public static IEnumerable Append(this IEnumerable seq, T app) Parameters Type Name Description IEnumerable seq a sequence of values T app the value to append to seq Returns Type Description IEnumerable a new sequence ending with app Type Parameters Name Description T the type of the elements of seq | Improve this Doc View Source NonNull(IEnumerable) LINQ extension method that filters null elements out of an enumeration. Declaration public static IEnumerable NonNull(this IEnumerable self) where T : class Parameters Type Name Description IEnumerable self the enumeration to filter Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the type of the enumeration | Improve this Doc View Source NonNull(IEnumerable>) LINQ extension method that filters null elements from an enumeration of nullable types. Declaration public static IEnumerable NonNull(this IEnumerable self) where T : struct Parameters Type Name Description IEnumerable < Nullable > self the enumeration to filter Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the underlying type of the nullable enumeration | Improve this Doc View Source NonNull(IEnumerable, Func) LINQ extension method that filters null elements out of an enumeration based on a converter. Declaration public static IEnumerable NonNull(this IEnumerable self, Func pred) where U : class Parameters Type Name Description IEnumerable self the enumeration to filter Func pred the predicate to select for filtering Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the type of the enumeration U the type to compare to null | Improve this Doc View Source Prepend(IEnumerable, T) Adds a value to the beginning of the sequence. Declaration public static IEnumerable Prepend(this IEnumerable seq, T prep) Parameters Type Name Description IEnumerable seq a sequence of values T prep the value to prepend to seq Returns Type Description IEnumerable a new sequence beginning with prep Type Parameters Name Description T the type of the elements of seq" }, - "api/IPA.Loader.html": { - "href": "api/IPA.Loader.html", + "api/IPA.Utilities.CriticalSection.html": { + "href": "api/IPA.Utilities.CriticalSection.html", + "title": "Class CriticalSection", + "keywords": "Class CriticalSection Provides utilities for managing various critical sections. Inheritance Object CriticalSection Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class CriticalSection Methods | Improve this Doc View Source EnterExecuteSection() Enters a critical execution section. Does not nest. Declaration public static void EnterExecuteSection() | Improve this Doc View Source ExecuteSection() Creates an CriticalSection.AutoExecuteSection for automated management of an execute section. Declaration public static CriticalSection.AutoExecuteSection ExecuteSection() Returns Type Description CriticalSection.AutoExecuteSection the new CriticalSection.AutoExecuteSection that manages the section | Improve this Doc View Source ExitExecuteSection() Exits a critical execution section. Does not nest. Declaration public static void ExitExecuteSection()" + }, + "api/IPA.Utilities.CriticalSection.AutoExecuteSection.html": { + "href": "api/IPA.Utilities.CriticalSection.AutoExecuteSection.html", + "title": "Struct CriticalSection.AutoExecuteSection", + "keywords": "Struct CriticalSection.AutoExecuteSection A struct that allows using blocks to manage an execute section. Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public struct AutoExecuteSection : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Utilities.Async.html": { + "href": "api/IPA.Utilities.Async.html", "title": "", - "keywords": "Classes CannotRuntimeDisableException Indicates that a plugin cannot be disabled at runtime. Generally not considered an error, however. PluginInitInjector The type that handles value injecting into a plugin's initialization methods. PluginManager The manager class for all plugins. PluginMetadata A class which describes a loaded plugin. StateTransitionTransaction A class to represent a transaction for changing the state of loaded mods. Delegates PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event." + "keywords": "Classes Coroutines A class providing coroutine helpers. SingleThreadTaskScheduler A single-threaded task scheduler that runs all of its tasks on the same thread. Synchronization Utilities for inter-thread synchronization. All Locker method acquire their object immediately, and should only be used with langword_csharp_using to automatically release them. UnityMainThreadTaskScheduler A task scheduler that runs tasks on the Unity main thread via coroutines. Structs Synchronization.MutexLocker A locker for a Mutex that automatically releases when it is disposed. Create this with Lock(Mutex) . Synchronization.ReaderWriterLockSlimReadLocker A locker for a read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockRead(ReaderWriterLockSlim) . Synchronization.ReaderWriterLockSlimUpgradableReadLocker A locker for an upgradable read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockReadUpgradable(ReaderWriterLockSlim) . Synchronization.ReaderWriterLockSlimWriteLocker A locker for a write lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockWrite(ReaderWriterLockSlim) . Synchronization.SemaphoreLocker A locker for a Semaphore that automatically releases when it is disposed. Create this with Lock(Semaphore) . Synchronization.SemaphoreSlimAsyncLocker A locker for a SemaphoreSlim that was created asynchronously and automatically releases when it is disposed. Create this with LockAsync(SemaphoreSlim) . Synchronization.SemaphoreSlimLocker A locker for a SemaphoreSlim that automatically releases when it is disposed. Create this with Lock(SemaphoreSlim) ." }, - "api/IPA.Loader.StateTransitionTransaction.html": { - "href": "api/IPA.Loader.StateTransitionTransaction.html", - "title": "Class StateTransitionTransaction", - "keywords": "Class StateTransitionTransaction A class to represent a transaction for changing the state of loaded mods. Inheritance Object StateTransitionTransaction Implements IDisposable Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public sealed class StateTransitionTransaction : IDisposable Properties | Improve this Doc View Source DisabledPlugins Gets a list of plugins that are disabled according to this transaction's current state. Declaration public IEnumerable DisabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > Exceptions Type Condition ObjectDisposedException if this object has been disposed | Improve this Doc View Source EnabledPlugins Gets a list of plugins that are enabled according to this transaction's current state. Declaration public IEnumerable EnabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > Exceptions Type Condition ObjectDisposedException if this object has been disposed | Improve this Doc View Source WillNeedRestart Gets whether or not a game restart will be necessary to fully apply this transaction. Declaration public bool WillNeedRestart { get; } Property Value Type Description Boolean true if any mod who's state is changed cannot be changed at runtime, false otherwise Exceptions Type Condition ObjectDisposedException if this object has been disposed Methods | Improve this Doc View Source Commit() Commits this transaction to actual state, enabling and disabling plugins as necessary. Declaration public Task Commit() Returns Type Description Task a Task which completes whenever all disables complete Remarks After this completes, this transaction will be disposed. The Task that is returned will error if any of the mods being disabled error. It is up to the caller to handle these in a sane way, like logging them. If nothing else, do something like this: // get your transaction... var complete = transaction.Commit(); await complete.ContinueWith(t => { if (t.IsFaulted) Logger.log.Error($\"Error disabling plugins: {t.Exception}\"); }); If you are running in a coroutine, you can use WaitForTask(Task) instead of await . If you are running on the Unity main thread, this will block until all enabling is done, and will return a task representing the disables. Otherwise, the task returned represents both, and will not complete until Unity has done (possibly) several updates, depending on the number of plugins being disabled, and the time they take. Exceptions Type Condition ObjectDisposedException if this object has been disposed InvalidOperationException if the plugins' state no longer matches this transaction's original state | Improve this Doc View Source Disable(PluginMetadata, Boolean) Disables a plugin in this transaction. Declaration public bool Disable(PluginMetadata meta, bool autoDependents = true) Parameters Type Name Description PluginMetadata meta the plugin to disable Boolean autoDependents whether or not to automatically disable all dependents of the plugin Returns Type Description Boolean true if the transaction's state was changed, false otherwise Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable See Also Disable(PluginMetadata, out IEnumerable, Boolean) | Improve this Doc View Source Disable(PluginMetadata, out IEnumerable, Boolean) Disables a plugin in this transaction. Declaration public bool Disable(PluginMetadata meta, out IEnumerable enabledDependents, bool autoDependents = false) Parameters Type Name Description PluginMetadata meta the plugin to disable IEnumerable < PluginMetadata > enabledDependents null if successful, otherwise a set of plugins that need to be disabled first Boolean autoDependents whether or not to automatically disable all dependents of the plugin Returns Type Description Boolean true if the transaction's state was changed, false otherwise Remarks enabledDependents will only be set when autoDependents is false . Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable | Improve this Doc View Source Dispose() Disposes and discards this transaction without committing it. Declaration public void Dispose() | Improve this Doc View Source Enable(PluginMetadata, Boolean) Enables a plugin in this transaction. Declaration public bool Enable(PluginMetadata meta, bool autoDeps = true) Parameters Type Name Description PluginMetadata meta the plugin to enable Boolean autoDeps whether or not to automatically enable all dependencies of the plugin Returns Type Description Boolean true if the transaction's state was changed, false otherwise Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable See Also Enable(PluginMetadata, out IEnumerable, Boolean) | Improve this Doc View Source Enable(PluginMetadata, out IEnumerable, Boolean) Enables a plugin in this transaction. Declaration public bool Enable(PluginMetadata meta, out IEnumerable disabledDeps, bool autoDeps = false) Parameters Type Name Description PluginMetadata meta the plugin to enable IEnumerable < PluginMetadata > disabledDeps null if successful, otherwise a set of plugins that need to be enabled first Boolean autoDeps whether or not to automatically enable all dependencies Returns Type Description Boolean true if the transaction's state was changed, false otherwise Remarks disabledDeps will only be set when autoDeps is false . Exceptions Type Condition ObjectDisposedException if this object has been disposed ArgumentException if meta is not loadable | Improve this Doc View Source IsDisabled(PluginMetadata) Checks if a plugin is disabled according to this transaction's current state. Declaration public bool IsDisabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is disabled, false otherwise Remarks This should be roughly equivalent to DisabledPlugins.Contains(meta) , but more performant. This should also always return the inverse of IsEnabled(PluginMetadata) for valid plugins. Exceptions Type Condition ObjectDisposedException if this object has been disposed See Also DisabledPlugins IsEnabled(PluginMetadata) | Improve this Doc View Source IsEnabled(PluginMetadata) Checks if a plugin is enabled according to this transaction's current state. Declaration public bool IsEnabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is enabled, false otherwise Remarks This should be roughly equivalent to EnabledPlugins.Contains(meta) , but more performant. This should also always return the inverse of IsDisabled(PluginMetadata) for valid plugins. Exceptions Type Condition ObjectDisposedException if this object has been disposed See Also EnabledPlugins IsDisabled(PluginMetadata) Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html": { + "href": "api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html", + "title": "Struct Synchronization.SemaphoreLocker", + "keywords": "Struct Synchronization.SemaphoreLocker A locker for a Semaphore that automatically releases when it is disposed. Create this with Lock(Semaphore) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct SemaphoreLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization Lock(Semaphore)" }, - "api/IPA.Loader.PluginMetadata.html": { - "href": "api/IPA.Loader.PluginMetadata.html", - "title": "Class PluginMetadata", - "keywords": "Class PluginMetadata A class which describes a loaded plugin. Inheritance Object PluginMetadata Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public class PluginMetadata Properties | Improve this Doc View Source Assembly The assembly the plugin was loaded from. Declaration public Assembly Assembly { get; } Property Value Type Description Assembly the loaded Assembly that contains the plugin main type | Improve this Doc View Source Features The features this plugin requests. Declaration public IReadOnlyList Features { get; } Property Value Type Description IReadOnlyList < Feature > the list of features requested by the plugin | Improve this Doc View Source File The file the plugin was loaded from. Declaration public FileInfo File { get; } Property Value Type Description FileInfo the file the plugin was loaded from | Improve this Doc View Source Id The BeatMods ID of the plugin, or null if it doesn't have one. Declaration public string Id { get; } Property Value Type Description String the updater ID of the plugin | Improve this Doc View Source IsBare Whether or not this metadata object represents a bare manifest. Declaration public bool IsBare { get; } Property Value Type Description Boolean true if it is bare, false otherwise | Improve this Doc View Source Name The human readable name of the plugin. Declaration public string Name { get; } Property Value Type Description String the name of the plugin | Improve this Doc View Source PluginType The TypeDefinition for the main type of the plugin. Declaration public TypeDefinition PluginType { get; } Property Value Type Description Mono.Cecil.TypeDefinition the Cecil definition for the plugin main type | Improve this Doc View Source RuntimeOptions The RuntimeOptions that the plugin specified in its PluginAttribute . Declaration public RuntimeOptions RuntimeOptions { get; } Property Value Type Description RuntimeOptions | Improve this Doc View Source Version The version of the plugin. Declaration public Version Version { get; } Property Value Type Description SemVer.Version the version of the plugin Methods | Improve this Doc View Source ToString() Gets all of the metadata as a readable string. Declaration public override string ToString() Returns Type Description String the readable printable metadata string Overrides Object.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Config.Stores.Converters.NullableConverter-2.html": { + "href": "api/IPA.Config.Stores.Converters.NullableConverter-2.html", + "title": "Class NullableConverter", + "keywords": "Class NullableConverter A converter for a Nullable that default-constructs a converter of type TConverter to use as the underlying converter. Use this in the UseConverterAttribute . Inheritance Object ValueConverter < Nullable > NullableConverter NullableConverter Implements IValueConverter Inherited Members NullableConverter.FromValue(Value, Object) NullableConverter.ToValue(Nullable, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class NullableConverter : NullableConverter, IValueConverter where T : struct where TConverter : ValueConverter, new() Type Parameters Name Description T the underlying type of the Nullable TConverter the type to use as an underlying converter Constructors | Improve this Doc View Source NullableConverter() Creates a converter with a new TConverter as the underlying converter. Declaration public NullableConverter() See Also NullableConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also NullableConverter " }, - "api/IPA.Loader.PluginManager.html": { - "href": "api/IPA.Loader.PluginManager.html", - "title": "Class PluginManager", - "keywords": "Class PluginManager The manager class for all plugins. Inheritance Object PluginManager Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginManager Properties | Improve this Doc View Source AllPlugins Gets a list of all enabled BSIPA plugins. Declaration public static IEnumerable AllPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > a collection of all enabled plugins as PluginMetadata s | Improve this Doc View Source DisabledPlugins Gets a list of disabled BSIPA plugins. Declaration public static IEnumerable DisabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > a collection of all disabled plugins as PluginMetadata | Improve this Doc View Source Plugins An IEnumerable of old IPA plugins. Declaration [Obsolete(\"I mean, IPlugin shouldn't be used, so why should this? Not renaming to extend support for old plugins.\")] public static IEnumerable Plugins { get; } Property Value Type Description IEnumerable < IPlugin > all legacy plugin instances Methods | Improve this Doc View Source GetDisabledPlugin(String) Gets a disabled plugin's metadata by its name. Declaration public static PluginMetadata GetDisabledPlugin(string name) Parameters Type Name Description String name the name of the disabled plugin to get Returns Type Description PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetDisabledPluginFromId(String) Gets a disabled plugin's metadata by its ID. Declaration public static PluginMetadata GetDisabledPluginFromId(string name) Parameters Type Name Description String name the ID of the disabled plugin to get Returns Type Description PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetPlugin(String) Gets info about the enabled plugin with the specified name. Declaration public static PluginMetadata GetPlugin(string name) Parameters Type Name Description String name the name of the plugin to get (must be an exact match) Returns Type Description PluginMetadata the plugin metadata for the requested plugin or null if it doesn't exist or is disabled | Improve this Doc View Source GetPluginFromId(String) Gets info about the enabled plugin with the specified ID. Declaration public static PluginMetadata GetPluginFromId(string name) Parameters Type Name Description String name the ID name of the plugin to get (must be an exact match) Returns Type Description PluginMetadata the plugin metadata for the requested plugin or null if it doesn't exist or is disabled | Improve this Doc View Source IsDisabled(PluginMetadata) Checks if a given plugin is disabled. Declaration public static bool IsDisabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is disabled, false otherwise. | Improve this Doc View Source IsEnabled(PluginMetadata) Checks if a given plugin is enabled. Declaration public static bool IsEnabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is enabled, false otherwise. | Improve this Doc View Source PluginStateTransaction() Creates a new transaction for mod enabling and disabling mods simultaneously. Declaration public static StateTransitionTransaction PluginStateTransaction() Returns Type Description StateTransitionTransaction a new StateTransitionTransaction that captures the current state of loaded mods Events | Improve this Doc View Source PluginDisabled Called whenever a plugin is disabled. Declaration public static event PluginManager.PluginDisableDelegate PluginDisabled Event Type Type Description PluginManager.PluginDisableDelegate | Improve this Doc View Source PluginEnabled Called whenever a plugin is enabled. Declaration public static event PluginManager.PluginEnableDelegate PluginEnabled Event Type Type Description PluginManager.PluginEnableDelegate" + "api/IPA.Config.Stores.Converters.ListConverter-1.html": { + "href": "api/IPA.Config.Stores.Converters.ListConverter-1.html", + "title": "Class ListConverter", + "keywords": "Class ListConverter A CollectionConverter for a List . Inheritance Object ValueConverter < List > CollectionConverter > ListConverter ListConverter Implements IValueConverter Inherited Members CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(List, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(List, Object) ValueConverter>.ToValue(List, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class ListConverter : CollectionConverter>, IValueConverter Type Parameters Name Description T the element type of the List Constructors | Improve this Doc View Source ListConverter() Creates an ListConverter using the default converter for T . Declaration public ListConverter() See Also CollectionConverter() | Improve this Doc View Source ListConverter(ValueConverter) Creates an ListConverter using the specified underlying converter for values. Declaration public ListConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the underlying ValueConverter to use for the values Methods | Improve this Doc View Source Create(Int32, Object) Creates a new List for deserialization. Declaration protected override List Create(int size, object parent) Parameters Type Name Description Int32 size the size to initialize it to Object parent the object that will own the new object Returns Type Description List the new List Overrides IPA.Config.Stores.Converters.CollectionConverter>.Create(System.Int32, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " }, - "api/IPA.Loader.PluginManager.PluginEnableDelegate.html": { - "href": "api/IPA.Loader.PluginManager.PluginEnableDelegate.html", - "title": "Delegate PluginManager.PluginEnableDelegate", - "keywords": "Delegate PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate void PluginEnableDelegate(PluginMetadata plugin, bool needsRestart); Parameters Type Name Description PluginMetadata plugin the plugin that was enabled Boolean needsRestart whether it needs a restart to take effect Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Config.Stores.Converters.ISetConverter-2.html": { + "href": "api/IPA.Config.Stores.Converters.ISetConverter-2.html", + "title": "Class ISetConverter", + "keywords": "Class ISetConverter An ISetConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter < ISet > CollectionConverter > ISetConverter ISetConverter Implements IValueConverter Inherited Members ISetConverter.Create(Int32, Object) CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(ISet, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(ISet, Object) ValueConverter>.ToValue(ISet, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class ISetConverter : ISetConverter, IValueConverter where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TConverter the type of the converter to use for T Constructors | Improve this Doc View Source ISetConverter() Creates an ISetConverter using a default constructed TConverter element type. Equivalent to calling ISetConverter(ValueConverter) with a default-constructed TConverter . Declaration public ISetConverter() See Also ISetConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also ISetConverter " }, - "api/IPA.Loader.PluginManager.PluginDisableDelegate.html": { - "href": "api/IPA.Loader.PluginManager.PluginDisableDelegate.html", - "title": "Delegate PluginManager.PluginDisableDelegate", - "keywords": "Delegate PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate void PluginDisableDelegate(PluginMetadata plugin, bool needsRestart); Parameters Type Name Description PluginMetadata plugin the plugin that was disabled Boolean needsRestart whether it needs a restart to take effect Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Config.Stores.Converters.IListConverter-1.html": { + "href": "api/IPA.Config.Stores.Converters.IListConverter-1.html", + "title": "Class IListConverter", + "keywords": "Class IListConverter A CollectionConverter for an IList , creating a List when deserializing. Inheritance Object ValueConverter < IList > CollectionConverter > IListConverter IListConverter Implements IValueConverter Inherited Members CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(IList, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(IList, Object) ValueConverter>.ToValue(IList, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class IListConverter : CollectionConverter>, IValueConverter Type Parameters Name Description T the element type of the IList Constructors | Improve this Doc View Source IListConverter() Creates an IListConverter using the default converter for T . Declaration public IListConverter() See Also CollectionConverter() | Improve this Doc View Source IListConverter(ValueConverter) Creates an IListConverter using the specified underlying converter for values. Declaration public IListConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the underlying ValueConverter to use for the values Methods | Improve this Doc View Source Create(Int32, Object) Creates a new IList (a List ) for deserialization. Declaration protected override IList Create(int size, object parent) Parameters Type Name Description Int32 size the size to initialize it to Object parent the object that will own the new object Returns Type Description IList the new IList Overrides IPA.Config.Stores.Converters.CollectionConverter>.Create(System.Int32, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " + }, + "api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html": { + "href": "api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html", + "title": "Class CustomObjectConverter", + "keywords": "Class CustomObjectConverter A ValueConverter for objects normally serialized to config via Generated(Config, Boolean) . Inheritance Object ValueConverter CustomObjectConverter Implements IValueConverter Inherited Members ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class CustomObjectConverter : ValueConverter, IValueConverter where T : class Type Parameters Name Description T the same type parameter that would be passed into Generated(Config, Boolean) Methods | Improve this Doc View Source Deserialize(Value, Object) Deserializes value into a T with the given parent . Declaration public static T Deserialize(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the parent object that will own the deserialized value Returns Type Description T the deserialized value See Also FromValue ( Value , Object ) | Improve this Doc View Source FromValue(Value, Object) Deserializes value into a T with the given parent . Declaration public override T FromValue(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the parent object that will own the deserialized value Returns Type Description T the deserialized value Overrides IPA.Config.Stores.ValueConverter.FromValue(IPA.Config.Data.Value, System.Object) See Also FromValue ( Value , Object ) | Improve this Doc View Source Serialize(T, Object) Serializes obj into a Value structure, given parent . Declaration public static Value Serialize(T obj, object parent) Parameters Type Name Description T obj the object to serialize Object parent the parent object that owns obj Returns Type Description Value the Value tree that represents obj See Also ToValue (T, Object ) | Improve this Doc View Source ToValue(T, Object) Serializes obj into a Value structure, given parent . Declaration public override Value ToValue(T obj, object parent) Parameters Type Name Description T obj the object to serialize Object parent the parent object that owns obj Returns Type Description Value the Value tree that represents obj Overrides IPA.Config.Stores.ValueConverter.ToValue(T, System.Object) See Also ToValue (T, Object ) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Generated ( Config , Boolean )" + }, + "api/IPA.Config.Stores.Converters.CollectionConverter-3.html": { + "href": "api/IPA.Config.Stores.Converters.CollectionConverter-3.html", + "title": "Class CollectionConverter", + "keywords": "Class CollectionConverter A CollectionConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter CollectionConverter CollectionConverter Implements IValueConverter Inherited Members CollectionConverter.BaseConverter CollectionConverter.Create(Int32, Object) CollectionConverter.PopulateFromValue(TCollection, List, Object) CollectionConverter.FromValue(Value, Object) CollectionConverter.ToValue(TCollection, Object) ValueConverter.ToValue(TCollection, Object) ValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class CollectionConverter : CollectionConverter, IValueConverter where TCollection : ICollection where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TCollection the type of the colleciton TConverter the type of the converter to use for T Constructors | Improve this Doc View Source CollectionConverter() Creates a CollectionConverter using a default constructed TConverter element type. Equivalent to calling CollectionConverter(ValueConverter) with a default-constructed TConverter . Declaration public CollectionConverter() See Also CollectionConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " + }, + "api/IPA.Config.Stores.Converters.CollectionConverter-2.html": { + "href": "api/IPA.Config.Stores.Converters.CollectionConverter-2.html", + "title": "Class CollectionConverter", + "keywords": "Class CollectionConverter A base class for all ICollection type converters, providing most of the functionality. Inheritance Object ValueConverter CollectionConverter CollectionConverter IListConverter ISetConverter ListConverter Implements IValueConverter Inherited Members ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class CollectionConverter : ValueConverter, IValueConverter where TCollection : ICollection Type Parameters Name Description T the type of the items in the collection TCollection the instantiated type of collection Constructors | Improve this Doc View Source CollectionConverter() Creates a CollectionConverter using the default converter for the element type. Equivalent to calling CollectionConverter(ValueConverter) with Default . Declaration public CollectionConverter() See Also CollectionConverter(ValueConverter) | Improve this Doc View Source CollectionConverter(ValueConverter) Creates a CollectionConverter using the specified underlying converter. Declaration public CollectionConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the ValueConverter to use to convert the values Properties | Improve this Doc View Source BaseConverter Gets the converter for the collection's value type. Declaration protected ValueConverter BaseConverter { get; } Property Value Type Description ValueConverter Methods | Improve this Doc View Source Create(Int32, Object) Creates a collection of type TCollection using the size and parent . Declaration protected virtual TCollection Create(int size, object parent) Parameters Type Name Description Int32 size the initial size of the collecion Object parent the object that will own the new collection Returns Type Description TCollection a new instance of TCollection See Also FromValue ( Value , Object ) | Improve this Doc View Source FromValue(Value, Object) Deserializes a List in value into a new TCollection owned by parent . Declaration public override TCollection FromValue(Value value, object parent) Parameters Type Name Description Value value the List to convert to a TCollection Object parent the object that will own the resulting TCollection Returns Type Description TCollection a new TCollection holding the deserialized content of value Overrides IPA.Config.Stores.ValueConverter.FromValue(IPA.Config.Data.Value, System.Object) See Also FromValue ( Value , Object ) | Improve this Doc View Source PopulateFromValue(TCollection, List, Object) Populates the colleciton col with the deserialized values from list with the parent parent . Declaration protected void PopulateFromValue(TCollection col, List list, object parent) Parameters Type Name Description TCollection col the collection to populate List list the values to populate it with Object parent the object that will own the new objects See Also FromValue ( Value , Object ) | Improve this Doc View Source ToValue(TCollection, Object) Serializes a TCollection into a List . Declaration public override Value ToValue(TCollection obj, object parent) Parameters Type Name Description TCollection obj the TCollection to serialize Object parent the object owning obj Returns Type Description Value the List that obj was serialized into Overrides IPA.Config.Stores.ValueConverter.ToValue(TCollection, System.Object) See Also ToValue (T, Object ) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html": { + "href": "api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html", + "title": "Class SerializedNameAttribute", + "keywords": "Class SerializedNameAttribute Specifies a name for the serialized field or property in an object being wrapped by Generated(Config, Boolean) that is different from the member name itself. Inheritance Object Attribute SerializedNameAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Attributes Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class SerializedNameAttribute : Attribute, _Attribute Examples When serializing the following object, we might get the JSON that follows. public class PluginConfig { public virtual bool BooleanField { get; set; } = true; } { \"BooleanField\": true } However, if we were to add a SerializedNameAttribute to that field, we would get the following. public class PluginConfig { [SerializedName(\"bool\")] public virtual bool BooleanField { get; set; } = true; } { \"bool\": true } Constructors | Improve this Doc View Source SerializedNameAttribute(String) Creates a new SerializedNameAttribute with the given Name . Declaration public SerializedNameAttribute(string name) Parameters Type Name Description String name the value to assign to Name Properties | Improve this Doc View Source Name Gets the name to replace the member name with. Declaration public string Name { get; } Property Value Type Description String Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + }, + "api/IPA.Config.Config.PreferAttribute.html": { + "href": "api/IPA.Config.Config.PreferAttribute.html", + "title": "Class Config.PreferAttribute", + "keywords": "Class Config.PreferAttribute Specifies that a particular parameter is preferred to use a particular IConfigProvider . If it is not available, also specifies backups. If none are available, the default is used. Inheritance Object Attribute Config.PreferAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Parameter)] public sealed class PreferAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source PreferAttribute(String[]) Constructs the attribute with a specific preference list. Each entry is the extension without a '.' Declaration public PreferAttribute(params string[] preference) Parameters Type Name Description String [] preference The preferences in order of preference. Properties | Improve this Doc View Source PreferenceOrder The order of preference for the config type. Declaration public string[] PreferenceOrder { get; } Property Value Type Description String [] the list of config extensions in order of preference Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Loader.PluginInitInjector.html": { - "href": "api/IPA.Loader.PluginInitInjector.html", - "title": "Class PluginInitInjector", - "keywords": "Class PluginInitInjector The type that handles value injecting into a plugin's initialization methods. Inheritance Object PluginInitInjector Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginInitInjector Remarks The default injectors and what they provide are shown in this table. Parameter Type Injected Value Logger A StandardLogger specialized for the plugin being injected PluginMetadata The PluginMetadata of the plugin being injected Config A Config object for the plugin being injected. These parameters may have Config.NameAttribute and Config.PreferAttribute to control how it is constructed. For all of the default injectors, only one of each will be generated, and any later parameters will recieve the same value as the first one. Methods | Improve this Doc View Source AddInjector(Type, PluginInitInjector.InjectParameter) Adds an injector to be used when calling future plugins' Init methods. Declaration public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector) Parameters Type Name Description Type type the type of the parameter. PluginInitInjector.InjectParameter injector the function to call for injection." + "api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html": { + "href": "api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html", + "title": "Class MarkdownView", + "keywords": "Class MarkdownView A UI component that renders CommonMark Markdown in-game. Inheritance Object UnityEngine.Object UnityEngine.Component UnityEngine.Behaviour UnityEngine.MonoBehaviour MarkdownView Inherited Members UnityEngine.MonoBehaviour.IsInvoking() UnityEngine.MonoBehaviour.CancelInvoke() UnityEngine.MonoBehaviour.Invoke(System.String, System.Single) UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single) UnityEngine.MonoBehaviour.CancelInvoke(System.String) UnityEngine.MonoBehaviour.IsInvoking(System.String) UnityEngine.MonoBehaviour.StartCoroutine(System.String) UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object) UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine) UnityEngine.MonoBehaviour.StopCoroutine(System.String) UnityEngine.MonoBehaviour.StopAllCoroutines() UnityEngine.MonoBehaviour.print(System.Object) UnityEngine.MonoBehaviour.useGUILayout UnityEngine.Behaviour.enabled UnityEngine.Behaviour.isActiveAndEnabled UnityEngine.Component.GetComponent(System.Type) UnityEngine.Component.GetComponent() UnityEngine.Component.GetComponent(System.String) UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentInChildren(System.Type) UnityEngine.Component.GetComponentInChildren(System.Boolean) UnityEngine.Component.GetComponentInChildren() UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInChildren(System.Type) UnityEngine.Component.GetComponentsInChildren(System.Boolean) UnityEngine.Component.GetComponentsInChildren(System.Boolean, System.Collections.Generic.List) UnityEngine.Component.GetComponentsInChildren() UnityEngine.Component.GetComponentsInChildren(System.Collections.Generic.List) UnityEngine.Component.GetComponentInParent(System.Type) UnityEngine.Component.GetComponentInParent() UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInParent(System.Type) UnityEngine.Component.GetComponentsInParent(System.Boolean) UnityEngine.Component.GetComponentsInParent(System.Boolean, System.Collections.Generic.List) UnityEngine.Component.GetComponentsInParent() UnityEngine.Component.GetComponents(System.Type) UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List) UnityEngine.Component.GetComponents(System.Collections.Generic.List) UnityEngine.Component.GetComponents() UnityEngine.Component.CompareTag(System.String) UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessageUpwards(System.String, System.Object) UnityEngine.Component.SendMessageUpwards(System.String) UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessage(System.String, System.Object) UnityEngine.Component.SendMessage(System.String) UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.BroadcastMessage(System.String, System.Object) UnityEngine.Component.BroadcastMessage(System.String) UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.transform UnityEngine.Component.gameObject UnityEngine.Component.tag UnityEngine.Object.GetInstanceID() UnityEngine.Object.GetHashCode() UnityEngine.Object.Equals(System.Object) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform) UnityEngine.Object.Instantiate(UnityEngine.Object) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean) UnityEngine.Object.Instantiate(T) UnityEngine.Object.Instantiate(T, UnityEngine.Vector3, UnityEngine.Quaternion) UnityEngine.Object.Instantiate(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform) UnityEngine.Object.Instantiate(T, UnityEngine.Transform) UnityEngine.Object.Instantiate(T, UnityEngine.Transform, System.Boolean) UnityEngine.Object.Destroy(UnityEngine.Object, System.Single) UnityEngine.Object.Destroy(UnityEngine.Object) UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean) UnityEngine.Object.DestroyImmediate(UnityEngine.Object) UnityEngine.Object.FindObjectsOfType(System.Type) UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object) UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single) UnityEngine.Object.DestroyObject(UnityEngine.Object) UnityEngine.Object.FindSceneObjectsOfType(System.Type) UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type) UnityEngine.Object.FindObjectsOfType() UnityEngine.Object.FindObjectOfType() UnityEngine.Object.FindObjectsOfTypeAll(System.Type) UnityEngine.Object.FindObjectOfType(System.Type) UnityEngine.Object.ToString() UnityEngine.Object.name UnityEngine.Object.hideFlags Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : BSIPA_ModList.UI.ViewControllers Assembly : BSIPA-ModList.dll Syntax [RequireComponent(typeof(RectTransform))] public class MarkdownView : MonoBehaviour Constructors | Improve this Doc View Source MarkdownView() Creates a new MarkdownView . Should never be called directly. Instead, use UnityEngine.GameObject.AddComponent``1 . Declaration public MarkdownView() Fields | Improve this Doc View Source HasEmbeddedImage This function will be called whenever attempting to resolve an image URI, to ensure that the image exists in the embedded assembly. Declaration public Func HasEmbeddedImage Field Value Type Description Func < String , Boolean > a delegate for the function to call Properties | Improve this Doc View Source Markdown The text to be rendered. Declaration public string Markdown { get; set; } Property Value Type Description String the text to render as Markdown Remarks When this is assigned, the object is marked dirty. It will re-render on the next Update tick. | Improve this Doc View Source rectTransform A convenience property to access the UnityEngine.RectTransform on the UnityEngine.GameObject this is on. Declaration public RectTransform rectTransform { get; } Property Value Type Description UnityEngine.RectTransform the UnityEngine.RectTransform associated with this component Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.CopyComponent(Component, Type, GameObject, Type) ReflectionUtil.CopyComponent(Component, GameObject, Type)" }, - "api/IPA.Old.IPlugin.html": { - "href": "api/IPA.Old.IPlugin.html", - "title": "Interface IPlugin", - "keywords": "Interface IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed in Plugins. Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IBeatSaberPlugin\")] public interface IPlugin Properties | Improve this Doc View Source Name Gets the name of the plugin. Declaration string Name { get; } Property Value Type Description String | Improve this Doc View Source Version Gets the version of the plugin. Declaration string Version { get; } Property Value Type Description String Methods | Improve this Doc View Source OnApplicationQuit() Gets invoked when the application is closed. Declaration void OnApplicationQuit() | Improve this Doc View Source OnApplicationStart() Gets invoked when the application is started. Declaration void OnApplicationStart() | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | Improve this Doc View Source OnLevelWasInitialized(Int32) Gets invoked after the first update cycle after a level was loaded. Declaration void OnLevelWasInitialized(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnLevelWasLoaded(Int32) Gets invoked whenever a level is loaded. Declaration void OnLevelWasLoaded(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Utilities.Utils.html": { + "href": "api/IPA.Utilities.Utils.html", + "title": "Class Utils", + "keywords": "Class Utils A class providing static utility functions that in any other language would just exist . Inheritance Object Utils Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Utils Properties | Improve this Doc View Source CanUseDateTimeNowSafely Whether you can safely use Now without Mono throwing a fit. Declaration public static bool CanUseDateTimeNowSafely { get; } Property Value Type Description Boolean true if you can use Now safely, false otherwise Methods | Improve this Doc View Source ByteArrayToString(Byte[]) Converts a byte array to a hex string. Declaration public static string ByteArrayToString(byte[] ba) Parameters Type Name Description Byte [] ba the byte array Returns Type Description String the hex form of the array | Improve this Doc View Source CopyAll(DirectoryInfo, DirectoryInfo, String, Func) Copies all files from source to target . Declaration public static void CopyAll(DirectoryInfo source, DirectoryInfo target, string appendFileName = \"\", Func onCopyException = null) Parameters Type Name Description DirectoryInfo source the source directory DirectoryInfo target the destination directory String appendFileName the filename of the file to append together Func < Exception , FileInfo , Boolean > onCopyException a delegate called when there is an error copying. Return true to keep going. | Improve this Doc View Source CurrentTime() Gets the current DateTime if supported, otherwise, if Mono would throw a fit, returns MinValue plus some value, such that each time it is called the value will be greater than the previous result. Not suitable for timing. Declaration public static DateTime CurrentTime() Returns Type Description DateTime the current DateTime if supported, otherwise some indeterminant increasing value. | Improve this Doc View Source GetRelativePath(String, String) Gets a path relative to the provided folder. Declaration public static string GetRelativePath(string file, string folder) Parameters Type Name Description String file the file to relativize String folder the source folder Returns Type Description String a path to get from folder to file | Improve this Doc View Source StringToByteArray(String) Converts a hex string to a byte array. Declaration public static byte[] StringToByteArray(string hex) Parameters Type Name Description String hex the hex stream Returns Type Description Byte [] the corresponding byte array | Improve this Doc View Source UnsafeCompare(Byte[], Byte[]) Uses unsafe code to compare 2 byte arrays quickly. Declaration public static bool UnsafeCompare(byte[] a1, byte[] a2) Parameters Type Name Description Byte [] a1 array 1 Byte [] a2 array 2 Returns Type Description Boolean whether or not they are byte-for-byte equal | Improve this Doc View Source VersionCompareNoPrerelease(Version, Version) Compares a pair of SemVer.Version s ignoring both the prerelease and build fields. Declaration public static int VersionCompareNoPrerelease(Version l, Version r) Parameters Type Name Description SemVer.Version l the left value SemVer.Version r the right value Returns Type Description Int32 < 0 if l is less than r, 0 if they are equal in the numeric portion, or > 0 if l is greater than r" }, "api/IPA.Utilities.UnityGame.html": { "href": "api/IPA.Utilities.UnityGame.html", @@ -294,26 +469,6 @@ "title": "Class ReflectionUtil", "keywords": "Class ReflectionUtil A utility class providing reflection helper methods. Inheritance Object ReflectionUtil Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class ReflectionUtil Methods | Improve this Doc View Source CopyComponent(Component, Type, GameObject, Type) Copies a component original to a component of overridingType on the destination UnityEngine.GameObject . Declaration public static Component CopyComponent(this Component original, Type overridingType, GameObject destination, Type originalTypeOverride = null) Parameters Type Name Description UnityEngine.Component original the original component Type overridingType the new component's type UnityEngine.GameObject destination the destination GameObject Type originalTypeOverride overrides the source component type (for example, to a superclass) Returns Type Description UnityEngine.Component the copied component | Improve this Doc View Source CopyComponent(Component, GameObject, Type) A generic version of CopyComponent(Component, Type, GameObject, Type) . Declaration public static T CopyComponent(this Component original, GameObject destination, Type originalTypeOverride = null) where T : Component Parameters Type Name Description UnityEngine.Component original the original component UnityEngine.GameObject destination the destination game object Type originalTypeOverride overrides the source component type (for example, to a superclass) Returns Type Description T the copied component Type Parameters Name Description T the overriding type See Also CopyComponent(Component, Type, GameObject, Type) | Improve this Doc View Source GetField(T, String) Gets the value of a field. Declaration public static U GetField(this T obj, string fieldName) Parameters Type Name Description T obj the object instance to pull from String fieldName the name of the field to read Returns Type Description U the value of the field Type Parameters Name Description U the type of the field (result casted) T the type to get the field from Exceptions Type Condition MissingFieldException if fieldName does not exist on T See Also Get(ref T, String) | Improve this Doc View Source GetProperty(T, String) Gets a property on the target object, as gotten from T . Declaration public static U GetProperty(this T obj, string propertyName) Parameters Type Name Description T obj the object instance String propertyName the property to get Returns Type Description U the value of the property Type Parameters Name Description U the type of the property to get T the type to get the property from Exceptions Type Condition MissingMemberException if propertyName does not exist on T See Also Get(ref T, String) | Improve this Doc View Source InvokeMethod(T, String, Object[]) Invokes a method from T on an object. Declaration public static U InvokeMethod(this T obj, string methodName, params object[] args) Parameters Type Name Description T obj the object instance String methodName the method's name Object [] args the method arguments Returns Type Description U the return value Type Parameters Name Description U the type of the property to get T the type to search for the method on Exceptions Type Condition MissingMethodException if methodName does not exist on T | Improve this Doc View Source SetField(T, String, U) Sets a field on the target object, as gotten from T . Declaration public static void SetField(this T obj, string fieldName, U value) Parameters Type Name Description T obj the object instance String fieldName the field to set U value the value to set it to Type Parameters Name Description T the type to get the field from U the type of the field to set Exceptions Type Condition MissingFieldException if fieldName does not exist on T See Also Set(ref T, String, U) | Improve this Doc View Source SetProperty(T, String, U) Sets a property on the target object, as gotten from T . Declaration public static void SetProperty(this T obj, string propertyName, U value) Parameters Type Name Description T obj the object instance String propertyName the property to set U value the value to set it to Type Parameters Name Description T the type to get the property from U the type of the property to set Exceptions Type Condition MissingMemberException if propertyName does not exist on T See Also Set(ref T, String, U)" }, - "api/IPA.Utilities.Ref.html": { - "href": "api/IPA.Utilities.Ref.html", - "title": "Class Ref", - "keywords": "Class Ref Utilities to create Ref using type inference. Inheritance Object Ref Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Ref Methods | Improve this Doc View Source Create(T) Creates a Ref . Declaration public static Ref Create(T val) Parameters Type Name Description T val the default value. Returns Type Description Ref the new Ref . Type Parameters Name Description T the type to reference." - }, - "api/IPA.Utilities.Ref-1.html": { - "href": "api/IPA.Utilities.Ref-1.html", - "title": "Class Ref", - "keywords": "Class Ref A class to store a reference for passing to methods which cannot take ref parameters. Inheritance Object Ref Implements IComparable IComparable < Ref > Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public class Ref : IComparable, IComparable> Type Parameters Name Description T the type of the value Constructors | Improve this Doc View Source Ref(T) Constructor. Declaration public Ref(T reference) Parameters Type Name Description T reference the initial value of the reference Properties | Improve this Doc View Source Error An exception that was generated while creating the value. Declaration public Exception Error { get; set; } Property Value Type Description Exception the error held in this Ref | Improve this Doc View Source Value The value of the reference Declaration public T Value { get; set; } Property Value Type Description T the value wrapped by this Ref Methods | Improve this Doc View Source CompareTo(T) Compares the wrapped object to the other object. Declaration public int CompareTo(T other) Parameters Type Name Description T other the object to compare to Returns Type Description Int32 the value of the comparison | Improve this Doc View Source CompareTo(Ref) Compares the wrapped object to the other wrapped object. Declaration public int CompareTo(Ref other) Parameters Type Name Description Ref other the wrapped object to compare to Returns Type Description Int32 the value of the comparison | Improve this Doc View Source Verify() Throws error if one was set. Declaration public void Verify() Operators | Improve this Doc View Source Implicit(T to Ref) Converts a value T to a reference to that object. Will overwrite the reference in the left hand expression if there is one. Declaration public static implicit operator Ref(T toConvert) Parameters Type Name Description T toConvert the value to wrap in the Ref Returns Type Description Ref the Ref wrapping the value | Improve this Doc View Source Implicit(Ref to T) Converts to referenced type, returning the stored reference. Declaration public static implicit operator T(Ref self) Parameters Type Name Description Ref self the object to be de-referenced Returns Type Description T the value referenced by the object Implements System.IComparable System.IComparable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Utilities.PropertyAccessor-2.html": { - "href": "api/IPA.Utilities.PropertyAccessor-2.html", - "title": "Class PropertyAccessor", - "keywords": "Class PropertyAccessor A type containing utilities for accessing non-public properties of an object. Inheritance Object PropertyAccessor Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class PropertyAccessor Type Parameters Name Description T the type that the properties are on U the type of the property to access Methods | Improve this Doc View Source Get(T, String) Gets the value of the property identified by name on obj . Declaration public static U Get(T obj, string name) Parameters Type Name Description T obj the instance to access String name the name of the property Returns Type Description U the value of the property Exceptions Type Condition MissingMemberException when the property does not exist See Also Get(ref T, String) GetGetter(String) | Improve this Doc View Source Get(ref T, String) Gets the value of the property identified by name on obj . Declaration public static U Get(ref T obj, string name) Parameters Type Name Description T obj the instance to access String name the name of the property Returns Type Description U the value of the property Remarks The only reason to use this over Get(T, String) is if you are using a value type because it avoids a copy. Exceptions Type Condition MissingMemberException when the property does not exist See Also Get(T, String) GetGetter(String) | Improve this Doc View Source GetGetter(String) Gets a PropertyAccessor.Getter for the property identified by name . Declaration public static PropertyAccessor.Getter GetGetter(string name) Parameters Type Name Description String name the name of the property Returns Type Description PropertyAccessor.Getter <> a PropertyAccessor.Getter that can access that property Exceptions Type Condition MissingMemberException when the property does not exist | Improve this Doc View Source GetSetter(String) Gets a PropertyAccessor.Setter for the property identified by name . Declaration public static PropertyAccessor.Setter GetSetter(string name) Parameters Type Name Description String name the name of the property Returns Type Description PropertyAccessor.Setter <> a PropertyAccessor.Setter that can access that property Exceptions Type Condition MissingMemberException when the property does not exist | Improve this Doc View Source Set(T, String, U) Sets the value of the property identified by name on obj . Declaration public static void Set(T obj, string name, U val) Parameters Type Name Description T obj the instance to access String name the name of the property U val the new value of the property Remarks This overload cannot be safely used for value types. Use Set(ref T, String, U) instead. Exceptions Type Condition MissingMemberException when the property does not exist See Also Set(ref T, String, U) GetSetter(String) | Improve this Doc View Source Set(ref T, String, U) Sets the value of the property identified by name on obj . Declaration public static void Set(ref T obj, string name, U val) Parameters Type Name Description T obj the instance to access String name the name of the property U val the new value of the property Remarks This overload must be used for value types. Exceptions Type Condition MissingMemberException when the property does not exist See Also Set(T, String, U) GetSetter(String)" - }, - "api/IPA.Utilities.PropertyAccessor-2.Setter.html": { - "href": "api/IPA.Utilities.PropertyAccessor-2.Setter.html", - "title": "Delegate PropertyAccessor.Setter", - "keywords": "Delegate PropertyAccessor.Setter A setter for a property. Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public delegate void Setter(ref T obj, U val); Parameters Type Name Description T obj the object it is a member of U val the new property value Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, "api/IPA.Utilities.PropertyAccessor-2.Getter.html": { "href": "api/IPA.Utilities.PropertyAccessor-2.Getter.html", "title": "Delegate PropertyAccessor.Getter", @@ -324,46 +479,6 @@ "title": "Class FieldAccessor", "keywords": "Class FieldAccessor A type containing utilities for accessing non-public fields of objects. Inheritance Object FieldAccessor Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class FieldAccessor Type Parameters Name Description T the type that the fields are on U the type of the field to access Methods | Improve this Doc View Source Access(ref T, String) Accesses a field for an object by name. Declaration public static U Access(ref T obj, string name) Parameters Type Name Description T obj the object to access the field of String name the name of the field to access Returns Type Description U a reference to the object at the field Exceptions Type Condition MissingFieldException if the field does not exist on T See Also GetAccessor(String) | Improve this Doc View Source Get(T, String) Gets the value of a field of an object by name. Declaration public static U Get(T obj, string name) Parameters Type Name Description T obj the object to access the field of String name the name of the field to access Returns Type Description U the value of the field Exceptions Type Condition MissingFieldException if the field does not exist on T See Also Get(ref T, String) Access(ref T, String) GetAccessor(String) | Improve this Doc View Source Get(ref T, String) Gets the value of a field of an object by name. Declaration public static U Get(ref T obj, string name) Parameters Type Name Description T obj the object to access the field of String name the name of the field to access Returns Type Description U the value of the field Remarks The only good reason to use this over Get(T, String) is when you are working with a value type, as it prevents a copy. Exceptions Type Condition MissingFieldException if the field does not exist on T See Also Get(T, String) Access(ref T, String) GetAccessor(String) | Improve this Doc View Source GetAccessor(String) Gets an FieldAccessor.Accessor for the field named name on T . Declaration public static FieldAccessor.Accessor GetAccessor(string name) Parameters Type Name Description String name the field name Returns Type Description FieldAccessor.Accessor <> an accessor for the field Exceptions Type Condition MissingFieldException if the field does not exist on T | Improve this Doc View Source Set(T, String, U) Sets the value of a field for an object by name. Declaration public static void Set(T obj, string name, U value) Parameters Type Name Description T obj the object to set the field of String name the name of the field U value the value to set it to Remarks This overload cannot be safely used for value types. Use Set(ref T, String, U) instead. Exceptions Type Condition MissingFieldException if the field does not exist on T See Also Set(ref T, String, U) Access(ref T, String) GetAccessor(String) | Improve this Doc View Source Set(ref T, String, U) Sets the value of a field for an object by name. Declaration public static void Set(ref T obj, string name, U value) Parameters Type Name Description T obj the object to set the field of String name the name of the field U value the value to set it to Remarks This overload must be used for value types. Exceptions Type Condition MissingFieldException if the field does not exist on T See Also Set(T, String, U) Access(ref T, String) GetAccessor(String) See Also PropertyAccessor " }, - "api/IPA.Utilities.FieldAccessor-2.Accessor.html": { - "href": "api/IPA.Utilities.FieldAccessor-2.Accessor.html", - "title": "Delegate FieldAccessor.Accessor", - "keywords": "Delegate FieldAccessor.Accessor A delegate for a field accessor taking a T ref and returning a U ref. Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public delegate U Accessor(ref T obj); Parameters Type Name Description T obj the object to access the field of Returns Type Description U a reference to the field's value Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Utilities.Extensions.html": { - "href": "api/IPA.Utilities.Extensions.html", - "title": "Class Extensions", - "keywords": "Class Extensions A class providing various extension methods. Inheritance Object Extensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Extensions Methods | Improve this Doc View Source GetDefault(Type) Gets the default value for a given Type . Declaration public static object GetDefault(this Type type) Parameters Type Name Description Type type the Type to get the default value for Returns Type Description Object the default value of type | Improve this Doc View Source IsSubPathOf(String, String) Returns true if path starts with the path baseDirPath . The comparison is case-insensitive, handles / and \\ slashes as folder separators and only matches if the base dir folder name is matched exactly (\"c:\\foobar\\file.txt\" is not a sub path of \"c:\\foo\"). Declaration public static bool IsSubPathOf(this string path, string baseDirPath) Parameters Type Name Description String path String baseDirPath Returns Type Description Boolean | Improve this Doc View Source Right(String, Int32) Gets the rightmost length characters from a string. Declaration public static string Right(this string value, int length) Parameters Type Name Description String value The string to retrieve the substring from. Int32 length The number of characters to retrieve. Returns Type Description String The substring. | Improve this Doc View Source Unwrap(Nullable) Unwraps a Nullable where T is Boolean such that if the value is null, it gives false . Declaration public static bool Unwrap(this bool? self) Parameters Type Name Description Nullable < Boolean > self the bool? to unwrap Returns Type Description Boolean the unwrapped value, or false if it was null | Improve this Doc View Source WithEnding(String, String) Returns str with the minimal concatenation of ending (starting from end) that results in satisfying .EndsWith(ending). Declaration public static string WithEnding(this string str, string ending) Parameters Type Name Description String str String ending Returns Type Description String Examples \"hel\".WithEnding(\"llo\") returns \"hello\", which is the result of \"hel\" + \"lo\"." - }, - "api/IPA.Utilities.EnumerableExtensions.html": { - "href": "api/IPA.Utilities.EnumerableExtensions.html", - "title": "Class EnumerableExtensions", - "keywords": "Class EnumerableExtensions Extensions for IEnumerable that don't currently exist in System.Linq . Inheritance Object EnumerableExtensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class EnumerableExtensions Methods | Improve this Doc View Source Append(IEnumerable, T) Adds a value to the end of the sequence. Declaration public static IEnumerable Append(this IEnumerable seq, T app) Parameters Type Name Description IEnumerable seq a sequence of values T app the value to append to seq Returns Type Description IEnumerable a new sequence ending with app Type Parameters Name Description T the type of the elements of seq | Improve this Doc View Source NonNull(IEnumerable) LINQ extension method that filters null elements out of an enumeration. Declaration public static IEnumerable NonNull(this IEnumerable self) where T : class Parameters Type Name Description IEnumerable self the enumeration to filter Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the type of the enumeration | Improve this Doc View Source NonNull(IEnumerable>) LINQ extension method that filters null elements from an enumeration of nullable types. Declaration public static IEnumerable NonNull(this IEnumerable self) where T : struct Parameters Type Name Description IEnumerable < Nullable > self the enumeration to filter Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the underlying type of the nullable enumeration | Improve this Doc View Source NonNull(IEnumerable, Func) LINQ extension method that filters null elements out of an enumeration based on a converter. Declaration public static IEnumerable NonNull(this IEnumerable self, Func pred) where U : class Parameters Type Name Description IEnumerable self the enumeration to filter Func pred the predicate to select for filtering Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the type of the enumeration U the type to compare to null | Improve this Doc View Source Prepend(IEnumerable, T) Adds a value to the beginning of the sequence. Declaration public static IEnumerable Prepend(this IEnumerable seq, T prep) Parameters Type Name Description IEnumerable seq a sequence of values T prep the value to prepend to seq Returns Type Description IEnumerable a new sequence beginning with prep Type Parameters Name Description T the type of the elements of seq" - }, - "api/IPA.Utilities.CriticalSection.html": { - "href": "api/IPA.Utilities.CriticalSection.html", - "title": "Class CriticalSection", - "keywords": "Class CriticalSection Provides utilities for managing various critical sections. Inheritance Object CriticalSection Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class CriticalSection Methods | Improve this Doc View Source EnterExecuteSection() Enters a critical execution section. Does not nest. Declaration public static void EnterExecuteSection() | Improve this Doc View Source ExecuteSection() Creates an CriticalSection.AutoExecuteSection for automated management of an execute section. Declaration public static CriticalSection.AutoExecuteSection ExecuteSection() Returns Type Description CriticalSection.AutoExecuteSection the new CriticalSection.AutoExecuteSection that manages the section | Improve this Doc View Source ExitExecuteSection() Exits a critical execution section. Does not nest. Declaration public static void ExitExecuteSection()" - }, - "api/IPA.Utilities.CriticalSection.AutoExecuteSection.html": { - "href": "api/IPA.Utilities.CriticalSection.AutoExecuteSection.html", - "title": "Struct CriticalSection.AutoExecuteSection", - "keywords": "Struct CriticalSection.AutoExecuteSection A struct that allows using blocks to manage an execute section. Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public struct AutoExecuteSection : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Utilities.Async.html": { - "href": "api/IPA.Utilities.Async.html", - "title": "", - "keywords": "Classes Coroutines A class providing coroutine helpers. SingleThreadTaskScheduler A single-threaded task scheduler that runs all of its tasks on the same thread. Synchronization Utilities for inter-thread synchronization. All Locker method acquire their object immediately, and should only be used with langword_csharp_using to automatically release them. UnityMainThreadTaskScheduler A task scheduler that runs tasks on the Unity main thread via coroutines. Structs Synchronization.MutexLocker A locker for a Mutex that automatically releases when it is disposed. Create this with Lock(Mutex) . Synchronization.ReaderWriterLockSlimReadLocker A locker for a read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockRead(ReaderWriterLockSlim) . Synchronization.ReaderWriterLockSlimUpgradableReadLocker A locker for an upgradable read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockReadUpgradable(ReaderWriterLockSlim) . Synchronization.ReaderWriterLockSlimWriteLocker A locker for a write lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockWrite(ReaderWriterLockSlim) . Synchronization.SemaphoreLocker A locker for a Semaphore that automatically releases when it is disposed. Create this with Lock(Semaphore) . Synchronization.SemaphoreSlimAsyncLocker A locker for a SemaphoreSlim that was created asynchronously and automatically releases when it is disposed. Create this with LockAsync(SemaphoreSlim) . Synchronization.SemaphoreSlimLocker A locker for a SemaphoreSlim that automatically releases when it is disposed. Create this with Lock(SemaphoreSlim) ." - }, - "api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html": { - "href": "api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html", - "title": "Class UnityMainThreadTaskScheduler", - "keywords": "Class UnityMainThreadTaskScheduler A task scheduler that runs tasks on the Unity main thread via coroutines. Inheritance Object TaskScheduler UnityMainThreadTaskScheduler Implements IDisposable Inherited Members TaskScheduler.TryDequeue(Task) TaskScheduler.FromCurrentSynchronizationContext() TaskScheduler.TryExecuteTask(Task) TaskScheduler.MaximumConcurrencyLevel TaskScheduler.Current TaskScheduler.Id TaskScheduler.UnobservedTaskException Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public class UnityMainThreadTaskScheduler : TaskScheduler, IDisposable Properties | Improve this Doc View Source Cancelling Gets whether or not this scheduler is in the process of shutting down. Declaration public bool Cancelling { get; } Property Value Type Description Boolean true if the scheduler is shutting down, false otherwise | Improve this Doc View Source Default Gets the default main thread scheduler that is managed by BSIPA. Declaration public static TaskScheduler Default { get; } Property Value Type Description TaskScheduler a scheduler that is managed by BSIPA | Improve this Doc View Source Factory Gets a factory for creating tasks on Default . Declaration public static TaskFactory Factory { get; } Property Value Type Description TaskFactory a factory for creating tasks on the default scheduler | Improve this Doc View Source IsRunning Gets whether or not this scheduler is currently executing tasks. Declaration public bool IsRunning { get; } Property Value Type Description Boolean true if the scheduler is running, false otherwise | Improve this Doc View Source YieldAfterTasks Gets or sets the number of tasks to execute before yielding back to Unity. Declaration public int YieldAfterTasks { get; set; } Property Value Type Description Int32 the number of tasks to execute per resume | Improve this Doc View Source YieldAfterTime Gets or sets the amount of time to execute tasks for before yielding back to Unity. Default is 0.5ms. Declaration public TimeSpan YieldAfterTime { get; set; } Property Value Type Description TimeSpan the amount of time to execute tasks for before yielding back to Unity Methods | Improve this Doc View Source Cancel() Cancels the scheduler. If the scheduler is currently executing tasks, that batch will finish first. All remaining tasks will be left in the queue. Declaration public void Cancel() Exceptions Type Condition ObjectDisposedException if this scheduler is disposed InvalidOperationException if the scheduler is not running | Improve this Doc View Source Coroutine() When used as a Unity coroutine, runs the scheduler. Otherwise, this is an invalid call. Declaration public IEnumerator Coroutine() Returns Type Description IEnumerator a Unity coroutine Remarks Do not ever call UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator) on this coroutine, nor UnityEngine.MonoBehaviour.StopAllCoroutines() on the behaviour hosting this coroutine. This has no way to detect this, and this object will become invalid. If you need to stop this coroutine, first call Cancel() , then wait for it to exit on its own. Exceptions Type Condition ObjectDisposedException if this scheduler is disposed InvalidOperationException if the scheduler is already running | Improve this Doc View Source Dispose() Disposes this object. This puts the object into an unusable state. Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes this object. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing whether or not to dispose managed objects | Improve this Doc View Source GetScheduledTasks() Throws a NotSupportedException . Declaration protected override IEnumerable GetScheduledTasks() Returns Type Description IEnumerable < Task > nothing Overrides TaskScheduler.GetScheduledTasks() Exceptions Type Condition NotSupportedException Always. | Improve this Doc View Source QueueTask(Task) Queues a given Task to this scheduler. The Task must> be scheduled for this TaskScheduler by the runtime. Declaration protected override void QueueTask(Task task) Parameters Type Name Description Task task the Task to queue Overrides TaskScheduler.QueueTask(Task) Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source TryExecuteTaskInline(Task, Boolean) Rejects any attempts to execute a task inline. Declaration protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued) Parameters Type Name Description Task task the task to attempt to execute Boolean taskWasPreviouslyQueued whether the task was previously queued to this scheduler Returns Type Description Boolean false Overrides TaskScheduler.TryExecuteTaskInline(Task, Boolean) Remarks This task scheduler always runs its tasks on the thread that it manages, therefore it doesn't make sense to run it inline. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Utilities.Async.SingleThreadTaskScheduler.html": { - "href": "api/IPA.Utilities.Async.SingleThreadTaskScheduler.html", - "title": "Class SingleThreadTaskScheduler", - "keywords": "Class SingleThreadTaskScheduler A single-threaded task scheduler that runs all of its tasks on the same thread. Inheritance Object TaskScheduler SingleThreadTaskScheduler Implements IDisposable Inherited Members TaskScheduler.TryDequeue(Task) TaskScheduler.FromCurrentSynchronizationContext() TaskScheduler.TryExecuteTask(Task) TaskScheduler.MaximumConcurrencyLevel TaskScheduler.Default TaskScheduler.Current TaskScheduler.Id TaskScheduler.UnobservedTaskException Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public class SingleThreadTaskScheduler : TaskScheduler, IDisposable Properties | Improve this Doc View Source IsRunning Gets whether or not the underlying thread has been started. Declaration public bool IsRunning { get; } Property Value Type Description Boolean Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Methods | Improve this Doc View Source Dispose() Disposes this object. This puts the object into an unusable state. Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes this object. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing whether or not to dispose managed objects | Improve this Doc View Source Exit() Terminates the runner thread, and waits for the currently running task to complete. Declaration public IEnumerable Exit() Returns Type Description IEnumerable < Task > an IEnumerable of Task s that did not execute Remarks After this method returns, this object has been disposed and is no longer in a valid state. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source GetScheduledTasks() Throws a NotSupportedException . Declaration protected override IEnumerable GetScheduledTasks() Returns Type Description IEnumerable < Task > nothing Overrides TaskScheduler.GetScheduledTasks() Exceptions Type Condition NotSupportedException Always. | Improve this Doc View Source Join() Waits for the runner thread to complete all tasks in the queue, then exits. Declaration public void Join() Remarks After this method returns, this object has been disposed and is no longer in a valid state. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source QueueTask(Task) Queues a given Task to this scheduler. The Task must> be scheduled for this TaskScheduler by the runtime. Declaration protected override void QueueTask(Task task) Parameters Type Name Description Task task the Task to queue Overrides TaskScheduler.QueueTask(Task) Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source Start() Starts the thread that executes tasks scheduled with this TaskScheduler Declaration public void Start() Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source TryExecuteTaskInline(Task, Boolean) Rejects any attempts to execute a task inline. Declaration protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued) Parameters Type Name Description Task task the task to attempt to execute Boolean taskWasPreviouslyQueued whether the task was previously queued to this scheduler Returns Type Description Boolean false Overrides TaskScheduler.TryExecuteTaskInline(Task, Boolean) Remarks This task scheduler always runs its tasks on the thread that it manages, therefore it doesn't make sense to run it inline. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, "api/IPA.Utilities.Async.Coroutines.html": { "href": "api/IPA.Utilities.Async.Coroutines.html", "title": "Class Coroutines", @@ -374,35 +489,15 @@ "title": "Class AlmostVersionConverter", "keywords": "Class AlmostVersionConverter A ValueConverter for AlmostVersion s. Inheritance Object ValueConverter < AlmostVersion > AlmostVersionConverter Implements IValueConverter Inherited Members ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public sealed class AlmostVersionConverter : ValueConverter, IValueConverter Methods | Improve this Doc View Source FromValue(Value, Object) Converts a Text node into an AlmostVersion . Declaration public override AlmostVersion FromValue(Value value, object parent) Parameters Type Name Description Value value the Text node to convert Object parent the owner of the new object Returns Type Description AlmostVersion Overrides IPA.Config.Stores.ValueConverter.FromValue(IPA.Config.Data.Value, System.Object) | Improve this Doc View Source ToValue(AlmostVersion, Object) Converts an AlmostVersion to a Text node. Declaration public override Value ToValue(AlmostVersion obj, object parent) Parameters Type Name Description AlmostVersion obj the AlmostVersion to convert Object parent the parent of obj Returns Type Description Value a Text node representing obj Overrides IPA.Config.Stores.ValueConverter.ToValue(IPA.Utilities.AlmostVersion, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Utilities.AlmostVersion.html": { - "href": "api/IPA.Utilities.AlmostVersion.html", - "title": "Class AlmostVersion", - "keywords": "Class AlmostVersion A type that wraps SemVer.Version so that the string of the version is stored when the string is not a valid SemVer.Version . Inheritance Object AlmostVersion Implements IComparable < AlmostVersion > IComparable < SemVer.Version > Inherited Members Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public class AlmostVersion : IComparable, IComparable Constructors | Improve this Doc View Source AlmostVersion(Version) Creates an AlmostVersion from the SemVer.Version provided in ver . Declaration public AlmostVersion(Version ver) Parameters Type Name Description SemVer.Version ver the SemVer.Version to store | Improve this Doc View Source AlmostVersion(String) Creates a new AlmostVersion with the version string provided in vertext . Declaration public AlmostVersion(string vertext) Parameters Type Name Description String vertext the version string to store | Improve this Doc View Source AlmostVersion(String, AlmostVersion) Creates a new AlmostVersion from the version string in vertext stored the same way as the AlmostVersion passed in copyMode . Declaration public AlmostVersion(string vertext, AlmostVersion copyMode) Parameters Type Name Description String vertext the text to parse as an AlmostVersion AlmostVersion copyMode an AlmostVersion to copy the storage mode of | Improve this Doc View Source AlmostVersion(String, AlmostVersion.StoredAs) Creates an AlmostVersion from the version string in vertext stored using the storage mode specified in mode . Declaration public AlmostVersion(string vertext, AlmostVersion.StoredAs mode) Parameters Type Name Description String vertext the text to parse as an AlmostVersion AlmostVersion.StoredAs mode the storage mode to store the version in Properties | Improve this Doc View Source SemverValue The value of the AlmostVersion if it was stored as a SemVer.Version . Declaration public Version SemverValue { get; } Property Value Type Description SemVer.Version the stored value as a SemVer.Version , or null if not stored as a version. | Improve this Doc View Source StorageMode The way the value is stored, whether it be as a SemVer.Version or a String . Declaration public AlmostVersion.StoredAs StorageMode { get; } Property Value Type Description AlmostVersion.StoredAs the storage mode used to store this value | Improve this Doc View Source StringValue The value of the AlmostVersion if it was stored as a String . Declaration public string StringValue { get; } Property Value Type Description String the stored value as a String , or null if not stored as a string. Methods | Improve this Doc View Source CompareTo(AlmostVersion) Compares langword_csharp_this to the AlmostVersion in other using SemVer.Version.CompareTo(SemVer.Version) or CompareTo(String) , depending on the current store. Declaration public int CompareTo(AlmostVersion other) Parameters Type Name Description AlmostVersion other the AlmostVersion to compare to Returns Type Description Int32 less than 0 if other is considered bigger than langword_csharp_this , 0 if equal, and greater than zero if smaller Remarks The storage methods of the two objects must be the same, or this will throw an InvalidOperationException . See Also CompareTo(Version) | Improve this Doc View Source CompareTo(Version) Compares langword_csharp_this to the SemVer.Version in other using SemVer.Version.CompareTo(SemVer.Version) . Declaration public int CompareTo(Version other) Parameters Type Name Description SemVer.Version other the SemVer.Version to compare to Returns Type Description Int32 less than 0 if other is considered bigger than langword_csharp_this , 0 if equal, and greater than zero if smaller Remarks The storage method of langword_csharp_this must be SemVer , else an InvalidOperationException will be thrown. See Also CompareTo(AlmostVersion) | Improve this Doc View Source Equals(Object) Performs a strict equality check between langword_csharp_this and obj . Declaration public override bool Equals(object obj) Parameters Type Name Description Object obj the object to compare to Returns Type Description Boolean true if they are equal, false otherwise Overrides Object.Equals(Object) Remarks This may return false where Equality(AlmostVersion, AlmostVersion) returns true See Also Equals ( Object ) | Improve this Doc View Source GetHashCode() Default generated hash code function generated by VS. Declaration public override int GetHashCode() Returns Type Description Int32 a value unique to each object, except those that are considered equal by Equals(Object) Overrides Object.GetHashCode() See Also GetHashCode () | Improve this Doc View Source ToString() Gets a string representation of the current version. If the value is stored as a string, this returns it. If it is stored as a SemVer.Version , it is equivalent to calling SemVer.Version.ToString . Declaration public override string ToString() Returns Type Description String a string representation of the current version Overrides Object.ToString() See Also ToString () Operators | Improve this Doc View Source Equality(AlmostVersion, AlmostVersion) Compares two versions, only taking into account the numeric part of the version if they are stored as SemVer.Version s, or strict equality if they are stored as String s. Declaration public static bool operator ==(AlmostVersion l, AlmostVersion r) Parameters Type Name Description AlmostVersion l the first value to compare AlmostVersion r the second value to compare Returns Type Description Boolean true if they are mostly equal, false otherwise Remarks This is a looser equality than Equals(Object) , meaning that this may return true where Equals(Object) does not. See Also Equals(Object) | Improve this Doc View Source Implicit(AlmostVersion to Version) Implicitly converts an AlmostVersion to SemVer.Version , if applicable, using SemverValue . If not applicable, returns null Declaration public static implicit operator Version(AlmostVersion av) Parameters Type Name Description AlmostVersion av the AlmostVersion to convert to a SemVer.Version Returns Type Description SemVer.Version See Also SemverValue | Improve this Doc View Source Implicit(Version to AlmostVersion) Implicitly converts a SemVer.Version to AlmostVersion using AlmostVersion(Version) . Declaration public static implicit operator AlmostVersion(Version ver) Parameters Type Name Description SemVer.Version ver the SemVer.Version to convert Returns Type Description AlmostVersion See Also AlmostVersion(Version) | Improve this Doc View Source Inequality(AlmostVersion, AlmostVersion) The opposite of Equality(AlmostVersion, AlmostVersion) . Equivalent to !(l == r) . Declaration public static bool operator !=(AlmostVersion l, AlmostVersion r) Parameters Type Name Description AlmostVersion l the first value to compare AlmostVersion r the second value to compare Returns Type Description Boolean true if they are not mostly equal, false otherwise See Also Equality(AlmostVersion, AlmostVersion) Implements System.IComparable System.IComparable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Utilities.AlmostVersion.StoredAs.html": { - "href": "api/IPA.Utilities.AlmostVersion.StoredAs.html", - "title": "Enum AlmostVersion.StoredAs", - "keywords": "Enum AlmostVersion.StoredAs Represents a storage type of either parsed SemVer.Version object or raw String . Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public enum StoredAs Fields Name Description SemVer The version was stored as a SemVer.Version . String The version was stored as a String . Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" - }, - "api/IPA.RuntimeOptions.html": { - "href": "api/IPA.RuntimeOptions.html", - "title": "Enum RuntimeOptions", - "keywords": "Enum RuntimeOptions Options that a plugin must specify to describe how it expects to be run. Namespace : IPA Assembly : IPA.Loader.dll Syntax public enum RuntimeOptions Fields Name Description DynamicInit Indicates that this plugin supports runtime enabling and disabling. When this is set, the plugin may be disabled at reasonable points during runtime. As with SingleStartInit , it will be initialized and enabled with the game if it is enabled on startup, and disabled with the game if it is enabled on shutdown. When a plugin with this set is enabled mid-game, the first time it is enabled, its initialization methods will be called, then its enable methods. All subsequent enables will NOT re-initialize, however the enable methods will be called. When a plugin with this set is disabled mid-game, the plugin instance will NOT be destroyed, and will instead be re-used for subsequent enables. The plugin is expected to handle this gracefully, and behave in a way that makes sense. SingleStartInit Indicates that this plugin expects to be initialized and enabled with the game, and disabled with the game. With this option set, whether or not the plugin is disabled during a given run is constant for that entire run. See Also PluginAttribute InitAttribute OnEnableAttribute OnDisableAttribute OnStartAttribute OnExitAttribute Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])" - }, - "api/IPA.PluginAttribute.html": { - "href": "api/IPA.PluginAttribute.html", - "title": "Class PluginAttribute", - "keywords": "Class PluginAttribute Marks a class as being a BSIPA plugin. Inheritance Object Attribute PluginAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)] public sealed class PluginAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source PluginAttribute(RuntimeOptions) Initializes a PluginAttribute with the given RuntimeOptions to indicate the runtime capabilities of the plugin. Declaration public PluginAttribute(RuntimeOptions runtimeOptions) Parameters Type Name Description RuntimeOptions runtimeOptions the options to use for this plugin Properties | Improve this Doc View Source RuntimeOptions The RuntimeOptions passed into the constructor of this attribute. Declaration public RuntimeOptions RuntimeOptions { get; } Property Value Type Description RuntimeOptions Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also InitAttribute OnEnableAttribute OnDisableAttribute OnStartAttribute OnExitAttribute" - }, "api/IPA.OnStartAttribute.html": { "href": "api/IPA.OnStartAttribute.html", "title": "Class OnStartAttribute", "keywords": "Class OnStartAttribute Indicates that the target method should be called when the game starts. Inheritance Object Attribute OnStartAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnStartAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Remarks This attribute is interchangable with OnEnableAttribute , and is treated identically. They are seperate to allow plugin code to more clearly describe the intent of the methods. Typically, this will be used when the RuntimeOptions parameter of the plugins's PluginAttribute is SingleStartInit . The method marked by this attribute will always be called from the Unity main thread. Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also PluginAttribute OnEnableAttribute" }, - "api/IPA.Logging.Printers.html": { - "href": "api/IPA.Logging.Printers.html", - "title": "", - "keywords": "Classes ColoredConsolePrinter Prints a pretty message to the console. ColorlessConsolePrinter A colorless version of ColoredConsolePrinter , that indiscriminantly prints to standard out. GlobalLogFilePrinter A printer for all messages to a unified log location. GZFilePrinter A LogPrinter abstract class that provides the utilities to write to a GZip file. PluginLogFilePrinter Prints log messages to the file specified by the name. PluginSubLogPrinter Prints log messages to the file specified by the name." + "api/IPA.OnExitAttribute.html": { + "href": "api/IPA.OnExitAttribute.html", + "title": "Class OnExitAttribute", + "keywords": "Class OnExitAttribute Indicates that the target method should be called when the game exits. Inheritance Object Attribute OnExitAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnExitAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Remarks This attribute is interchangable with OnDisableAttribute , and is treated identically. They are seperate to allow plugin code to more clearly describe the intent of the methods. Typically, this will be used when the RuntimeOptions parameter of the plugins's PluginAttribute is SingleStartInit . The method marked by this attribute will always be called from the Unity main thread. Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also PluginAttribute OnDisableAttribute" }, "api/IPA.Logging.Printers.PluginSubLogPrinter.html": { "href": "api/IPA.Logging.Printers.PluginSubLogPrinter.html", @@ -414,45 +509,15 @@ "title": "Class PluginLogFilePrinter", "keywords": "Class PluginLogFilePrinter Prints log messages to the file specified by the name. Inheritance Object LogPrinter GZFilePrinter PluginLogFilePrinter Implements IDisposable Inherited Members GZFilePrinter.FileWriter GZFilePrinter.StartPrint() GZFilePrinter.EndPrint() GZFilePrinter.Dispose() GZFilePrinter.Dispose(Boolean) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class PluginLogFilePrinter : GZFilePrinter, IDisposable Constructors | Improve this Doc View Source PluginLogFilePrinter(String) Creates a new printer with the given name. Declaration public PluginLogFilePrinter(string name) Parameters Type Name Description String name the name of the logger Properties | Improve this Doc View Source Filter Provides a filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the target file. Declaration protected override FileInfo GetFileInfo() Returns Type Description FileInfo the file to write to Overrides GZFilePrinter.GetFileInfo() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the associated file. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Logging.Printers.GZFilePrinter.html": { - "href": "api/IPA.Logging.Printers.GZFilePrinter.html", - "title": "Class GZFilePrinter", - "keywords": "Class GZFilePrinter A LogPrinter abstract class that provides the utilities to write to a GZip file. Inheritance Object LogPrinter GZFilePrinter GlobalLogFilePrinter PluginLogFilePrinter PluginSubLogPrinter Implements IDisposable Inherited Members LogPrinter.Filter LogPrinter.Print(Logger.Level, DateTime, String, String) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public abstract class GZFilePrinter : LogPrinter, IDisposable Fields | Improve this Doc View Source FileWriter The StreamWriter that writes to the GZip file. Declaration protected StreamWriter FileWriter Field Value Type Description StreamWriter the writer to the underlying filestream Methods | Improve this Doc View Source Dispose() Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes the file printer. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing does nothing | Improve this Doc View Source EndPrint() Called at the end of any print session. Declaration public override sealed void EndPrint() Overrides LogPrinter.EndPrint() | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the file to write to. Declaration protected abstract FileInfo GetFileInfo() Returns Type Description FileInfo the file to write to | Improve this Doc View Source StartPrint() Called at the start of any print session. Declaration public override sealed void StartPrint() Overrides LogPrinter.StartPrint() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Logging.Printers.GlobalLogFilePrinter.html": { - "href": "api/IPA.Logging.Printers.GlobalLogFilePrinter.html", - "title": "Class GlobalLogFilePrinter", - "keywords": "Class GlobalLogFilePrinter A printer for all messages to a unified log location. Inheritance Object LogPrinter GZFilePrinter GlobalLogFilePrinter Implements IDisposable Inherited Members GZFilePrinter.FileWriter GZFilePrinter.StartPrint() GZFilePrinter.EndPrint() GZFilePrinter.Dispose() GZFilePrinter.Dispose(Boolean) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class GlobalLogFilePrinter : GZFilePrinter, IDisposable Properties | Improve this Doc View Source Filter Provides a filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the target file. Declaration protected override FileInfo GetFileInfo() Returns Type Description FileInfo the target file to write to Overrides GZFilePrinter.GetFileInfo() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the associated file. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Logging.Printers.ColorlessConsolePrinter.html": { - "href": "api/IPA.Logging.Printers.ColorlessConsolePrinter.html", - "title": "Class ColorlessConsolePrinter", - "keywords": "Class ColorlessConsolePrinter A colorless version of ColoredConsolePrinter , that indiscriminantly prints to standard out. Inheritance Object LogPrinter ColorlessConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColorlessConsolePrinter : LogPrinter Properties | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to standard out. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Logging.Printers.ColoredConsolePrinter.html": { - "href": "api/IPA.Logging.Printers.ColoredConsolePrinter.html", - "title": "Class ColoredConsolePrinter", - "keywords": "Class ColoredConsolePrinter Prints a pretty message to the console. Inheritance Object LogPrinter ColoredConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColoredConsolePrinter : LogPrinter Properties | Improve this Doc View Source Color The color to print messages as. Declaration public ConsoleColor Color { get; set; } Property Value Type Description ConsoleColor the color to print this message as | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter to apply to this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the console window. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, "api/IPA.Logging.LogPrinter.html": { "href": "api/IPA.Logging.LogPrinter.html", "title": "Class LogPrinter", "keywords": "Class LogPrinter The log printer's base class. Inheritance Object LogPrinter ColoredConsolePrinter ColorlessConsolePrinter GZFilePrinter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public abstract class LogPrinter Properties | Improve this Doc View Source Filter Provides a filter for which log levels to allow through. Declaration public abstract Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the level to filter to Methods | Improve this Doc View Source EndPrint() Called after the last print in a group. May be called multiple times. Use this to dispose file handles and the like. Declaration public virtual void EndPrint() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints a provided message from a given log at the specified time. Declaration public abstract void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the log level DateTime time the time the message was composed String logName the name of the log that created this message String message the message | Improve this Doc View Source StartPrint() Called before the first print in a group. May be called multiple times. Use this to create file handles and the like. Declaration public virtual void StartPrint() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Loader.Features.html": { - "href": "api/IPA.Loader.Features.html", - "title": "", - "keywords": "Classes Feature The root interface for a mod Feature." - }, - "api/IPA.Loader.Features.Feature.html": { - "href": "api/IPA.Loader.Features.Feature.html", - "title": "Class Feature", - "keywords": "Class Feature The root interface for a mod Feature. Inheritance Object Feature Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader.Features Assembly : IPA.Loader.dll Syntax public abstract class Feature Remarks Avoid storing any data in any subclasses. If you do, it may result in a failure to load the feature. Properties | Improve this Doc View Source InvalidMessage The message to be logged when the feature is not valid for a plugin. This should also be set whenever either BeforeLoad(PluginMetadata) or BeforeInit(PluginMetadata) returns false. Declaration public virtual string InvalidMessage { get; protected set; } Property Value Type Description String the message to show when the feature is marked invalid | Improve this Doc View Source StoreOnPlugin Defines whether or not this feature will be accessible from the plugin metadata once loaded. Declaration protected virtual bool StoreOnPlugin { get; } Property Value Type Description Boolean true if this Feature will be stored on the plugin metadata, false otherwise Methods | Improve this Doc View Source AfterInit(PluginMetadata) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin that was just initialized | Improve this Doc View Source AfterInit(PluginMetadata, Object) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginMetadata plugin, object pluginInstance) Parameters Type Name Description PluginMetadata plugin the plugin that was just initialized Object pluginInstance the instance of the plugin being initialized | Improve this Doc View Source BeforeInit(PluginMetadata) Called before a plugin's Init method is called. This will not be called if there is no Init method. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeInit(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin to be initialized Returns Type Description Boolean whether or not to call the Init method | Improve this Doc View Source BeforeLoad(PluginMetadata) Called before a plugin is loaded. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeLoad(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin about to be loaded Returns Type Description Boolean whether or not the plugin should be loaded Remarks The assembly will still be loaded, but the plugin will not be constructed if this returns false . Any features it defines, for example, will still be loaded. | Improve this Doc View Source Evaluate() Evaluates the Feature for use in conditional meta-Features. This should be re-calculated on every call, unless it can be proven to not change. This will be called on every feature that returns true from Initialize(PluginMetadata, String[]) Declaration public virtual bool Evaluate() Returns Type Description Boolean the truthiness of the Feature. | Improve this Doc View Source Initialize(PluginMetadata, String[]) Initializes the feature with the parameters provided in the definition. Note: When no parenthesis are provided, parameters is an empty array. Declaration public abstract bool Initialize(PluginMetadata meta, string[] parameters) Parameters Type Name Description PluginMetadata meta the metadata of the plugin that is being prepared String [] parameters the parameters passed to the feature definition, or null Returns Type Description Boolean true if the feature is valid for the plugin, false otherwise Remarks This gets called BEFORE your Init method. Returning false does not prevent the plugin from being loaded. It simply prevents the feature from being used. | Improve this Doc View Source RequireLoaded(PluginMetadata) Ensures a plugin's assembly is loaded. Do not use unless you need to. Declaration protected void RequireLoaded(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin to ensure is loaded. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Loader.CannotRuntimeDisableException.html": { - "href": "api/IPA.Loader.CannotRuntimeDisableException.html", - "title": "Class CannotRuntimeDisableException", - "keywords": "Class CannotRuntimeDisableException Indicates that a plugin cannot be disabled at runtime. Generally not considered an error, however. Inheritance Object Exception CannotRuntimeDisableException Implements ISerializable _Exception Inherited Members Exception.GetBaseException() Exception.ToString() Exception.GetObjectData(SerializationInfo, StreamingContext) Exception.GetType() Exception.Message Exception.Data Exception.InnerException Exception.TargetSite Exception.StackTrace Exception.HelpLink Exception.Source Exception.HResult Exception.SerializeObjectState Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax [Serializable] public class CannotRuntimeDisableException : Exception, ISerializable, _Exception Constructors | Improve this Doc View Source CannotRuntimeDisableException(PluginMetadata) Creates an exception for the given plugin metadata. Declaration public CannotRuntimeDisableException(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin that cannot be disabled | Improve this Doc View Source CannotRuntimeDisableException(SerializationInfo, StreamingContext) Creates an exception from a serialization context. Not currently implemented. Declaration protected CannotRuntimeDisableException(SerializationInfo serializationInfo, StreamingContext streamingContext) Parameters Type Name Description SerializationInfo serializationInfo StreamingContext streamingContext Exceptions Type Condition NotImplementedException Properties | Improve this Doc View Source Plugin The plugin that cannot be disabled at runtime. Declaration public PluginMetadata Plugin { get; } Property Value Type Description PluginMetadata Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Logging.LoggerExtensions.html": { + "href": "api/IPA.Logging.LoggerExtensions.html", + "title": "Class LoggerExtensions", + "keywords": "Class LoggerExtensions A class providing extensions for various loggers. Inheritance Object LoggerExtensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public static class LoggerExtensions Methods | Improve this Doc View Source GetChildLogger(Logger, String) Gets a child logger, if supported. Currently the only defined and supported logger is StandardLogger , and most plugins will only ever receive this anyway. Declaration public static Logger GetChildLogger(this Logger logger, string name) Parameters Type Name Description Logger logger the parent Logger String name the name of the child Returns Type Description Logger the child logger" }, "api/IPA.InitAttribute.html": { "href": "api/IPA.InitAttribute.html", @@ -464,16 +529,6 @@ "title": "", "keywords": "Classes Config An abstraction of a config file on disk, which handles synchronizing between a memory representation and the disk representation. Config.NameAttribute Specifies a preferred config name, instead of using the plugin's name. Config.PreferAttribute Specifies that a particular parameter is preferred to use a particular IConfigProvider . If it is not available, also specifies backups. If none are available, the default is used. ConfigProvider A wrapper for an IConfigProvider and the FileInfo to use with it. ModPrefs Allows to get and set preferences for your mod. Interfaces IConfigProvider An interface for configuration providers. IConfigStore A storage for a config structure. IModPrefs Allows to get and set preferences for your mod." }, - "api/IPA.Config.Stores.html": { - "href": "api/IPA.Config.Stores.html", - "title": "", - "keywords": "Classes GeneratedExtension A class providing an extension for Config to make it easy to use generated config stores. ValueConverter A strongly-typed IValueConverter . Interfaces IValueConverter The base interface for a value converter for use by objects generated by Generated(Config, Boolean) ." - }, - "api/IPA.Config.Stores.ValueConverter-1.html": { - "href": "api/IPA.Config.Stores.ValueConverter-1.html", - "title": "Class ValueConverter", - "keywords": "Class ValueConverter A strongly-typed IValueConverter . Inheritance Object ValueConverter CollectionConverter CustomObjectConverter NullableConverter AlmostVersionConverter Implements IValueConverter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores Assembly : IPA.Loader.dll Syntax public abstract class ValueConverter : IValueConverter Type Parameters Name Description T the type of object to handle Methods | Improve this Doc View Source FromValue(Value, Object) Converts the given Value to the object type handled by this converter. Declaration public abstract T FromValue(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the object that will own the result Returns Type Description T the deserialized object See Also FromValue ( Value , Object ) | Improve this Doc View Source ToValue(T, Object) Converts the given object to a Value . Declaration public abstract Value ToValue(T obj, object parent) Parameters Type Name Description T obj the object to convert Object parent the owning object of obj Returns Type Description Value a representation of obj as a Value structure See Also ToValue ( Object , Object ) Explicit Interface Implementations | Improve this Doc View Source IValueConverter.FromValue(Value, Object) Declaration object IValueConverter.FromValue(Value value, object parent) Parameters Type Name Description Value value Object parent Returns Type Description Object | Improve this Doc View Source IValueConverter.ToValue(Object, Object) Declaration Value IValueConverter.ToValue(object obj, object parent) Parameters Type Name Description Object obj Object parent Returns Type Description Value | Improve this Doc View Source IValueConverter.Type Declaration Type IValueConverter.Type { get; } Returns Type Description Type Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also IValueConverter" - }, "api/IPA.Config.Stores.IValueConverter.html": { "href": "api/IPA.Config.Stores.IValueConverter.html", "title": "Interface IValueConverter", @@ -484,80 +539,30 @@ "title": "Class GeneratedExtension", "keywords": "Class GeneratedExtension A class providing an extension for Config to make it easy to use generated config stores. Inheritance Object GeneratedExtension Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores Assembly : IPA.Loader.dll Syntax public static class GeneratedExtension Fields | Improve this Doc View Source AssemblyVisibilityTarget The name of the assembly that internals must be visible to to allow internal protection. Declaration public const string AssemblyVisibilityTarget = \"IPA.Config.Generated\" Field Value Type Description String Methods | Improve this Doc View Source Generated(Config, Boolean) Creates a generated IConfigStore of type T , registers it to the Config object, and returns it. This also forces a synchronous config load via LoadSync() if loadSync is true . Declaration public static T Generated(this Config cfg, bool loadSync = true) where T : class Parameters Type Name Description Config cfg the Config to register to Boolean loadSync whether to synchronously load the content, or trigger an async load Returns Type Description T a generated instance of T as a special IConfigStore Type Parameters Name Description T the type to wrap Remarks T must be a public non- sealed class. It can also be internal, but in that case, then your assembly must have the following attribute to allow the generated code to reference it. [assembly: InternalsVisibleTo(IPA.Config.Stores.GeneratedExtension.AssemblyVisibilityTarget)] Only fields and properties that are public or protected will be considered, and only properties where both the getter and setter are public or protected are considered. Any fields or properties with an IgnoreAttribute applied to them are also ignored. Having properties be virtual is not strictly necessary, however it allows the generated type to keep track of changes and lock around them so that the config will auto-save. All of the attributes in the IPA.Config.Stores.Attributes namespace are handled as described by them. If the T declares a public or protected, virtual method Changed() , then that method may be called to artificially signal to the runtime that the content of the object has changed. That method will also be called after the write locks are released when a property is set anywhere in the owning tree. This will only be called on the outermost generated object of the config structure, even if the change being signaled is somewhere deep into the tree. TODO: is this a good idea? Similarly, T can declare a public or protected, virtual method OnReload() , which will be called on the filesystem reader thread after the object has been repopulated with new data values. It will be called after the write lock for this object is released. This will only be called on the outermost generated object of the config structure. Similarly, T can declare a public or protected, virtual method CopyFrom(ConfigType) (the first parameter is the type it is defined on), which may be called to copy the properties from another object of its type easily, and more importantly, as only one change. Its body will be executed after the values have been copied. TODO: describe details of generated stores" }, - "api/IPA.Config.Stores.Converters.html": { - "href": "api/IPA.Config.Stores.Converters.html", - "title": "", - "keywords": "Classes CollectionConverter A base class for all ICollection type converters, providing most of the functionality. CollectionConverter A CollectionConverter which default constructs a converter for use as the value converter. Converter Provides utility functions for custom converters. Converter Provides generic utilities for converters for certain types. CustomObjectConverter A ValueConverter for objects normally serialized to config via Generated(Config, Boolean) . IListConverter A CollectionConverter for an IList , creating a List when deserializing. IListConverter An IListConverter which default constructs a converter for use as the value converter. ISetConverter A CollectionConverter for an ISet , creating a HashSet when deserializing. ISetConverter An ISetConverter which default constructs a converter for use as the value converter. ListConverter A CollectionConverter for a List . ListConverter A ListConverter which default constructs a converter for use as the value converter. NullableConverter A converter for a Nullable . NullableConverter A converter for a Nullable that default-constructs a converter of type TConverter to use as the underlying converter. Use this in the UseConverterAttribute ." - }, - "api/IPA.Config.Stores.Converters.NullableConverter-2.html": { - "href": "api/IPA.Config.Stores.Converters.NullableConverter-2.html", - "title": "Class NullableConverter", - "keywords": "Class NullableConverter A converter for a Nullable that default-constructs a converter of type TConverter to use as the underlying converter. Use this in the UseConverterAttribute . Inheritance Object ValueConverter < Nullable > NullableConverter NullableConverter Implements IValueConverter Inherited Members NullableConverter.FromValue(Value, Object) NullableConverter.ToValue(Nullable, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class NullableConverter : NullableConverter, IValueConverter where T : struct where TConverter : ValueConverter, new() Type Parameters Name Description T the underlying type of the Nullable TConverter the type to use as an underlying converter Constructors | Improve this Doc View Source NullableConverter() Creates a converter with a new TConverter as the underlying converter. Declaration public NullableConverter() See Also NullableConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also NullableConverter " - }, - "api/IPA.Config.Stores.Converters.NullableConverter-1.html": { - "href": "api/IPA.Config.Stores.Converters.NullableConverter-1.html", - "title": "Class NullableConverter", - "keywords": "Class NullableConverter A converter for a Nullable . Inheritance Object ValueConverter < Nullable > NullableConverter NullableConverter Implements IValueConverter Inherited Members ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class NullableConverter : ValueConverter, IValueConverter where T : struct Type Parameters Name Description T the underlying type of the Nullable Constructors | Improve this Doc View Source NullableConverter() Creates a converter with the default converter for the base type. Equivalent to new NullableConverter(Converter.Default) Declaration public NullableConverter() See Also NullableConverter(ValueConverter) Default | Improve this Doc View Source NullableConverter(ValueConverter) Creates a converter with the given underlying ValueConverter . Declaration public NullableConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the undlerlying ValueConverter to use Methods | Improve this Doc View Source FromValue(Value, Object) Converts a Value tree to a value. Declaration public override T? FromValue(Value value, object parent) Parameters Type Name Description Value value the Value tree to convert Object parent the object which will own the created object Returns Type Description Nullable the object represented by value Overrides IPA.Config.Stores.ValueConverter>.FromValue(IPA.Config.Data.Value, System.Object) | Improve this Doc View Source ToValue(Nullable, Object) Converts a nullable T to a Value tree. Declaration public override Value ToValue(T? obj, object parent) Parameters Type Name Description Nullable obj the value to serialize Object parent the object which owns obj Returns Type Description Value a Value tree representing obj . Overrides IPA.Config.Stores.ValueConverter>.ToValue(System.Nullable, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Config.Stores.Converters.ISetConverter-1.html": { + "href": "api/IPA.Config.Stores.Converters.ISetConverter-1.html", + "title": "Class ISetConverter", + "keywords": "Class ISetConverter A CollectionConverter for an ISet , creating a HashSet when deserializing. Inheritance Object ValueConverter < ISet > CollectionConverter > ISetConverter ISetConverter Implements IValueConverter Inherited Members CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(ISet, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(ISet, Object) ValueConverter>.ToValue(ISet, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class ISetConverter : CollectionConverter>, IValueConverter Type Parameters Name Description T the element type of the ISet Constructors | Improve this Doc View Source ISetConverter() Creates an ISetConverter using the default converter for T . Declaration public ISetConverter() See Also CollectionConverter() | Improve this Doc View Source ISetConverter(ValueConverter) Creates an ISetConverter using the specified underlying converter for values. Declaration public ISetConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the underlying ValueConverter to use for the values Methods | Improve this Doc View Source Create(Int32, Object) Creates a new ISet (a HashSet ) for deserialization. Declaration protected override ISet Create(int size, object parent) Parameters Type Name Description Int32 size the size to initialize it to Object parent the object that will own the new object Returns Type Description ISet the new ISet Overrides IPA.Config.Stores.Converters.CollectionConverter>.Create(System.Int32, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " }, "api/IPA.Config.Stores.Converters.IListConverter-2.html": { "href": "api/IPA.Config.Stores.Converters.IListConverter-2.html", "title": "Class IListConverter", "keywords": "Class IListConverter An IListConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter < IList > CollectionConverter > IListConverter IListConverter Implements IValueConverter Inherited Members IListConverter.Create(Int32, Object) CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(IList, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(IList, Object) ValueConverter>.ToValue(IList, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class IListConverter : IListConverter, IValueConverter where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TConverter the type of the converter to use for T Constructors | Improve this Doc View Source IListConverter() Creates an IListConverter using a default constructed TConverter element type. Equivalent to calling IListConverter(ValueConverter) with a default-constructed TConverter . Declaration public IListConverter() See Also IListConverter(ValueConverter) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also IListConverter " }, - "api/IPA.Config.Stores.Converters.IListConverter-1.html": { - "href": "api/IPA.Config.Stores.Converters.IListConverter-1.html", - "title": "Class IListConverter", - "keywords": "Class IListConverter A CollectionConverter for an IList , creating a List when deserializing. Inheritance Object ValueConverter < IList > CollectionConverter > IListConverter IListConverter Implements IValueConverter Inherited Members CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(IList, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(IList, Object) ValueConverter>.ToValue(IList, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class IListConverter : CollectionConverter>, IValueConverter Type Parameters Name Description T the element type of the IList Constructors | Improve this Doc View Source IListConverter() Creates an IListConverter using the default converter for T . Declaration public IListConverter() See Also CollectionConverter() | Improve this Doc View Source IListConverter(ValueConverter) Creates an IListConverter using the specified underlying converter for values. Declaration public IListConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the underlying ValueConverter to use for the values Methods | Improve this Doc View Source Create(Int32, Object) Creates a new IList (a List ) for deserialization. Declaration protected override IList Create(int size, object parent) Parameters Type Name Description Int32 size the size to initialize it to Object parent the object that will own the new object Returns Type Description IList the new IList Overrides IPA.Config.Stores.Converters.CollectionConverter>.Create(System.Int32, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also CollectionConverter " - }, - "api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html": { - "href": "api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html", - "title": "Class CustomObjectConverter", - "keywords": "Class CustomObjectConverter A ValueConverter for objects normally serialized to config via Generated(Config, Boolean) . Inheritance Object ValueConverter CustomObjectConverter Implements IValueConverter Inherited Members ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class CustomObjectConverter : ValueConverter, IValueConverter where T : class Type Parameters Name Description T the same type parameter that would be passed into Generated(Config, Boolean) Methods | Improve this Doc View Source Deserialize(Value, Object) Deserializes value into a T with the given parent . Declaration public static T Deserialize(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the parent object that will own the deserialized value Returns Type Description T the deserialized value See Also FromValue ( Value , Object ) | Improve this Doc View Source FromValue(Value, Object) Deserializes value into a T with the given parent . Declaration public override T FromValue(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the parent object that will own the deserialized value Returns Type Description T the deserialized value Overrides IPA.Config.Stores.ValueConverter.FromValue(IPA.Config.Data.Value, System.Object) See Also FromValue ( Value , Object ) | Improve this Doc View Source Serialize(T, Object) Serializes obj into a Value structure, given parent . Declaration public static Value Serialize(T obj, object parent) Parameters Type Name Description T obj the object to serialize Object parent the parent object that owns obj Returns Type Description Value the Value tree that represents obj See Also ToValue (T, Object ) | Improve this Doc View Source ToValue(T, Object) Serializes obj into a Value structure, given parent . Declaration public override Value ToValue(T obj, object parent) Parameters Type Name Description T obj the object to serialize Object parent the parent object that owns obj Returns Type Description Value the Value tree that represents obj Overrides IPA.Config.Stores.ValueConverter.ToValue(T, System.Object) See Also ToValue (T, Object ) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Generated ( Config , Boolean )" - }, - "api/IPA.Config.Stores.Converters.Converter.html": { - "href": "api/IPA.Config.Stores.Converters.Converter.html", - "title": "Class Converter", - "keywords": "Class Converter Provides utility functions for custom converters. Inheritance Object Converter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public static class Converter Methods | Improve this Doc View Source FloatValue(Value) Gets the floaing point value of a Value , coercing an Integer if necessary, or null if val is not an Integer or FloatingPoint . Declaration public static decimal? FloatValue(Value val) Parameters Type Name Description Value val the Value to get the floaing point value of Returns Type Description Nullable < Decimal > the floaing point value of val , or null | Improve this Doc View Source IntValue(Value) Gets the integral value of a Value , coercing a FloatingPoint if necessary, or null if val is not an Integer or FloatingPoint . Declaration public static long? IntValue(Value val) Parameters Type Name Description Value val the Value to get the integral value of Returns Type Description Nullable < Int64 > the integral value of val , or null" - }, - "api/IPA.Config.IConfigStore.html": { - "href": "api/IPA.Config.IConfigStore.html", - "title": "Interface IConfigStore", - "keywords": "Interface IConfigStore A storage for a config structure. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public interface IConfigStore Properties | Improve this Doc View Source SyncObject A synchronization object for the save thread to wait on for changes. It should be signaled whenever the internal state of the object is changed. The writer will never signal this handle. Declaration WaitHandle SyncObject { get; } Property Value Type Description WaitHandle | Improve this Doc View Source WriteSyncObject A synchronization object for the load thread and accessors to maintain safe synchronization. Any readers should take a read lock with EnterReadLock() or EnterUpgradeableReadLock() , and any writers should take a write lock with EnterWriteLock() . Declaration ReaderWriterLockSlim WriteSyncObject { get; } Property Value Type Description ReaderWriterLockSlim Remarks Read and write are read and write to this object , not to the file on disk. Methods | Improve this Doc View Source ReadFrom(ConfigProvider) Reads the config structure from the given IConfigProvider into the current IConfigStore . Declaration void ReadFrom(ConfigProvider provider) Parameters Type Name Description ConfigProvider provider the provider to read from Remarks The calling code will have entered a write lock on WriteSyncObject when this is called. | Improve this Doc View Source WriteTo(ConfigProvider) Writes the config structure stored by the current IConfigStore to the given IConfigProvider . Declaration void WriteTo(ConfigProvider provider) Parameters Type Name Description ConfigProvider provider the provider to write to Remarks The calling code will have entered a read lock on WriteSyncObject when this is called. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Config.Data.html": { - "href": "api/IPA.Config.Data.html", + "api/IPA.Config.Stores.Attributes.html": { + "href": "api/IPA.Config.Stores.Attributes.html", "title": "", - "keywords": "Classes Boolean A Value representing a boolean value. FloatingPoint A Value representing a floating point value. This may hold a Decimal 's worth of data. Integer A Value representing an integer. This may hold a Int64 's worth of data. List A list of Value s for serialization by an IConfigProvider . Use List() or From(IEnumerable) to create. Map A ordered map of String to Value for serialization by an IConfigProvider . Use Map() or From(IDictionary) to create. Text A Value representing a piece of text. The only reason this is not named String is so that it doesn't conflict with String . Value A base value type for config data abstract representations, to be serialized with an IConfigProvider . If a Value is null , then that represents just that: a null in whatever serialization is being used. Also contains factory functions for all derived types." - }, - "api/IPA.Config.Data.Text.html": { - "href": "api/IPA.Config.Data.Text.html", - "title": "Class Text", - "keywords": "Class Text A Value representing a piece of text. The only reason this is not named String is so that it doesn't conflict with String . Inheritance Object Value Text Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class Text : Value Properties | Improve this Doc View Source Value The actual value of this Text object. Declaration public string Value { get; set; } Property Value Type Description String Methods | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a quoted, unescaped string form of Value Overrides Value.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Config.Data.List.html": { - "href": "api/IPA.Config.Data.List.html", - "title": "Class List", - "keywords": "Class List A list of Value s for serialization by an IConfigProvider . Use List() or From(IEnumerable) to create. Inheritance Object Value List Implements IList < Value > ICollection < Value > IEnumerable < Value > IEnumerable Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class List : Value, IList, ICollection, IEnumerable, IEnumerable Properties | Improve this Doc View Source Count Gets the number of elements in the List . Declaration public int Count { get; } Property Value Type Description Int32 See Also Count | Improve this Doc View Source Item[Int32] Gets the value at the given index in this List . Declaration public Value this[int index] { get; set; } Parameters Type Name Description Int32 index the index to retrieve the Value at Property Value Type Description Value the Value at index See Also Item [ Int32 ] Methods | Improve this Doc View Source Add(Value) Adds a Value to the end of this List . Declaration public void Add(Value item) Parameters Type Name Description Value item the Value to add See Also Add (T) | Improve this Doc View Source AddRange(IEnumerable) Adds a range of Value s to the end of this List . Declaration public void AddRange(IEnumerable vals) Parameters Type Name Description IEnumerable < Value > vals the range of Value s to add | Improve this Doc View Source Clear() Clears the List . Declaration public void Clear() See Also Clear () | Improve this Doc View Source Contains(Value) Checks if the List contains a certian item. Declaration public bool Contains(Value item) Parameters Type Name Description Value item the Value to check for Returns Type Description Boolean true if the item was founc, otherwise false See Also Contains (T) | Improve this Doc View Source CopyTo(Value[], Int32) Copies the Value s in the List to the Array in array . Declaration public void CopyTo(Value[] array, int arrayIndex) Parameters Type Name Description Value [] array the Array to copy to Int32 arrayIndex the starting index to copy to See Also CopyTo (T[], Int32 ) | Improve this Doc View Source GetEnumerator() Gets an enumerator to enumerate the List . Declaration public IEnumerator GetEnumerator() Returns Type Description IEnumerator < Value > an IEnumerator for this List See Also GetEnumerator () | Improve this Doc View Source IndexOf(Value) Gets the index that a given Value is in the List . Declaration public int IndexOf(Value item) Parameters Type Name Description Value item the Value to search for Returns Type Description Int32 the index that the item was at, or -1. See Also IndexOf (T) | Improve this Doc View Source Insert(Int32, Value) Inserts a Value at an index. Declaration public void Insert(int index, Value item) Parameters Type Name Description Int32 index the index to insert at Value item the Value to insert See Also Insert ( Int32 , T) | Improve this Doc View Source Remove(Value) Removes a Value from the List . Declaration public bool Remove(Value item) Parameters Type Name Description Value item the Value to remove Returns Type Description Boolean true if the item was removed, false otherwise See Also Remove (T) | Improve this Doc View Source RemoveAt(Int32) Removes a Value at an index. Declaration public void RemoveAt(int index) Parameters Type Name Description Int32 index the index to remove a Value at See Also RemoveAt ( Int32 ) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a comma-seperated list of the result of ToString() wrapped in square brackets Overrides Value.ToString() Explicit Interface Implementations | Improve this Doc View Source ICollection.IsReadOnly Declaration bool ICollection.IsReadOnly { get; } Returns Type Description Boolean | Improve this Doc View Source IEnumerable.GetEnumerator() Declaration IEnumerator IEnumerable.GetEnumerator() Returns Type Description IEnumerator Implements System.Collections.Generic.IList System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable Extension Methods EnumerableExtensions.Prepend(IEnumerable, T) EnumerableExtensions.Append(IEnumerable, T) EnumerableExtensions.NonNull(IEnumerable) EnumerableExtensions.NonNull(IEnumerable, Func) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "keywords": "Classes IgnoreAttribute Causes a field or property in an object being wrapped by Generated(Config, Boolean) to be ignored during serialization and deserialization. NonNullableAttribute Indicates that a field or property in an object being wrapped by Generated(Config, Boolean) that would otherwise be nullable (i.e. a reference type or a Nullable type) should never be null, and the member will be ignored if the deserialized value is null . SerializedNameAttribute Specifies a name for the serialized field or property in an object being wrapped by Generated(Config, Boolean) that is different from the member name itself. UseConverterAttribute Indicates that a given field or property in an object being wrapped by Generated(Config, Boolean) should be serialized and deserialized using the provided converter instead of the default mechanism." }, "api/IPA.Config.Stores.Attributes.UseConverterAttribute.html": { "href": "api/IPA.Config.Stores.Attributes.UseConverterAttribute.html", "title": "Class UseConverterAttribute", "keywords": "Class UseConverterAttribute Indicates that a given field or property in an object being wrapped by Generated(Config, Boolean) should be serialized and deserialized using the provided converter instead of the default mechanism. Inheritance Object Attribute UseConverterAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Attributes Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class UseConverterAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source UseConverterAttribute(Type) Creates a new UseConverterAttribute with a given ConverterType . Declaration public UseConverterAttribute(Type converterType) Parameters Type Name Description Type converterType the type to assign to ConverterType Properties | Improve this Doc View Source ConverterTargetType Gets the target type of the converter if it is avaliable at instantiation time, otherwise null . Declaration public Type ConverterTargetType { get; } Property Value Type Description Type | Improve this Doc View Source ConverterType Gets the type of the converter to use. Declaration public Type ConverterType { get; } Property Value Type Description Type | Improve this Doc View Source IsGenericConverter Gets whether or not this converter is a generic ValueConverter . Declaration public bool IsGenericConverter { get; } Property Value Type Description Boolean Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.Config.Stores.Attributes.IgnoreAttribute.html": { - "href": "api/IPA.Config.Stores.Attributes.IgnoreAttribute.html", - "title": "Class IgnoreAttribute", - "keywords": "Class IgnoreAttribute Causes a field or property in an object being wrapped by Generated(Config, Boolean) to be ignored during serialization and deserialization. Inheritance Object Attribute IgnoreAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Attributes Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class IgnoreAttribute : Attribute, _Attribute Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Config.IConfigProvider.html": { - "href": "api/IPA.Config.IConfigProvider.html", - "title": "Interface IConfigProvider", - "keywords": "Interface IConfigProvider An interface for configuration providers. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public interface IConfigProvider Remarks Implementers must provide a default constructor. Do not assume that File will ever be set for a given object. Implementers are expected to preserve the typing of values passed to Store(Value, FileInfo) when returned from Load(FileInfo) . The only exceptions to this are the numeric types, Integer and FloatingPoint , since they can be coerced to each other with AsFloat() and AsInteger() respectively. The provider should however store and recover Integer with as much precision as is possible. For example, a JSON provider may decide to decode all numbers that have an integral value, even if they were originally FloatingPoint , as Integer . This is reasonable, as Integer is more precise, particularly with larger values, than FloatingPoint . Properties | Improve this Doc View Source Extension Gets the extension without a dot to use for files handled by this provider. Declaration string Extension { get; } Property Value Type Description String Remarks This must work immediately, and is used to generate the FileInfo used to set File . Methods | Improve this Doc View Source Load(FileInfo) Loads a Value from disk in whatever format this provider provides and returns it. Declaration Value Load(FileInfo file) Parameters Type Name Description FileInfo file the file to read from Returns Type Description Value the Value loaded | Improve this Doc View Source Store(Value, FileInfo) Stores the Value given to disk in the format specified. Declaration void Store(Value value, FileInfo file) Parameters Type Name Description Value value the Value to store FileInfo file the file to write to Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/IPA.Config.Data.Value.html": { - "href": "api/IPA.Config.Data.Value.html", - "title": "Class Value", - "keywords": "Class Value A base value type for config data abstract representations, to be serialized with an IConfigProvider . If a Value is null , then that represents just that: a null in whatever serialization is being used. Also contains factory functions for all derived types. Inheritance Object Value Boolean FloatingPoint Integer List Map Text Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public abstract class Value Methods | Improve this Doc View Source Bool(Boolean) Creates a new Boolean wrapping a Boolean . Declaration public static Boolean Bool(bool val) Parameters Type Name Description Boolean val the value to wrap Returns Type Description Boolean a Boolean wrapping val See Also From(Boolean) | Improve this Doc View Source Float(Decimal) Creates a new FloatingPoint wrapping a Decimal . Declaration public static FloatingPoint Float(decimal val) Parameters Type Name Description Decimal val the value to wrap Returns Type Description FloatingPoint a FloatingPoint wrapping val See Also From(Decimal) | Improve this Doc View Source From(Boolean) Creates a new Value wrapping a Boolean . Declaration public static Boolean From(bool val) Parameters Type Name Description Boolean val the value to wrap Returns Type Description Boolean a Boolean wrapping val See Also Bool(Boolean) | Improve this Doc View Source From(IDictionary) Creates a new Map holding the content of an IDictionary of String to Value . Declaration public static Map From(IDictionary vals) Parameters Type Name Description IDictionary < String , Value > vals the dictionary of Value s to initialize the Map wtih Returns Type Description Map a Map containing the content of vals See Also Map() From(IEnumerable>) | Improve this Doc View Source From(IEnumerable) Creates a new List holding the content of an IEnumerable of Value . Declaration public static List From(IEnumerable vals) Parameters Type Name Description IEnumerable < Value > vals the Value s to initialize the List with Returns Type Description List a List containing the content of vals See Also List() | Improve this Doc View Source From(IEnumerable>) Creates a new Map holding the content of an IEnumerable of KeyValuePair of String to Value . Declaration public static Map From(IEnumerable> vals) Parameters Type Name Description IEnumerable < KeyValuePair < String , Value >> vals the enumerable of KeyValuePair of name to Value Returns Type Description Map a Map containing the content of vals See Also Map() From(IDictionary) | Improve this Doc View Source From(Decimal) Creates a new Value wrapping a Double . Declaration public static FloatingPoint From(decimal val) Parameters Type Name Description Decimal val the value to wrap Returns Type Description FloatingPoint a FloatingPoint wrapping val See Also Float(Decimal) | Improve this Doc View Source From(Int64) Creates a new Value wrapping a Int64 . Declaration public static Integer From(long val) Parameters Type Name Description Int64 val the value to wrap Returns Type Description Integer a Integer wrapping val See Also Integer(Int64) | Improve this Doc View Source From(String) Creates a new Value representing a String . Declaration public static Text From(string val) Parameters Type Name Description String val the value to wrap Returns Type Description Text a Text wrapping val See Also Text(String) | Improve this Doc View Source Integer(Int64) Creates a new Integer wrapping a Int64 . Declaration public static Integer Integer(long val) Parameters Type Name Description Int64 val the value to wrap Returns Type Description Integer a Integer wrapping val See Also From(Int64) | Improve this Doc View Source List() Creates an empty List() . Declaration public static List List() Returns Type Description List an empty List() See Also From(IEnumerable) | Improve this Doc View Source Map() Creates an empty Map() . Declaration public static Map Map() Returns Type Description Map an empty Map() See Also From(IDictionary) From(IEnumerable>) | Improve this Doc View Source Null() Creates a Null Value . Declaration public static Value Null() Returns Type Description Value null | Improve this Doc View Source Text(String) Creates a new Text object wrapping a String . Declaration public static Text Text(string val) Parameters Type Name Description String val the value to wrap Returns Type Description Text a Text wrapping val See Also From(String) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public abstract override string ToString() Returns Type Description String a human-readable string containing the value provided Overrides Object.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" + "api/IPA.Config.Data.Map.html": { + "href": "api/IPA.Config.Data.Map.html", + "title": "Class Map", + "keywords": "Class Map A ordered map of String to Value for serialization by an IConfigProvider . Use Map() or From(IDictionary) to create. Inheritance Object Value Map Implements IDictionary < String , Value > ICollection < KeyValuePair < String , Value >> IEnumerable < KeyValuePair < String , Value >> IEnumerable Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class Map : Value, IDictionary, ICollection>, IEnumerable>, IEnumerable Properties | Improve this Doc View Source Count Gets the number of key-value pairs in this Map . Declaration public int Count { get; } Property Value Type Description Int32 See Also Count | Improve this Doc View Source Item[String] Accesses the Value at key in the map. Declaration public Value this[string key] { get; set; } Parameters Type Name Description String key the key to get the value associated with Property Value Type Description Value the value associated with the key See Also Item [TKey] | Improve this Doc View Source Keys Gets a collection of the keys for the Map . Declaration public ICollection Keys { get; } Property Value Type Description ICollection < String > See Also Keys | Improve this Doc View Source Values Gets a collection of the values in the Map . Declaration public ICollection Values { get; } Property Value Type Description ICollection < Value > Remarks Unlike all other iterables given by Map , this does not guarantee that order is maintained. See Also Values Methods | Improve this Doc View Source Add(String, Value) Adds a new Value with a given key. Declaration public void Add(string key, Value value) Parameters Type Name Description String key the key to put the value at Value value the Value to add See Also Add (TKey, TValue) | Improve this Doc View Source Clear() Clears the Map of its key-value pairs. Declaration public void Clear() See Also Clear () | Improve this Doc View Source ContainsKey(String) Checks if the Map contains a given key . Declaration public bool ContainsKey(string key) Parameters Type Name Description String key the key to check for Returns Type Description Boolean true if the key exists, otherwise false See Also ContainsKey (TKey) | Improve this Doc View Source GetEnumerator() Enumerates the Map 's key-value pairs. Declaration public IEnumerator> GetEnumerator() Returns Type Description IEnumerator < KeyValuePair < String , Value >> an IEnumerator of key-value pairs in this Map See Also GetEnumerator () | Improve this Doc View Source Remove(String) Removes the object associated with a key in this Map . Declaration public bool Remove(string key) Parameters Type Name Description String key the key to remove Returns Type Description Boolean true if the key existed, false otherwise See Also Remove (TKey) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a JSON-like set of key-value pairs Overrides Value.ToString() | Improve this Doc View Source TryGetValue(String, out Value) Gets the value associated with the specified key. Declaration public bool TryGetValue(string key, out Value value) Parameters Type Name Description String key the key of the value to get Value value the target location of the retrieved object Returns Type Description Boolean true if the key was found and value set, false otherwise See Also TryGetValue (TKey, TValue) Explicit Interface Implementations | Improve this Doc View Source ICollection>.Add(KeyValuePair) Declaration void ICollection>.Add(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item | Improve this Doc View Source ICollection>.Contains(KeyValuePair) Declaration bool ICollection>.Contains(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item Returns Type Description Boolean | Improve this Doc View Source ICollection>.CopyTo(KeyValuePair[], Int32) Declaration void ICollection>.CopyTo(KeyValuePair[] array, int arrayIndex) Parameters Type Name Description KeyValuePair < String , Value >[] array Int32 arrayIndex | Improve this Doc View Source ICollection>.IsReadOnly Declaration bool ICollection>.IsReadOnly { get; } Returns Type Description Boolean | Improve this Doc View Source ICollection>.Remove(KeyValuePair) Declaration bool ICollection>.Remove(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item Returns Type Description Boolean | Improve this Doc View Source IEnumerable.GetEnumerator() Declaration IEnumerator IEnumerable.GetEnumerator() Returns Type Description IEnumerator Implements System.Collections.Generic.IDictionary System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable Extension Methods EnumerableExtensions.Prepend(IEnumerable, T) EnumerableExtensions.Append(IEnumerable, T) EnumerableExtensions.NonNull(IEnumerable, Func) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, "api/IPA.Config.Data.Integer.html": { "href": "api/IPA.Config.Data.Integer.html", @@ -574,24 +579,19 @@ "title": "Class Config", "keywords": "Class Config An abstraction of a config file on disk, which handles synchronizing between a memory representation and the disk representation. Inheritance Object Config Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public class Config Properties | Improve this Doc View Source Name Gets the name associated with this Config object. Declaration public string Name { get; } Property Value Type Description String | Improve this Doc View Source Provider Gets the IConfigProvider associated with this Config object. Declaration public IConfigProvider Provider { get; } Property Value Type Description IConfigProvider Methods | Improve this Doc View Source GetConfigFor(String, String[]) Gets a Config object using the specified list of preferred config types. Declaration public static Config GetConfigFor(string configName, params string[] extensions) Parameters Type Name Description String configName the name of the mod for this config String [] extensions the preferred config types to try to get Returns Type Description Config a Config using the requested format, or of type JSON. | Improve this Doc View Source LoadAsync() Forces an asynchronous load from disk. Declaration public Task LoadAsync() Returns Type Description Task | Improve this Doc View Source LoadSync() Forces a synchronous load from disk. Declaration public void LoadSync() | Improve this Doc View Source Register(Type) Registers a IConfigProvider to use for configs. Declaration public static void Register(Type type) Parameters Type Name Description Type type the type to register | Improve this Doc View Source Register() Registers a IConfigProvider to use for configs. Declaration public static void Register() where T : IConfigProvider Type Parameters Name Description T the type to register | Improve this Doc View Source SetStore(IConfigStore) Sets this object's IConfigStore . Can only be called once. Declaration public void SetStore(IConfigStore store) Parameters Type Name Description IConfigStore store the IConfigStore to add to this instance Exceptions Type Condition InvalidOperationException If this was called before. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) GeneratedExtension.Generated(Config, Boolean)" }, - "api/IPA.Config.Config.NameAttribute.html": { - "href": "api/IPA.Config.Config.NameAttribute.html", - "title": "Class Config.NameAttribute", - "keywords": "Class Config.NameAttribute Specifies a preferred config name, instead of using the plugin's name. Inheritance Object Attribute Config.NameAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Parameter)] public sealed class NameAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source NameAttribute(String) Constructs the attribute with a specific name. Declaration public NameAttribute(string name) Parameters Type Name Description String name the name to use for the config. Properties | Improve this Doc View Source Name The name to use for the config. Declaration public string Name { get; } Property Value Type Description String the name to use for the config Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" - }, - "api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html": { - "href": "api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html", - "title": "Class MarkdownView", - "keywords": "Class MarkdownView A UI component that renders CommonMark Markdown in-game. Inheritance Object UnityEngine.Object UnityEngine.Component UnityEngine.Behaviour UnityEngine.MonoBehaviour MarkdownView Inherited Members UnityEngine.MonoBehaviour.IsInvoking() UnityEngine.MonoBehaviour.CancelInvoke() UnityEngine.MonoBehaviour.Invoke(System.String, System.Single) UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single) UnityEngine.MonoBehaviour.CancelInvoke(System.String) UnityEngine.MonoBehaviour.IsInvoking(System.String) UnityEngine.MonoBehaviour.StartCoroutine(System.String) UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object) UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine) UnityEngine.MonoBehaviour.StopCoroutine(System.String) UnityEngine.MonoBehaviour.StopAllCoroutines() UnityEngine.MonoBehaviour.print(System.Object) UnityEngine.MonoBehaviour.useGUILayout UnityEngine.Behaviour.enabled UnityEngine.Behaviour.isActiveAndEnabled UnityEngine.Component.GetComponent(System.Type) UnityEngine.Component.GetComponent() UnityEngine.Component.GetComponent(System.String) UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentInChildren(System.Type) UnityEngine.Component.GetComponentInChildren(System.Boolean) UnityEngine.Component.GetComponentInChildren() UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInChildren(System.Type) UnityEngine.Component.GetComponentsInChildren(System.Boolean) UnityEngine.Component.GetComponentsInChildren(System.Boolean, System.Collections.Generic.List) UnityEngine.Component.GetComponentsInChildren() UnityEngine.Component.GetComponentsInChildren(System.Collections.Generic.List) UnityEngine.Component.GetComponentInParent(System.Type) UnityEngine.Component.GetComponentInParent() UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInParent(System.Type) UnityEngine.Component.GetComponentsInParent(System.Boolean) UnityEngine.Component.GetComponentsInParent(System.Boolean, System.Collections.Generic.List) UnityEngine.Component.GetComponentsInParent() UnityEngine.Component.GetComponents(System.Type) UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List) UnityEngine.Component.GetComponents(System.Collections.Generic.List) UnityEngine.Component.GetComponents() UnityEngine.Component.CompareTag(System.String) UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessageUpwards(System.String, System.Object) UnityEngine.Component.SendMessageUpwards(System.String) UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessage(System.String, System.Object) UnityEngine.Component.SendMessage(System.String) UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.BroadcastMessage(System.String, System.Object) UnityEngine.Component.BroadcastMessage(System.String) UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.transform UnityEngine.Component.gameObject UnityEngine.Component.tag UnityEngine.Object.GetInstanceID() UnityEngine.Object.GetHashCode() UnityEngine.Object.Equals(System.Object) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform) UnityEngine.Object.Instantiate(UnityEngine.Object) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean) UnityEngine.Object.Instantiate(T) UnityEngine.Object.Instantiate(T, UnityEngine.Vector3, UnityEngine.Quaternion) UnityEngine.Object.Instantiate(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform) UnityEngine.Object.Instantiate(T, UnityEngine.Transform) UnityEngine.Object.Instantiate(T, UnityEngine.Transform, System.Boolean) UnityEngine.Object.Destroy(UnityEngine.Object, System.Single) UnityEngine.Object.Destroy(UnityEngine.Object) UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean) UnityEngine.Object.DestroyImmediate(UnityEngine.Object) UnityEngine.Object.FindObjectsOfType(System.Type) UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object) UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single) UnityEngine.Object.DestroyObject(UnityEngine.Object) UnityEngine.Object.FindSceneObjectsOfType(System.Type) UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type) UnityEngine.Object.FindObjectsOfType() UnityEngine.Object.FindObjectOfType() UnityEngine.Object.FindObjectsOfTypeAll(System.Type) UnityEngine.Object.FindObjectOfType(System.Type) UnityEngine.Object.ToString() UnityEngine.Object.name UnityEngine.Object.hideFlags Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : BSIPA_ModList.UI.ViewControllers Assembly : BSIPA-ModList.dll Syntax [RequireComponent(typeof(RectTransform))] public class MarkdownView : MonoBehaviour Constructors | Improve this Doc View Source MarkdownView() Creates a new MarkdownView . Should never be called directly. Instead, use UnityEngine.GameObject.AddComponent``1 . Declaration public MarkdownView() Fields | Improve this Doc View Source HasEmbeddedImage This function will be called whenever attempting to resolve an image URI, to ensure that the image exists in the embedded assembly. Declaration public Func HasEmbeddedImage Field Value Type Description Func < String , Boolean > a delegate for the function to call Properties | Improve this Doc View Source Markdown The text to be rendered. Declaration public string Markdown { get; set; } Property Value Type Description String the text to render as Markdown Remarks When this is assigned, the object is marked dirty. It will re-render on the next Update tick. | Improve this Doc View Source rectTransform A convenience property to access the UnityEngine.RectTransform on the UnityEngine.GameObject this is on. Declaration public RectTransform rectTransform { get; } Property Value Type Description UnityEngine.RectTransform the UnityEngine.RectTransform associated with this component Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.CopyComponent(Component, Type, GameObject, Type) ReflectionUtil.CopyComponent(Component, GameObject, Type)" + "api/BSIPA_ModList.UI.ViewControllers.html": { + "href": "api/BSIPA_ModList.UI.ViewControllers.html", + "title": "", + "keywords": "Classes MarkdownView A UI component that renders CommonMark Markdown in-game." }, - "api/IPA.OnEnableAttribute.html": { - "href": "api/IPA.OnEnableAttribute.html", - "title": "Class OnEnableAttribute", - "keywords": "Class OnEnableAttribute Indicates that the target method should be called when the plugin is enabled. Inheritance Object Attribute OnEnableAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnEnableAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Remarks This attribute is interchangable with OnStartAttribute , and is treated identically. They are seperate to allow plugin code to more clearly describe the intent of the methods. Typically, this will be used when the RuntimeOptions parameter of the plugins's PluginAttribute is DynamicInit . The method marked by this attribute will always be called from the Unity main thread. Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also PluginAttribute OnStartAttribute" + "api/IPA.Logging.Printers.GlobalLogFilePrinter.html": { + "href": "api/IPA.Logging.Printers.GlobalLogFilePrinter.html", + "title": "Class GlobalLogFilePrinter", + "keywords": "Class GlobalLogFilePrinter A printer for all messages to a unified log location. Inheritance Object LogPrinter GZFilePrinter GlobalLogFilePrinter Implements IDisposable Inherited Members GZFilePrinter.FileWriter GZFilePrinter.StartPrint() GZFilePrinter.EndPrint() GZFilePrinter.Dispose() GZFilePrinter.Dispose(Boolean) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class GlobalLogFilePrinter : GZFilePrinter, IDisposable Properties | Improve this Doc View Source Filter Provides a filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the target file. Declaration protected override FileInfo GetFileInfo() Returns Type Description FileInfo the target file to write to Overrides GZFilePrinter.GetFileInfo() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the associated file. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" }, - "api/IPA.OnDisableAttribute.html": { - "href": "api/IPA.OnDisableAttribute.html", - "title": "Class OnDisableAttribute", - "keywords": "Class OnDisableAttribute Indicates that the target method should be called when the plugin is disabled. Inheritance Object Attribute OnDisableAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnDisableAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Remarks This attribute is interchangable with OnExitAttribute , and is treated identically. They are seperate to allow plugin code to more clearly describe the intent of the methods. Typically, this will be used when the RuntimeOptions parameter of the plugins's PluginAttribute is DynamicInit . The method marked by this attribute will always be called from the Unity main thread. Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also PluginAttribute OnExitAttribute" + "api/IPA.Logging.Printers.ColorlessConsolePrinter.html": { + "href": "api/IPA.Logging.Printers.ColorlessConsolePrinter.html", + "title": "Class ColorlessConsolePrinter", + "keywords": "Class ColorlessConsolePrinter A colorless version of ColoredConsolePrinter , that indiscriminantly prints to standard out. Inheritance Object LogPrinter ColorlessConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColorlessConsolePrinter : LogPrinter Properties | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to standard out. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])" } } \ No newline at end of file diff --git a/branch/4.0.0-beta/manifest.json b/branch/4.0.0-beta/manifest.json index 6ddbaf35..98ae6098 100644 --- a/branch/4.0.0-beta/manifest.json +++ b/branch/4.0.0-beta/manifest.json @@ -18,7 +18,7 @@ "output": { ".html": { "relative_path": "api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html", - "hash": "kymf7Y6TCTXFM9Y7+0waVA==" + "hash": "qPYSexiWAhjXefZ0kXLM6Q==" } }, "is_incremental": false, @@ -42,7 +42,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Config.NameAttribute.html", - "hash": "+nOlR/PqCRv7MHaxa6BYTQ==" + "hash": "vZZjp3e50BAnQcpF76W2Wg==" } }, "is_incremental": false, @@ -54,7 +54,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Config.PreferAttribute.html", - "hash": "vkvKIyVwHm2P8E+pHVmDVg==" + "hash": "TkoBlielCyz1U2ONZ7x5rg==" } }, "is_incremental": false, @@ -66,7 +66,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Config.html", - "hash": "R2MgUKxgmg4i+Wbts6JsFw==" + "hash": "4WSb7JY7dTfYjXXdsfHDxg==" } }, "is_incremental": false, @@ -78,7 +78,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.ConfigProvider.html", - "hash": "R5cQYg2xkOJjQeMZ0h3hLQ==" + "hash": "mZUAH3AVMNHNlSodPc2Dug==" } }, "is_incremental": false, @@ -90,7 +90,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Data.Boolean.html", - "hash": "PeIzOnXkJCmXVZQRnO5MwQ==" + "hash": "mTMNd8j2Lf2Pr3T+/4j8uw==" } }, "is_incremental": false, @@ -102,7 +102,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Data.FloatingPoint.html", - "hash": "uMDWtNCwCi7j6EhFb/QJQw==" + "hash": "r2LWVJuehw7SOmCBRYsALA==" } }, "is_incremental": false, @@ -114,7 +114,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Data.Integer.html", - "hash": "jCYalifUf7kQUiXA8NVtWQ==" + "hash": "9c4UzhQWC0rPVKy+HF2hDQ==" } }, "is_incremental": false, @@ -126,7 +126,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Data.List.html", - "hash": "7Z+KXm6P7RJtz8c+Fd9GeQ==" + "hash": "+0fzN5exNt/7nMEdAq6KnA==" } }, "is_incremental": false, @@ -138,7 +138,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Data.Map.html", - "hash": "ZtNKqZfYyONHtvze7nAeew==" + "hash": "xFQI+bbQAbZKBpw3nZ80WQ==" } }, "is_incremental": false, @@ -150,7 +150,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Data.Text.html", - "hash": "YWX16VW2cLziKJnmZIeJ6Q==" + "hash": "y65UAYI8hcwT101mh+wjpg==" } }, "is_incremental": false, @@ -162,7 +162,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Data.Value.html", - "hash": "d86hh1SQB9ACN1I4HqSPoA==" + "hash": "XXJ0ymKZobHQsjStz6ybzA==" } }, "is_incremental": false, @@ -186,7 +186,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.IConfigProvider.html", - "hash": "M6PFZV0Z5+ZdWLLL8cK2FQ==" + "hash": "X1p4lBZKhoV2lE++qEr0Ng==" } }, "is_incremental": false, @@ -198,7 +198,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.IConfigStore.html", - "hash": "IerXRWrWzFdg/EIsX14dCg==" + "hash": "RPIoccli9K/wBtaC+11Onw==" } }, "is_incremental": false, @@ -210,7 +210,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.IModPrefs.html", - "hash": "YI2hf3Qhq6U5VlFWD5HR0g==" + "hash": "rC0WTJVToQAokayZmXwpYg==" } }, "is_incremental": false, @@ -222,7 +222,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.ModPrefs.html", - "hash": "wzkwdzf89YxWvWmXnKdwYA==" + "hash": "ocLfI1qOLjEsCaMTTUwxWg==" } }, "is_incremental": false, @@ -234,7 +234,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Attributes.IgnoreAttribute.html", - "hash": "mOIpTxz5SdLApppNxl1oKg==" + "hash": "Xkjy0T09Px02Ru+GMmnhbg==" } }, "is_incremental": false, @@ -246,7 +246,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Attributes.NonNullableAttribute.html", - "hash": "r2f7AoVmU5mqgM0x8C3rmA==" + "hash": "25Du4gpNc7uiWt6DhvNQEQ==" } }, "is_incremental": false, @@ -258,7 +258,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html", - "hash": "dHz3KY7F8R8IrBT6RnwgWA==" + "hash": "MzkZfmRIAkIZQVEqHvHnDA==" } }, "is_incremental": false, @@ -270,7 +270,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Attributes.UseConverterAttribute.html", - "hash": "HNjBzOOx5RtIRuY56RRNmg==" + "hash": "46PZcfInm1LSdf83Pk7aOw==" } }, "is_incremental": false, @@ -294,7 +294,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.CollectionConverter-2.html", - "hash": "z3Rb6MCj25aspO4ZlY33nw==" + "hash": "c4lvv7IAYOf+7NR2kmCLwg==" } }, "is_incremental": false, @@ -306,7 +306,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.CollectionConverter-3.html", - "hash": "3jDSqzdDEUX+cJ47k5pCXA==" + "hash": "HGLhupOR2qnywhAg4OTrvA==" } }, "is_incremental": false, @@ -318,7 +318,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.Converter-1.html", - "hash": "EnHj69aPgG+9e2mrB9f1uw==" + "hash": "OdCAnsI8HSvX7/Q24aTkOA==" } }, "is_incremental": false, @@ -330,7 +330,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.Converter.html", - "hash": "2kxbD1RX4crryVQ9c0dD0A==" + "hash": "mYlKL8vgJlYgyhyU5UmPUg==" } }, "is_incremental": false, @@ -342,7 +342,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html", - "hash": "9cBvO0cZmjyR+hs4y+sQCQ==" + "hash": "nr7yafUrhW/kWM20K0L94A==" } }, "is_incremental": false, @@ -354,7 +354,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.IListConverter-1.html", - "hash": "0FhfL9N6Qbib9+M7o6NsNg==" + "hash": "lPz3e+Nm2WmAbPy1QqONAw==" } }, "is_incremental": false, @@ -366,7 +366,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.IListConverter-2.html", - "hash": "PjNspycmOv3TOM+xOBOzOQ==" + "hash": "9y0q/IM+opzWbCOjlbHlEg==" } }, "is_incremental": false, @@ -378,7 +378,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.ISetConverter-1.html", - "hash": "Xxd2VnifL2Y1TWdzfXzQJg==" + "hash": "p5qxcftxm6BqLvzxqF72BQ==" } }, "is_incremental": false, @@ -390,7 +390,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.ISetConverter-2.html", - "hash": "P5zB1wrGAksfWAYxjbACmw==" + "hash": "sSemUenUlFY/sNEmpESQrQ==" } }, "is_incremental": false, @@ -402,7 +402,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.ListConverter-1.html", - "hash": "tHIplYODLL12YZ93DwiEWA==" + "hash": "t/JEiATi27/ZAkxLhKCwFw==" } }, "is_incremental": false, @@ -414,7 +414,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.ListConverter-2.html", - "hash": "r6sPKHx7FZMVDluwXRP2RQ==" + "hash": "sCK+LCwYuTH7E+3zCogY6w==" } }, "is_incremental": false, @@ -426,7 +426,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.NullableConverter-1.html", - "hash": "+1zf9TZ2q3gdocH78if1nQ==" + "hash": "30v1p6s2926cUvY4kcdw3Q==" } }, "is_incremental": false, @@ -438,7 +438,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.Converters.NullableConverter-2.html", - "hash": "FZeAkej0XZAx7FjlHBeRzA==" + "hash": "72y1spC3D/mkp/nyIFWdRA==" } }, "is_incremental": false, @@ -462,7 +462,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.GeneratedExtension.html", - "hash": "EPkqEVQ3IQW/CP/VViFTbA==" + "hash": "p1uvCw284NqWuUC+lJ5Uxw==" } }, "is_incremental": false, @@ -474,7 +474,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.IValueConverter.html", - "hash": "9sp/bTSi+WY7aFv3I3nzGw==" + "hash": "ZEwjZZZzAz85NP8VzA+J+g==" } }, "is_incremental": false, @@ -486,7 +486,7 @@ "output": { ".html": { "relative_path": "api/IPA.Config.Stores.ValueConverter-1.html", - "hash": "HJ10+bkGG4QZVHz2b6GP3A==" + "hash": "j85EaDNCu2o0N/KfI1RycA==" } }, "is_incremental": false, @@ -522,7 +522,7 @@ "output": { ".html": { "relative_path": "api/IPA.InitAttribute.html", - "hash": "YWvlNYLdHFCDwwBzzv8CKA==" + "hash": "w5FQcf6N9inq3Z9UsiUaGQ==" } }, "is_incremental": false, @@ -534,7 +534,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.CannotRuntimeDisableException.html", - "hash": "0I4TVRFIpDdN85cXa/JkwQ==" + "hash": "12nwVTc+lZYDrcW40YH6Fg==" } }, "is_incremental": false, @@ -546,7 +546,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.Features.Feature.html", - "hash": "B0KFiQGLUpEIh1TsagbcDQ==" + "hash": "jSL+DIqLhMHu9HrDYFBkUA==" } }, "is_incremental": false, @@ -570,7 +570,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.PluginInitInjector.InjectParameter.html", - "hash": "qjEYR1o1QpMbpkkIHkLrxQ==" + "hash": "W7k6XVESOs80ESzQsSfitA==" } }, "is_incremental": false, @@ -582,7 +582,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.PluginInitInjector.html", - "hash": "phqks+hNSbdGwitEuoCudA==" + "hash": "aS0ru0l3mRHIRhjqPrkDHg==" } }, "is_incremental": false, @@ -594,7 +594,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.PluginManager.PluginDisableDelegate.html", - "hash": "rHGkvHCzKENnAX4gmnr/UQ==" + "hash": "GWC4hvQN2EYy7ffLa65Weg==" } }, "is_incremental": false, @@ -606,7 +606,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.PluginManager.PluginEnableDelegate.html", - "hash": "RiPCmOsd8ujTf+nX7fI3hA==" + "hash": "mpLu2ZhySACH3k4IAuMazA==" } }, "is_incremental": false, @@ -618,7 +618,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.PluginManager.html", - "hash": "eMD/NWhKFqRM9ku4rpXEwA==" + "hash": "XLY3fH2rqX4ZU2qTQFoIBQ==" } }, "is_incremental": false, @@ -630,7 +630,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.PluginMetadata.html", - "hash": "0gjBbtiO9ZS6fN+9mmJ45g==" + "hash": "mZS8PsaG3WNY/M/7TTiaEA==" } }, "is_incremental": false, @@ -642,7 +642,7 @@ "output": { ".html": { "relative_path": "api/IPA.Loader.StateTransitionTransaction.html", - "hash": "OkES9s4ez+BiS8wzJu/n/Q==" + "hash": "bXeoYuCPWCXDjcsVAT+GJA==" } }, "is_incremental": false, @@ -666,7 +666,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.LogPrinter.html", - "hash": "fy+VaziTQl4nXw1kqr2Jhg==" + "hash": "bHo6WlaMzQsxbax+OxXCzg==" } }, "is_incremental": false, @@ -678,7 +678,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Logger.Level.html", - "hash": "oK+QV//1U+HVswyDJUKuHw==" + "hash": "Wz78o6g0XDynAyyfVDFe7A==" } }, "is_incremental": false, @@ -690,7 +690,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Logger.LogLevel.html", - "hash": "0WR25SFuFz70sVnnhjRTtA==" + "hash": "Wc6D7BOp7DFXX9uYLPu+2Q==" } }, "is_incremental": false, @@ -702,7 +702,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Logger.html", - "hash": "ARirmYn7DAO1k/PcgLmJKA==" + "hash": "2O5BY+BqePD+vpcoiQY7FQ==" } }, "is_incremental": false, @@ -714,7 +714,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.LoggerExtensions.html", - "hash": "UAbxq2eVggq8g28gG025oQ==" + "hash": "XVnILatBLschnRU4izDzRA==" } }, "is_incremental": false, @@ -726,7 +726,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Printers.ColoredConsolePrinter.html", - "hash": "xzcOkNHTVf+v0lbSf391uw==" + "hash": "E+uDqTEzX5qI1JtpcYhl+g==" } }, "is_incremental": false, @@ -738,7 +738,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Printers.ColorlessConsolePrinter.html", - "hash": "R+Q3wXj6Uct8WGznCeQQeg==" + "hash": "/HSGXhv9CGFmcKROHM4ETw==" } }, "is_incremental": false, @@ -750,7 +750,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Printers.GZFilePrinter.html", - "hash": "K97OE1Fbzdr4iaq937URLg==" + "hash": "W5j4uJwL30lOEFlwo214kw==" } }, "is_incremental": false, @@ -762,7 +762,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Printers.GlobalLogFilePrinter.html", - "hash": "RFFcOZwVsdzW5W2+/MhTLg==" + "hash": "3o8e+cOn0B9AHv0hME9OYw==" } }, "is_incremental": false, @@ -774,7 +774,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Printers.PluginLogFilePrinter.html", - "hash": "VA5K0Wf4/8OISwLb5EBOAg==" + "hash": "EblIw79XYR3kKxJw3KZZ0w==" } }, "is_incremental": false, @@ -786,7 +786,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.Printers.PluginSubLogPrinter.html", - "hash": "CE4IytB4KhpziT6VB5ghrQ==" + "hash": "/jVleanVAvNHWYjAYpokPQ==" } }, "is_incremental": false, @@ -810,7 +810,7 @@ "output": { ".html": { "relative_path": "api/IPA.Logging.StandardLogger.html", - "hash": "89qQxvZk+qro5lwOU1t4cA==" + "hash": "vcTrno2vs8iZNkQe79vbmg==" } }, "is_incremental": false, @@ -834,7 +834,7 @@ "output": { ".html": { "relative_path": "api/IPA.Old.IEnhancedPlugin.html", - "hash": "6ob7SsBdvcxdQ7Dsd3RrTw==" + "hash": "IxrFp/lQsuRBGG6jX9uytQ==" } }, "is_incremental": false, @@ -846,7 +846,7 @@ "output": { ".html": { "relative_path": "api/IPA.Old.IPlugin.html", - "hash": "X0IWQ6TltodCnDx8QIQQ/A==" + "hash": "CauMImuUrOR2LFIs+y9Xrg==" } }, "is_incremental": false, @@ -870,7 +870,7 @@ "output": { ".html": { "relative_path": "api/IPA.OnDisableAttribute.html", - "hash": "VVEDofLS+Hnr150CAIHNJA==" + "hash": "9arFjLHZBmXicOP+l/atcQ==" } }, "is_incremental": false, @@ -882,7 +882,7 @@ "output": { ".html": { "relative_path": "api/IPA.OnEnableAttribute.html", - "hash": "iicXweE+8ZEXFu6QdnEBDQ==" + "hash": "K/cs0cvjZiUpXQNOBeuEOQ==" } }, "is_incremental": false, @@ -894,7 +894,7 @@ "output": { ".html": { "relative_path": "api/IPA.OnExitAttribute.html", - "hash": "DFcTfp8xQj43IqQG3l6PAg==" + "hash": "LwE4uOa9aauPETu7U8ghQQ==" } }, "is_incremental": false, @@ -906,7 +906,7 @@ "output": { ".html": { "relative_path": "api/IPA.OnStartAttribute.html", - "hash": "iyV7p39pxKAxRUs1PvzCgA==" + "hash": "iyNj0W4pCHy7XVcSC6swkQ==" } }, "is_incremental": false, @@ -918,7 +918,7 @@ "output": { ".html": { "relative_path": "api/IPA.PluginAttribute.html", - "hash": "FwlBBPVuFmHtyTth4zDBow==" + "hash": "d6TvRZ7VwIr2bHMswRf3XQ==" } }, "is_incremental": false, @@ -930,7 +930,7 @@ "output": { ".html": { "relative_path": "api/IPA.RuntimeOptions.html", - "hash": "qKYH8udd719r78r9oo2LrA==" + "hash": "XQIRacwHq58OK5XMoqM/Dw==" } }, "is_incremental": false, @@ -942,7 +942,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.AlmostVersion.StoredAs.html", - "hash": "UxaXEJb6GiEMPLcfagTdDw==" + "hash": "3zYuOxVurDyt2JDlp7virA==" } }, "is_incremental": false, @@ -954,7 +954,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.AlmostVersion.html", - "hash": "xNFHwu6+rCRX+WUlNcxx1g==" + "hash": "NDqe9xkcLqWIK5LXJelsmQ==" } }, "is_incremental": false, @@ -966,7 +966,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.AlmostVersionConverter.html", - "hash": "dfAacU9SYXD4m7smrxir7w==" + "hash": "JtK8eanlJ1VqeCSA7qkjCQ==" } }, "is_incremental": false, @@ -978,7 +978,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Coroutines.html", - "hash": "nFj7zqN3llQZZtzCrALYIg==" + "hash": "HO2Gp6z9N/ABThiFgfH35A==" } }, "is_incremental": false, @@ -990,7 +990,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.SingleThreadTaskScheduler.html", - "hash": "+Wwr2w/zSuGf0cXt792MIg==" + "hash": "mtiGfUMzQfYJKgDHNDa/hA==" } }, "is_incremental": false, @@ -1002,7 +1002,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.MutexLocker.html", - "hash": "Ct4mCd+2ZXFEw9qX0+rR3Q==" + "hash": "BfmVbMzhjOgdptrhDC6PbQ==" } }, "is_incremental": false, @@ -1014,7 +1014,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html", - "hash": "6k2JdMfkCZz4mtV1fDrisg==" + "hash": "A02gpo+1RePRPyoUI5hOPQ==" } }, "is_incremental": false, @@ -1026,7 +1026,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html", - "hash": "zDZ0rSIHRJZVI/KBz1rh7Q==" + "hash": "p+oOYNTxAVGAKjTeXj3kAw==" } }, "is_incremental": false, @@ -1038,7 +1038,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html", - "hash": "2QBB3YoA4PtQFSTA2uK5UA==" + "hash": "pY7qRc1cA2yJ8OvwFguTRg==" } }, "is_incremental": false, @@ -1050,7 +1050,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html", - "hash": "wh//hqeTPLDKkaw22K3xAA==" + "hash": "E/AXRdT6NxVYEr0r6um5vA==" } }, "is_incremental": false, @@ -1062,7 +1062,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html", - "hash": "feJpZA+BMsX+JoWJ2hhcbA==" + "hash": "C3A12VLgVEoN0/w07raQXQ==" } }, "is_incremental": false, @@ -1074,7 +1074,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html", - "hash": "88qvK61Zf5R2Yw6vSybRgA==" + "hash": "4oWji6PLvy8NtjRU+w3oVA==" } }, "is_incremental": false, @@ -1086,7 +1086,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.Synchronization.html", - "hash": "NgTKLQmDzTgSB+H2PnwJkA==" + "hash": "Aa6MsnzjiZfGXSwloZWKHg==" } }, "is_incremental": false, @@ -1098,7 +1098,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html", - "hash": "46x5qmBHIPosrS0xAbZmDg==" + "hash": "lJQbXYOXysixyf6IunPbhA==" } }, "is_incremental": false, @@ -1122,7 +1122,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.CriticalSection.AutoExecuteSection.html", - "hash": "z3QVI2z0/+lOJAdsenOpZg==" + "hash": "FLPDeYEmJRDdyuGaiAt2vg==" } }, "is_incremental": false, @@ -1134,7 +1134,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.CriticalSection.html", - "hash": "lngf8CrwXSU/kgrXDgDR6A==" + "hash": "kQquFhYxq9yTd/I6euytww==" } }, "is_incremental": false, @@ -1146,7 +1146,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.EnumerableExtensions.html", - "hash": "uyWlMG+xx0zX8JOiuPfr4Q==" + "hash": "XtKYmKRbkA08xpiWHt6QdA==" } }, "is_incremental": false, @@ -1158,7 +1158,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Extensions.html", - "hash": "8pZaLIffpqx7zJ/MqR0Cww==" + "hash": "Br3sSHfr0soXu5RSu1y/Yw==" } }, "is_incremental": false, @@ -1170,7 +1170,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.FieldAccessor-2.Accessor.html", - "hash": "UognU32GPSIJg8wKSGAFyw==" + "hash": "y1XSIUGqKX/L9goEMZMteA==" } }, "is_incremental": false, @@ -1182,7 +1182,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.FieldAccessor-2.html", - "hash": "rd2HuraNLxZAr9dLpv5YYA==" + "hash": "X6NALFNyR2U1oVIAsTN0yQ==" } }, "is_incremental": false, @@ -1194,7 +1194,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.PropertyAccessor-2.Getter.html", - "hash": "B7zerNwoDX0bl69zWodorQ==" + "hash": "U3GaNVN818X8gDAsj+GTlQ==" } }, "is_incremental": false, @@ -1206,7 +1206,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.PropertyAccessor-2.Setter.html", - "hash": "wShJ6CScFBWXLw1CfGi0HQ==" + "hash": "U7Spd7n+3KWf8pF5pv128A==" } }, "is_incremental": false, @@ -1218,7 +1218,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.PropertyAccessor-2.html", - "hash": "W/u/nKUtN9ngGC+q0Xe3QA==" + "hash": "a97rp+jvRmskDVURtZPUiQ==" } }, "is_incremental": false, @@ -1230,7 +1230,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Ref-1.html", - "hash": "TNVdh4wZVXnq8WStZAekMw==" + "hash": "2cbBktKzBBQSgNuOzhqZxg==" } }, "is_incremental": false, @@ -1242,7 +1242,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Ref.html", - "hash": "/1fg1/p/RaSxPEiL6SfCMg==" + "hash": "VrUAZVlqLNTtnNLIusozag==" } }, "is_incremental": false, @@ -1254,7 +1254,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.ReflectionUtil.html", - "hash": "0UzelzcnCVv+jHluDhgiEg==" + "hash": "3deDD2AhlHf8nodZzsKIKA==" } }, "is_incremental": false, @@ -1266,7 +1266,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.UnityGame.Release.html", - "hash": "vu/JIPMJoHw489IHKYvaWw==" + "hash": "cvAu93rX2aA+fmFS77huWw==" } }, "is_incremental": false, @@ -1278,7 +1278,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.UnityGame.html", - "hash": "8bfuEIrnxKknTVZlwgqT6A==" + "hash": "6JgSZ2l7+DZn+LeF2Xo5oQ==" } }, "is_incremental": false, @@ -1290,7 +1290,7 @@ "output": { ".html": { "relative_path": "api/IPA.Utilities.Utils.html", - "hash": "5IBBmJFIoGK6ijzOdHXYJw==" + "hash": "JBder4XTkoeLSkmWy9Pegg==" } }, "is_incremental": false, @@ -1326,7 +1326,7 @@ "output": { ".html": { "relative_path": "api/index.html", - "hash": "aQb1FeVe02fdM2D4ZTa32A==" + "hash": "i68SUaPbTRNWD0IwgekcQQ==" } }, "is_incremental": false, @@ -1350,7 +1350,7 @@ "output": { ".html": { "relative_path": "articles/command-line.html", - "hash": "cNcy0V8gTJxBq3NtfG78tA==" + "hash": "Jq5j8oGpXuvNmz7B83Q9iQ==" } }, "is_incremental": false, @@ -1362,7 +1362,7 @@ "output": { ".html": { "relative_path": "articles/contributing.html", - "hash": "WdHSun88UZvzdxiv1RF0FQ==" + "hash": "TXLoYjmD/m0qRGwlz55Xhg==" } }, "is_incremental": false, @@ -1374,7 +1374,7 @@ "output": { ".html": { "relative_path": "articles/dev-resources/description.html", - "hash": "VZb0BXl45ksh/DjUxbvvcA==" + "hash": "UfHocgneElHUBmgezHEGMw==" } }, "is_incremental": false, @@ -1386,7 +1386,7 @@ "output": { ".html": { "relative_path": "articles/index.html", - "hash": "8g7yCZqYzjGSvFxkfCmHEA==" + "hash": "kV2/XzVZ1m0UKaJIRFv5yg==" } }, "is_incremental": false, @@ -1398,7 +1398,7 @@ "output": { ".html": { "relative_path": "articles/start-dev.html", - "hash": "ofoUcd3nI9GEMYwluhZXwg==" + "hash": "GXzZS6KWTkjCvQK3WtGz6w==" } }, "is_incremental": false, @@ -1410,7 +1410,7 @@ "output": { ".html": { "relative_path": "articles/start-user.html", - "hash": "+NVnJWEl33lFo+szwwP2/Q==" + "hash": "TixiRaRK1s/qAQhznabvcg==" } }, "is_incremental": false, @@ -1500,7 +1500,7 @@ "output": { ".html": { "relative_path": "index.html", - "hash": "ALUwgDP91XVLd2wzF3VTGQ==" + "hash": "8tz1ICwFcCDDZtqT417a7Q==" } }, "is_incremental": false, @@ -1512,7 +1512,7 @@ "output": { ".html": { "relative_path": "other_api/config/schema.html", - "hash": "T/2IYJ2yTbA6rem2di809Q==" + "hash": "eJXeL5mgkTOpdX3U0cdB5Q==" } }, "is_incremental": false, @@ -1524,7 +1524,7 @@ "output": { ".html": { "relative_path": "other_api/index.html", - "hash": "T2j3b9908RmC1eKUrfgYkg==" + "hash": "a7ZilkkFPchq/VzqbML9VQ==" } }, "is_incremental": false, @@ -1566,6 +1566,13 @@ "full_build_reason_code": "NoAvailableBuildCache" }, "processors": { + "TocDocumentProcessor": { + "can_incremental": false, + "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.", + "incrementalPhase": "build", + "total_file_count": 0, + "skipped_file_count": 0 + }, "ConceptualDocumentProcessor": { "can_incremental": false, "incrementalPhase": "build", @@ -1584,13 +1591,6 @@ "incrementalPhase": "build", "total_file_count": 0, "skipped_file_count": 0 - }, - "TocDocumentProcessor": { - "can_incremental": false, - "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.", - "incrementalPhase": "build", - "total_file_count": 0, - "skipped_file_count": 0 } } }, diff --git a/branch/4.0.0-beta/other_api/config/schema.html b/branch/4.0.0-beta/other_api/config/schema.html index d82ee571..254be0cf 100644 --- a/branch/4.0.0-beta/other_api/config/schema.html +++ b/branch/4.0.0-beta/other_api/config/schema.html @@ -173,7 +173,7 @@ diff --git a/branch/4.0.0-beta/other_api/index.html b/branch/4.0.0-beta/other_api/index.html index c651b7d7..4706a3a9 100644 --- a/branch/4.0.0-beta/other_api/index.html +++ b/branch/4.0.0-beta/other_api/index.html @@ -87,7 +87,7 @@