Merge branch 'dev' into mira-events-dev

This commit is contained in:
David Higueros committed 2026-11-11 15:34:29 -07:00
commit 32642fa6b5
26 files changed
+448 -572

No files matched your search

+9
View File
@@ -105,6 +105,12 @@ dotnet_diagnostic.S1244.severity = none
# S2325: Methods and properties that don't access instance data should be static
dotnet_diagnostic.S2325.severity = none
# CA1710: Identifiers should have correct suffix
dotnet_diagnostic.CA1710.severity = silent
# CA1010: Generic interface should also be implemented
dotnet_diagnostic.CA1010.severity = silent
# IDE0005: Using directive is unnecessary.
dotnet_diagnostic.IDE0005.severity = warning
@@ -113,3 +119,6 @@ dotnet_diagnostic.SA1114.severity = none
# SA1143: Conditional expressions must be formatted consistently
dotnet_diagnostic.SA1143.severity = none
# SA1504: All accessors should be single-line or multi-line
dotnet_diagnostic.SA1504.severity = none
+5 -3
View File
@@ -1,5 +1,4 @@
using System;
using System.Collections.Generic;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using HarmonyLib;
@@ -46,8 +45,11 @@ public static class PaletteManager
private static int originalLength;
internal static bool RegisterColors(Type type, MiraPluginInfo miraPlugin)
internal static bool RegisterColors(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var miraPlugin = context.MiraPlugin;
if (!type.TryGetCustomAttribute<RegisterCustomColorsAttribute>(out var attribute))
{
return false;
+15 -5
View File
@@ -75,8 +75,11 @@ public static class MiraEventManager
return true;
}
internal static bool RegisterEventType(Type eventType, MiraPluginInfo info)
internal static bool RegisterEventType(in MiraPluginManager.RegistrationContext context)
{
var eventType = context.Type;
var pluginInfo = context.PluginInfo;
if (eventType.IsAbstract || !eventType.IsSubclassOf(typeof(MiraEvent)))
{
return false;
@@ -91,7 +94,7 @@ public static class MiraEventManager
AddTypeToTracked(supertype, eventType);
}
info.InternalEventTypes.Add(eventType);
pluginInfo.InternalEventTypes.Add(eventType);
InternalEventTypes.Add(eventType);
return true;
@@ -334,11 +337,16 @@ public static class MiraEventManager
EventHandlersToLoad.Clear();
}
internal static void RegisterEvents(Type type, IMiraPlugin miraPlugin)
internal static bool RegisterEvents(in MiraPluginManager.RegistrationContext context)
{
if (!miraPlugin.ForceRegisterEvents && !type.IsDefined<RegisterEventContainerAttribute>())
var type = context.Type;
var miraPlugin = context.MiraPlugin;
var hasContainerAttribute = type.IsDefined<RegisterEventContainerAttribute>();
if (!miraPlugin.ForceRegisterEvents && !hasContainerAttribute)
{
return;
return false;
}
foreach (var method in type.GetMethods(MiraPluginManager.DeclaredStaticMembers))
@@ -356,5 +364,7 @@ public static class MiraEventManager
RegisterEventHandler(method, eventAttribute.Priority, eventAttribute.InvokeOnSubtype);
}
return hasContainerAttribute;
}
}
+9 -6
View File
@@ -1,6 +1,7 @@
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using MiraAPI.PluginLoading;
namespace MiraAPI.GameEnd;
@@ -14,26 +15,28 @@ public static class GameOverManager
private static int nextId = Enum.GetNames<GameOverReason>().Length;
internal static bool RegisterGameOver(Type gameOverType)
internal static bool RegisterGameOver(in MiraPluginManager.RegistrationContext context)
{
if (!typeof(CustomGameOver).IsAssignableFrom(gameOverType))
var type = context.Type;
if (!typeof(CustomGameOver).IsAssignableFrom(type))
{
return false;
}
if (gameOverType.IsAbstract)
if (type.IsAbstract)
{
return false;
}
if (gameOverType.GetConstructor(Type.EmptyTypes) == null)
if (type.GetConstructor(Type.EmptyTypes) == null)
{
Error("The type must have a parameterless constructor.");
return false;
}
GameOverIds.Add(gameOverType, nextId);
GameOverTypes.Add(nextId, gameOverType);
GameOverIds.Add(type, nextId);
GameOverTypes.Add(nextId, type);
nextId++;
return true;
}
+7 -4
View File
@@ -19,16 +19,19 @@ public static class CustomGameModeManager
return ++lastId;
}
internal static bool RegisterGameMode(Type gameModeType, MiraPluginInfo pluginInfo)
internal static bool RegisterGameMode(in MiraPluginManager.RegistrationContext context)
{
if (!typeof(AbstractGameMode).IsAssignableFrom(gameModeType))
var type = context.Type;
var pluginInfo = context.PluginInfo;
if (!typeof(AbstractGameMode).IsAssignableFrom(type))
{
return false;
}
if (Activator.CreateInstance(gameModeType) is not AbstractGameMode mode)
if (Activator.CreateInstance(type) is not AbstractGameMode mode)
{
Error($"Failed to create instance of {gameModeType.Name}");
Error($"Failed to create instance of {type.Name}");
return false;
}
@@ -154,9 +154,6 @@ public abstract class AbstractOptionGroup<T> : AbstractOptionGroup
public abstract class AbstractRoleOptionGroup<T> : AbstractOptionGroup<T>
where T : ICustomRole
{
/// <inheritdoc />
public override Type OptionableType => typeof(T);
/// <inheritdoc />
public override MenuCategory ParentMenu => MenuCategory.Roles;
@@ -15,7 +15,7 @@ namespace MiraAPI.GameOptions.Attributes;
public class ModdedEnumOptionListAttribute(string title, Type enumType, string[]? values = null)
: ModdedOptionListAttribute(title)
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
var optList = new ModdedOptionList<ModdedEnumOption>(
value.Count, idx => new(GetFormattedTitle(idx), (int)(value[idx] ?? 0), enumType, values));
@@ -25,14 +25,14 @@ public class ModdedEnumOptionListAttribute(string title, Type enumType, string[]
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedEnumOption;
var opt = HolderOptionList?.ElementAt(idx) as ModdedEnumOption;
opt?.SetValue((int)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedEnumOption opt
return HolderOptionList?.ElementAt(idx) is ModdedEnumOption opt
? Enum.ToObject(enumType, opt.Value)
: throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" with EnumType {enumType.FullName} is not a ModdedEnumOption");
}
@@ -49,7 +49,7 @@ public class ModdedEnumOptionListAttribute<T>(string title, string[]? values = n
: ModdedOptionListAttribute(title)
where T : struct, Enum
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
var optList = new ModdedOptionList<ModdedEnumOption<T>>(
value.Count, idx => new(GetFormattedTitle(idx), (T)(value[idx] ?? 0), values));
@@ -59,14 +59,14 @@ public class ModdedEnumOptionListAttribute<T>(string title, string[]? values = n
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedEnumOption<T>;
var opt = HolderOptionList?.ElementAt(idx) as ModdedEnumOption<T>;
opt?.SetValue((T)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedEnumOption<T> opt
return HolderOptionList?.ElementAt(idx) is ModdedEnumOption<T> opt
? opt.Value
: throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" with EnumType {typeof(T).FullName} is not a ModdedEnumOption<{typeof(T).FullName}>");
}
@@ -53,7 +53,7 @@ public class ModdedNumberOptionListAttribute(
{
}
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
return new ModdedOptionList<ModdedNumberOption>(value.Count, idx =>
{
@@ -81,7 +81,7 @@ public class ModdedNumberOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
if (HolderOptionList?[idx] is not ModdedNumberOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedNumberOption opt)
return;
var final = value switch
@@ -95,7 +95,7 @@ public class ModdedNumberOptionListAttribute(
/// <inheritdoc />
public override object GetValue(int idx)
{
if (HolderOptionList?[idx] is not ModdedNumberOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedNumberOption opt)
throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedNumberOption");
var value = opt.Value;
@@ -16,7 +16,7 @@ namespace MiraAPI.GameOptions.Attributes;
[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "Read above.")]
public abstract class ModdedOptionListAttribute(string title) : PropertyOptionAttribute
{
internal IModdedOptionList? HolderOptionList;
internal IBaseModdedOptionList? HolderOptionList;
internal IList? Value;
internal Type ValueType;
@@ -70,7 +70,7 @@ public abstract class ModdedOptionListAttribute(string title) : PropertyOptionAt
/// <returns>The value of the option as an object.</returns>
public abstract object GetValue(int idx);
internal abstract IModdedOptionList? CreateOptionList(IList value, PropertyInfo property);
internal abstract IBaseModdedOptionList? CreateOptionList(IList value, PropertyInfo property);
/// <summary>
/// Gets the <see cref="Title"/> formatted with the option's index.
@@ -16,7 +16,7 @@ public class ModdedPlayerOptionListAttribute(
bool allowNone = true)
: ModdedOptionListAttribute(title)
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
return new ModdedOptionList<ModdedPlayerOption>(value.Count, idx => new(GetFormattedTitle(idx), allowNone));
}
@@ -24,7 +24,7 @@ public class ModdedPlayerOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
if (HolderOptionList?[idx] is not ModdedPlayerOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedPlayerOption opt)
return;
var final = value switch
@@ -38,7 +38,7 @@ public class ModdedPlayerOptionListAttribute(
/// <inheritdoc />
public override object GetValue(int idx)
{
if (HolderOptionList?[idx] is not ModdedPlayerOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedPlayerOption opt)
throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedPlayerOption");
if (ValueType == typeof(int))
@@ -17,7 +17,7 @@ public class ModdedStringOptionListAttribute(
string[] values)
: ModdedOptionListAttribute(title)
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
return new ModdedOptionList<ModdedStringOption>(value.Count, idx =>
new ModdedStringOption(Title.Translate(), (string)(value[idx] ?? string.Empty), values));
@@ -26,14 +26,14 @@ public class ModdedStringOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedStringOption;
var opt = HolderOptionList?.ElementAt(idx) as ModdedStringOption;
opt?.SetValue((string)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedStringOption opt
return HolderOptionList?.ElementAt(idx) is ModdedStringOption opt
? opt.Value
: throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedStringOption");
}
@@ -28,7 +28,7 @@ public class ModdedToggleOptionListAttribute(
{
}
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
var optList = new ModdedOptionList<ModdedToggleOption>(
value.Count, idx => new(GetFormattedTitle(idx), (bool)(value[idx] ?? false), on, off));
@@ -38,14 +38,14 @@ public class ModdedToggleOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedToggleOption;
var opt = HolderOptionList?.ElementAt(idx) as ModdedToggleOption;
opt?.SetValue((bool)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedToggleOption opt
return HolderOptionList?.ElementAt(idx) is ModdedToggleOption opt
? opt.Value
: throw new InvalidOperationException($"Holder option for {GetFormattedTitle(idx)} is not a ModdedToggleOption.");
}
+27 -8
View File
@@ -1,4 +1,5 @@
using System;
using System.Collections;
using System.Collections.Generic;
using BepInEx.Configuration;
using MiraAPI.Networking;
@@ -143,9 +144,11 @@ public interface IModdedOption
}
/// <summary>
/// Interface for list of modded options.
/// Base interface for list of modded options.
/// <para/>
/// Do not implement directly, implement <see cref="IModdedOptionList"/> or <see cref="IModdedOptionList{T}"/> instead.
/// </summary>
public interface IModdedOptionList : IReadOnlyList<IModdedOption>
public interface IBaseModdedOptionList : IEnumerable
{
/// <summary>
/// Gets the function to name the keys of the individual options in the configuration file.
@@ -153,18 +156,34 @@ public interface IModdedOptionList : IReadOnlyList<IModdedOption>
/// Return <see langword="null"/> to use the default of the property's name with its index appended.
/// </summary>
Func<int, string>? ConfigName { get; init; }
/// <inheritdoc cref="IReadOnlyCollection{T}.Count"/>
int Count { get; }
/// <inheritdoc cref="System.Linq.Enumerable.ElementAt{TSource}(IEnumerable{TSource}, int)"/>
IModdedOption ElementAt(int index);
}
/// <summary>
/// Interface for list of modded options.
/// </summary>
public interface IModdedOptionList : IBaseModdedOptionList, IReadOnlyList<IModdedOption>
{
IModdedOption IBaseModdedOptionList.ElementAt(int index)
{
return this[index];
}
}
/// <summary>
/// Interface for list of <typeparamref name="T"/> options.
/// </summary>
/// <typeparam name="T">The type of <see cref="IModdedOption"/>.</typeparam>
public interface IModdedOptionList<out T> : IModdedOptionList
public interface IModdedOptionList<out T> : IBaseModdedOptionList, IReadOnlyList<T>
where T : IModdedOption
{
/// <inheritdoc cref="IReadOnlyList{T}.this[int]"/>
new T this[int index] { get; }
/// <inheritdoc cref="IEnumerable{T}.GetEnumerator"/>
new IEnumerator<T> GetEnumerator();
IModdedOption IBaseModdedOptionList.ElementAt(int index)
{
return this[index];
}
}
+9 -6
View File
@@ -70,8 +70,11 @@ public static class ModdedOptionsManager
"Major Code Smell",
"S3011:Reflection should not be used to increase accessibility of classes, methods, or fields",
Justification = "Dynamic singleton initialization requires reflection to bypass the private field access modifier because the type is only known at runtime.")]
internal static bool RegisterGroup(Type type, MiraPluginInfo pluginInfo)
internal static bool RegisterGroup(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var pluginInfo = context.PluginInfo;
if (!type.IsAssignableTo(typeof(AbstractOptionGroup)))
{
return false;
@@ -116,7 +119,7 @@ public static class ModdedOptionsManager
continue;
}
if (property.PropertyType.IsAssignableTo(typeof(IModdedOptionList)))
if (property.PropertyType.IsAssignableTo(typeof(IBaseModdedOptionList)))
{
RegisterPropertyOptionList(type, property, pluginInfo);
continue;
@@ -136,7 +139,7 @@ public static class ModdedOptionsManager
foreach (var field in type.GetFields(MiraPluginManager.DeclaredInstanceMembers)
.Where(f => !MiraPluginManager.IsAutoPropertyBackingField(f)
&& (f.FieldType.IsAssignableTo(typeof(IModdedOption)) || f.FieldType.IsAssignableTo(typeof(IModdedOptionList)))))
&& (f.FieldType.IsAssignableTo(typeof(IModdedOption)) || f.FieldType.IsAssignableTo(typeof(IBaseModdedOptionList)))))
{
Error($"{field.Name} is a field, not a property. Use properties for options.");
}
@@ -234,7 +237,7 @@ public static class ModdedOptionsManager
return;
}
if (property.GetValue(group) is not IModdedOptionList optionList)
if (property.GetValue(group) is not IBaseModdedOptionList optionList)
{
Error($"Failed to get option list for {property.Name}");
return;
@@ -244,7 +247,7 @@ public static class ModdedOptionsManager
for (var i = 0; i < optionList.Count; i++)
{
RegisterOption(optionList[i], group, configName(i), pluginInfo);
RegisterOption(optionList.ElementAt(i), group, configName(i), pluginInfo);
}
}
@@ -341,7 +344,7 @@ public static class ModdedOptionsManager
for (var i = 0; i < optionList.Count; i++)
{
var option = optionList[i];
var option = optionList.ElementAt(i);
if (visibilityFactory != null)
option.Visible = (Func<bool>)(visibilityFactory(i) ?? DelegateUtilities.AlwaysTrue);
@@ -62,13 +62,4 @@ public class ModdedOptionList<T> : IModdedOptionList<T>
{
return Options.GetEnumerator();
}
/// <inheritdoc cref="IEnumerable{T}.GetEnumerator"/>
IEnumerator<IModdedOption> IEnumerable<IModdedOption>.GetEnumerator()
{
return ((IEnumerable<IModdedOption>)Options).GetEnumerator();
}
/// <inheritdoc cref="IReadOnlyList{T}.this"/>
IModdedOption IReadOnlyList<IModdedOption>.this[int index] => this[index];
}
+19 -8
View File
@@ -16,17 +16,17 @@ public static class CustomButtonManager
/// <summary>
/// Gets a list of all registered custom <see cref="CustomActionButton"/>s.
/// </summary>
public static ReadOnlyCollection<CustomActionButton> Buttons { get; internal set; } = new([]);
public static ReadOnlyCollection<CustomActionButton> Buttons { get; private set; } = new([]);
/// <summary>
/// Gets a list of all registered button-specific <see cref="MiraButtonClickEvent"/>s.
/// </summary>
public static ReadOnlyDictionary<Type, Type> EventTypes { get; internal set; } = new(new Dictionary<Type, Type>());
public static ReadOnlyDictionary<Type, Type> EventTypes { get; private set; } = new(new Dictionary<Type, Type>());
/// <summary>
/// Gets a list of all registered button-specific <see cref="MiraButtonCancelledEvent"/>s.
/// </summary>
public static ReadOnlyDictionary<Type, Type> CancelledEventTypes { get; internal set; } = new(new Dictionary<Type, Type>());
public static ReadOnlyDictionary<Type, Type> CancelledEventTypes { get; private set; } = new(new Dictionary<Type, Type>());
internal static readonly List<CustomActionButton> CustomButtons = [];
internal static readonly Dictionary<Type, Type> ButtonEventTypes = [];
@@ -36,9 +36,12 @@ public static class CustomButtonManager
"Major Code Smell",
"S3011:Reflection should not be used to increase accessibility of classes, methods, or fields",
Justification = "Dynamic singleton initialization requires reflection to bypass the private field access modifier because the type is only known at runtime.")]
internal static bool RegisterButton(Type buttonType, MiraPluginInfo pluginInfo)
internal static bool RegisterButton(in MiraPluginManager.RegistrationContext context)
{
if (!buttonType.IsAssignableTo(typeof(CustomActionButton)) || Activator.CreateInstance(buttonType) is not CustomActionButton button)
var type = context.Type;
var pluginInfo = context.PluginInfo;
if (!type.IsAssignableTo(typeof(CustomActionButton)) || Activator.CreateInstance(type) is not CustomActionButton button)
{
return false;
}
@@ -46,13 +49,21 @@ public static class CustomButtonManager
CustomButtons.Add(button);
pluginInfo.InternalButtons.Add(button);
typeof(CustomButtonSingleton<>).MakeGenericType(buttonType)
typeof(CustomButtonSingleton<>).MakeGenericType(type)
.GetField("_instance", BindingFlags.Static | BindingFlags.NonPublic)! // Suppression message refers to this
.SetValue(null, button);
ButtonEventTypes.Add(buttonType, typeof(MiraButtonClickEvent<>).MakeGenericType(buttonType));
ButtonCancelledEventTypes.Add(buttonType, typeof(MiraButtonCancelledEvent<>).MakeGenericType(buttonType));
ButtonEventTypes.Add(type, typeof(MiraButtonClickEvent<>).MakeGenericType(type));
ButtonCancelledEventTypes.Add(type, typeof(MiraButtonCancelledEvent<>).MakeGenericType(type));
return true;
}
internal static void RegisterAllButtons()
{
// Save all buttons into a read-only collection for easy access
Buttons = new ReadOnlyCollection<CustomActionButton>(CustomButtonManager.CustomButtons);
EventTypes = new ReadOnlyDictionary<Type, Type>(CustomButtonManager.ButtonEventTypes);
CancelledEventTypes = new ReadOnlyDictionary<Type, Type>(CustomButtonManager.ButtonCancelledEventTypes);
}
}
+7 -4
View File
@@ -78,8 +78,11 @@ public static class KeybindManager
}
}
internal static bool RegisterKeybinds(Type type, IMiraPlugin plugin)
internal static bool RegisterKeybinds(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var miraPlugin = context.MiraPlugin;
if (!type.IsDefined<RegisterCustomKeybindsAttribute>())
{
return false;
@@ -87,7 +90,7 @@ public static class KeybindManager
foreach (var property in type.GetProperties(MiraPluginManager.DeclaredStaticMembers))
{
if (property.PropertyType != typeof(MiraKeybind))
if (!property.PropertyType.IsAssignableTo(typeof(MiraKeybind)))
{
continue;
}
@@ -99,10 +102,10 @@ public static class KeybindManager
}
Keybinds.Add(keybind);
keybind.SourcePluginName = plugin.OptionsTitleText.Translate();
keybind.SourcePluginName = miraPlugin.OptionsTitleText.Translate();
}
if (!plugin.DebugMode)
if (!miraPlugin.DebugMode)
return true;
foreach (var field in type.GetFields(MiraPluginManager.DeclaredStaticMembers)
@@ -4,7 +4,6 @@ using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Reflection;
using BepInEx.Configuration;
using BepInEx.Unity.IL2CPP;
using MiraAPI.LocalSettings.Attributes;
using MiraAPI.PluginLoading;
using MiraAPI.Utilities;
@@ -24,8 +23,11 @@ public static class LocalSettingsManager
"Major Code Smell",
"S3011:Reflection should not be used to increase accessibility of classes, methods, or fields",
Justification = "Dynamic singleton initialization requires reflection to bypass the private field access modifier because the type is only known at runtime.")]
internal static bool RegisterLocalTabs(Type type, BasePlugin pluginInfo)
internal static bool RegisterLocalTabs(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var basePlugin = context.BasePlugin;
if (!type.IsAssignableTo(typeof(LocalSettingsTab)))
{
return false;
@@ -37,7 +39,7 @@ public static class LocalSettingsManager
return false;
}
if (Activator.CreateInstance(type, pluginInfo.Config) is not LocalSettingsTab tabInstance)
if (Activator.CreateInstance(type, basePlugin.Config) is not LocalSettingsTab tabInstance)
{
return false;
}
@@ -22,28 +22,34 @@ public static class MeetingButtonManager
/// </summary>
public static List<MeetingActionButton> UntargetedButtons { get; internal set; } = [];
internal static bool RegisterTargetedMeetingButton(Type type, MiraPluginInfo info)
internal static bool RegisterTargetedMeetingButton(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var pluginInfo = context.PluginInfo;
if (!typeof(TargetedMeetingButton).IsAssignableFrom(type))
{
return false;
}
var button = (Activator.CreateInstance(type) as TargetedMeetingButton)!;
info.InternalTargetedMeetingButtons.Add(button);
pluginInfo.InternalTargetedMeetingButtons.Add(button);
TargetedButtons.Add(button);
return true;
}
internal static bool RegisterMeetingButton(Type type, MiraPluginInfo info)
internal static bool RegisterMeetingButton(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var pluginInfo = context.PluginInfo;
if (!typeof(MeetingActionButton).IsAssignableFrom(type))
{
return false;
}
var button = (Activator.CreateInstance(type) as MeetingActionButton)!;
info.InternalMeetingButtons.Add(button);
pluginInfo.InternalMeetingButtons.Add(button);
UntargetedButtons.Add(button);
return true;
}
+19 -10
View File
@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Runtime.Serialization;
using MiraAPI.Modifiers.Types;
@@ -25,7 +26,7 @@ public static class ModifierManager
/// <summary>
/// Gets the list of all registered <see cref="BaseModifier"/>s.
/// </summary>
public static IReadOnlyList<BaseModifier> Modifiers { get; internal set; } = [];
public static IReadOnlyList<BaseModifier> Modifiers { get; private set; } = [];
internal static List<BaseModifier> InternalModifiers { get; } = [];
@@ -61,31 +62,39 @@ public static class ModifierManager
return !TypeToIdModifierMap.TryGetValue(type, out var id) ? null : id;
}
internal static bool RegisterModifier(Type modifierType, MiraPluginInfo info)
internal static void RegisterAllModifiers()
{
if (!typeof(BaseModifier).IsAssignableFrom(modifierType))
Modifiers = new ReadOnlyCollection<BaseModifier>(InternalModifiers);
}
internal static bool RegisterModifier(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var pluginInfo = context.PluginInfo;
if (!typeof(BaseModifier).IsAssignableFrom(type))
{
return false;
}
var id = GetNextTypeId();
IdToTypeModifierMap.Add(id, modifierType);
TypeToIdModifierMap.Add(modifierType, id);
IdToTypeModifierMap.Add(id, type);
TypeToIdModifierMap.Add(type, id);
BaseModifier modifier;
var ctor = modifierType.GetConstructor(Type.EmptyTypes);
var ctor = type.GetConstructor(Type.EmptyTypes);
if (ctor != null)
{
modifier = (BaseModifier)Activator.CreateInstance(modifierType)!;
modifier = (BaseModifier)Activator.CreateInstance(type)!;
}
else
{
// this is probably terrible but its good enough for now.
modifier = (BaseModifier)FormatterServices.GetUninitializedObject(modifierType);
modifier = (BaseModifier)FormatterServices.GetUninitializedObject(type);
}
info.InternalModifiers.Add(modifier);
pluginInfo.InternalModifiers.Add(modifier);
InternalModifiers.Add(modifier);
if (modifier is not GameModifier gameModifier)
@@ -95,7 +104,7 @@ public static class ModifierManager
if (ctor == null)
{
Error($"Game Modifier {modifierType.FullName} does not have a parameterless constructor!");
Error($"Game Modifier {type.FullName} does not have a parameterless constructor!");
return false;
}
+73 -96
View File
@@ -88,6 +88,8 @@ public static class RoleGuidePatches
private static bool IsModifiersTabActive => ActiveGuideTabIndex == ModifiersTabIndex;
private static readonly PropertyInfo? CaretYOffset = typeof(TextBoxTMP).GetProperty("caretYOffset", BindingFlags.Instance | BindingFlags.Public);
[HarmonyPostfix]
[HarmonyPriority(Priority.First)]
[HarmonyPatch(typeof(MatchInfoGuide), nameof(MatchInfoGuide.CreateNormalModeSettings))]
@@ -214,16 +216,6 @@ public static class RoleGuidePatches
Coroutines.Start(CoPreload(__instance));
}
public static void TriggerPreload(MatchInfoGuide instance)
{
if (!instance || _populate != null)
{
return;
}
Coroutines.Start(CoPreload(instance));
}
private static IEnumerator CoPreload(MatchInfoGuide instance)
{
while (instance && (!HudManager.InstanceExists || !GameManager.Instance))
@@ -765,8 +757,7 @@ public static class RoleGuidePatches
modifier.ModifierCategoryTitle,
modifier.ParentMod.MiraPlugin.GetAbbreviatedModName(),
null,
modifier,
modifier.TypeId));
modifier));
}
}
@@ -802,8 +793,7 @@ public static class RoleGuidePatches
roleBehaviour.GetCategoryTitle(),
modId,
roleBehaviour,
null,
(uint)roleBehaviour.Role));
null));
}
_roleEntriesMode = activeModeType;
@@ -834,16 +824,14 @@ public static class RoleGuidePatches
private static float GetCaretYOffset(TextBoxTMP box)
{
if (CaretYOffset == null)
{
return 0f;
}
try
{
var prop = typeof(TextBoxTMP).GetProperty("caretYOffset", BindingFlags.Instance | BindingFlags.Public);
if (prop == null)
{
return 0f;
}
return Convert.ToSingle(prop.GetValue(box), CultureInfo.InvariantCulture);
return Convert.ToSingle(CaretYOffset.GetValue(box), CultureInfo.InvariantCulture);
}
catch
{
@@ -960,14 +948,13 @@ public static class RoleGuidePatches
}
}
private sealed class DetailedPanel(string title, string category, string modId, RoleBehaviour? role, GameModifier? modifier, uint typeId)
private sealed class DetailedPanel(string title, string category, string modId, RoleBehaviour? role, GameModifier? modifier)
{
public string Title => title;
public string Category => category;
public string ModId => modId;
public RoleBehaviour? Role => role;
public GameModifier? Modifier => modifier;
public uint TypeId => typeId;
public MatchInfoRolePanel? Panel { get; set; }
public int Amount { get; set; }
public int Chance { get; set; }
@@ -1004,12 +991,12 @@ public static class RoleGuidePatches
private static void UpdateSpinner()
{
if (_loadingSpinner != null)
{
_loadingSpinner.gameObject.SetActive(
_loading && ActiveGuideTabIndex is RolesTabIndex or ModifiersTabIndex &&
!(_wikiScroller && _wikiScroller.gameObject.activeSelf));
}
if (_loadingSpinner == null)
return;
_loadingSpinner.gameObject.SetActive(
_loading && ActiveGuideTabIndex is RolesTabIndex or ModifiersTabIndex &&
!(_wikiScroller && _wikiScroller.gameObject.activeSelf));
}
private static float GetGridScrollBounds(int count)
@@ -1074,14 +1061,16 @@ public static class RoleGuidePatches
foreach (var item in collection)
{
action(item);
if (timer.ElapsedMilliseconds > budget)
if (timer.ElapsedMilliseconds <= budget)
{
timer.Restart();
yield return null;
if (!_guide)
{
yield break;
}
continue;
}
timer.Restart();
yield return null;
if (!_guide)
{
yield break;
}
}
}
@@ -1188,15 +1177,17 @@ public static class RoleGuidePatches
{
ComputeCounts(entry);
entry.Visible = entry.CanShow && MatchesSearch(entry, searchText);
if (entry.Panel)
if (!entry.Panel)
{
dynamic entryType = entry.Modifier != null ? entry.Modifier : entry.Role!;
var text = GetPanelCountText(entryType, entry.Amount, entry.Chance, entry.ModId);
SetPanelCount(entry.Panel!, text);
if (!entry.Visible && entry.Panel!.gameObject.activeSelf)
{
entry.Panel.gameObject.SetActive(false);
}
continue;
}
dynamic entryType = entry.Modifier != null ? entry.Modifier : entry.Role!;
var text = GetPanelCountText(entryType, entry.Amount, entry.Chance, entry.ModId);
SetPanelCount(entry.Panel!, text);
if (!entry.Visible && entry.Panel!.gameObject.activeSelf)
{
entry.Panel.gameObject.SetActive(false);
}
}
@@ -1244,7 +1235,6 @@ public static class RoleGuidePatches
var activeModifiers = GetActiveModifiers();
var comparisons = activeModifiers.Select(x => x.TypeId).ToList();
comparisons.AddRange(GetActiveRoles().Select(x => (uint)x.Role));
return comparisons;
}
@@ -1450,26 +1440,20 @@ public static class RoleGuidePatches
{
if (hover)
{
switch (value)
return value switch
{
case SortingFilter.AllRoles:
return MiraAssets.VisibleAllHoverSprite;
case SortingFilter.DisabledOnly:
return MiraAssets.VisibleOffHoverSprite;
default:
return MiraAssets.VisibleOnHoverSprite;
}
SortingFilter.AllRoles => MiraAssets.VisibleAllHoverSprite,
SortingFilter.DisabledOnly => MiraAssets.VisibleOffHoverSprite,
_ => MiraAssets.VisibleOnHoverSprite,
};
}
switch (value)
return value switch
{
case SortingFilter.AllRoles:
return MiraAssets.VisibleAllIdleSprite;
case SortingFilter.DisabledOnly:
return MiraAssets.VisibleOffIdleSprite;
default:
return MiraAssets.VisibleOnIdleSprite;
}
SortingFilter.AllRoles => MiraAssets.VisibleAllIdleSprite,
SortingFilter.DisabledOnly => MiraAssets.VisibleOffIdleSprite,
_ => MiraAssets.VisibleOnIdleSprite,
};
}
public static void SwitchMethod()
@@ -1535,26 +1519,20 @@ public static class RoleGuidePatches
{
if (hover)
{
switch (value)
return value switch
{
case SortingGroups.Faction:
return MiraAssets.GroupFactionHoverSprite;
case SortingGroups.AmountChance:
return MiraAssets.GroupCountHoverSprite;
default:
return MiraAssets.GroupNoneHoverSprite;
}
SortingGroups.Faction => MiraAssets.GroupFactionHoverSprite,
SortingGroups.AmountChance => MiraAssets.GroupCountHoverSprite,
_ => MiraAssets.GroupNoneHoverSprite,
};
}
switch (value)
return value switch
{
case SortingGroups.Faction:
return MiraAssets.GroupFactionIdleSprite;
case SortingGroups.AmountChance:
return MiraAssets.GroupCountIdleSprite;
default:
return MiraAssets.GroupNoneIdleSprite;
}
SortingGroups.Faction => MiraAssets.GroupFactionIdleSprite,
SortingGroups.AmountChance => MiraAssets.GroupCountIdleSprite,
_ => MiraAssets.GroupNoneIdleSprite,
};
}
private static void CopyTextLayout(TextMeshPro source, TextMeshPro target)
@@ -1597,7 +1575,7 @@ public static class RoleGuidePatches
passiveButton.ClickSound = HudManager.Instance.MapButton.ClickSound;
passiveButton.OnMouseOver = new UnityEvent();
passiveButton.OnMouseOver.AddListener(
(UnityAction)(() => { panel.roleIcon.color = new Color32(255, 255, 255, 150); }));
(UnityAction)(() => panel.roleIcon.color = new Color32(255, 255, 255, 150)));
passiveButton.OnMouseOut = new UnityEvent();
passiveButton.OnMouseOut.AddListener((UnityAction)(() => { panel.roleIcon.color = Color.white; }));
@@ -1724,12 +1702,10 @@ public static class RoleGuidePatches
var roles = GetActiveRoles().Shuffle().ToList();
foreach (var role in roles)
{
if (role.RoleIconSolid == null)
if (role.RoleIconSolid != null)
{
continue;
return role.RoleIconSolid;
}
return role.RoleIconSolid;
}
return GetRandomFactionIcon();
@@ -1920,7 +1896,7 @@ public static class RoleGuidePatches
modId);
}
private static string GetPanelCountText(BaseModifier modifier, int amount, int chance, string modId)
private static string GetPanelCountText(GameModifier modifier, int amount, int chance, string modId)
{
return modifier.GetAmountText(amount, chance, modId);
}
@@ -2054,12 +2030,10 @@ public static class RoleGuidePatches
private static void EnterSettingsTab()
{
if (!_uiInitialized)
if (_uiInitialized)
{
return;
RefreshSettingsTab(true);
}
RefreshSettingsTab(true);
}
private static void LeaveSettingsTab()
@@ -2285,16 +2259,19 @@ public static class RoleGuidePatches
private static void UpdateSettingsTitle()
{
if (_titleText && IsSettingsTabActive)
if (!_titleText || !IsSettingsTabActive)
{
_titleText.text = GetSettingsTitle();
if (_titleIcon)
{
_titleIcon.sprite = GetSettingsIcon();
_titleIcon.SetSizeLimit(0.55f);
}
return;
}
_titleText.text = GetSettingsTitle();
if (!_titleIcon)
{
return;
}
_titleIcon.sprite = GetSettingsIcon();
_titleIcon.SetSizeLimit(0.55f);
}
/// <summary>
+37 -224
View File
@@ -1,6 +1,5 @@
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
@@ -31,6 +30,10 @@ namespace MiraAPI.PluginLoading;
[SuppressMessage("Major Code Smell", "S3011:Reflection should not be used to increase accessibility of classes, methods, or fields", Justification = "Intended behaviour.")]
public sealed class MiraPluginManager
{
internal delegate bool TypeRegistrationHandler(in RegistrationContext context);
internal readonly record struct RegistrationContext(Type Type, MiraPluginInfo PluginInfo, IMiraPlugin MiraPlugin, BasePlugin BasePlugin, List<Type> Roles);
private MiraPluginManager()
{
}
@@ -49,6 +52,23 @@ public sealed class MiraPluginManager
internal static ConfigFile MiraApiConfig { get; private set; } = null!;
internal static MiraPluginInfo MiraApiPluginInfo { get; private set; } = null!;
private static readonly (string LogContext, TypeRegistrationHandler Handler)[] RegistrationHandlers =
[
("events in", MiraEventManager.RegisterEvents),
("event type", MiraEventManager.RegisterEventType),
("options for", ModdedOptionsManager.RegisterGroup),
("options for", LocalSettingsManager.RegisterLocalTabs),
("color class", PaletteManager.RegisterColors),
("role for", CustomRoleManager.RegisterRole),
("modifier", ModifierManager.RegisterModifier),
("button", CustomButtonManager.RegisterButton),
("keybind class", KeybindManager.RegisterKeybinds),
("gamemode", CustomGameModeManager.RegisterGameMode),
("game over", GameOverManager.RegisterGameOver),
("meeting ability", MeetingButtonManager.RegisterMeetingButton),
("targeted meeting ability", MeetingButtonManager.RegisterTargetedMeetingButton),
];
/// <summary>
/// Get a mira plugin by its GUID.
/// </summary>
@@ -92,19 +112,14 @@ public sealed class MiraPluginManager
IL2CPPChainloader.Instance.Finished += () =>
{
PaletteManager.RegisterAllColors();
// Save all buttons into a read-only collection for easy access
CustomButtonManager.Buttons = new ReadOnlyCollection<CustomActionButton>(CustomButtonManager.CustomButtons);
CustomButtonManager.EventTypes = new ReadOnlyDictionary<Type, Type>(CustomButtonManager.ButtonEventTypes);
CustomButtonManager.CancelledEventTypes = new ReadOnlyDictionary<Type, Type>(CustomButtonManager.ButtonCancelledEventTypes);
CustomButtonManager.RegisterAllButtons();
ModifierManager.RegisterAllModifiers();
MiraEventManager.OnLoadFinalize();
// Cache all the registered plugins into an array for easy access
RegisteredPlugins = [.. _registeredPlugins.Values];
RegisteredPluginsWithOptions = [.. RegisteredPlugins.Where(m => m.MiraPlugin.DisplayOnOptionsMenu)];
PluginsWithOptionsOrGameModes = [.. RegisteredPlugins.Where(m => m.MiraPlugin.DisplayOnOptionsMenu || m.GameModes.Count > 0)];
ModifierManager.Modifiers = new ReadOnlyCollection<BaseModifier>(ModifierManager.InternalModifiers);
MiraEventManager.OnLoadFinalize();
};
}
@@ -138,7 +153,6 @@ public sealed class MiraPluginManager
field.Name.Contains(">k__BackingField", StringComparison.Ordinal);
}
[SuppressMessage("Minor Code Smell", "S3626:Jump statements should not be redundant", Justification = "Code consistency.")]
private static void ProcessAssemblyTypes(Assembly assembly, MiraPluginInfo info, BasePlugin basePlugin, IMiraPlugin plugin, List<Type> roles, bool isMira)
{
if (plugin.ForceRegisterEvents)
@@ -151,221 +165,20 @@ public sealed class MiraPluginManager
if ((isMira && type.IsAbstract) || type.IsDefined<MiraIgnoreAttribute>())
continue;
RegisterEvents(type, plugin);
var context = new RegistrationContext(type, info, plugin, basePlugin, roles);
if (RegisterEventType(type, info))
continue;
if (RegisterOptions(type, info))
continue;
if (RegisterLocalTabs(type, basePlugin))
continue;
if (RegisterColors(type, info))
continue;
if (RegisterRole(type, info, roles))
continue;
if (RegisterModifier(type, info))
continue;
if (RegisterButton(type, info))
continue;
if (RegisterKeybinds(type, plugin))
continue;
if (RegisterGameModeAttribute(type, info))
continue;
if (RegisterGameOver(type))
continue;
if (RegisterMeetingAbility(type, info))
continue;
if (RegisterTargetedMeetingAbility(type, info))
continue;
foreach (var (logContext, handler) in RegistrationHandlers)
{
try
{
if (handler(in context))
break;
}
catch (Exception e)
{
Error($"Failed to register {logContext} {type.Name}: {e}");
}
}
}
}
private static void RegisterEvents(Type type, IMiraPlugin miraPlugin)
{
try
{
MiraEventManager.RegisterEvents(type, miraPlugin);
}
catch (Exception e)
{
Error($"Failed to register events in {type.Name}: {e}");
}
}
private static bool RegisterEventType(Type type, MiraPluginInfo info)
{
try
{
return MiraEventManager.RegisterEventType(type, info);
}
catch (Exception e)
{
Error($"Failed to register event type {type.Name}: {e}");
return false;
}
}
private static bool RegisterGameOver(Type type)
{
try
{
return GameOverManager.RegisterGameOver(type);
}
catch (Exception e)
{
Error($"Failed to register game over {type.Name}: {e}");
return false;
}
}
private static bool RegisterOptions(Type type, MiraPluginInfo pluginInfo)
{
try
{
return ModdedOptionsManager.RegisterGroup(type, pluginInfo);
}
catch (Exception e)
{
Error($"Failed to register options for {type.Name}: {e}");
}
return false;
}
private static bool RegisterRole(Type type, MiraPluginInfo pluginInfo, List<Type> roles)
{
try
{
return CustomRoleManager.RegisterRole(type, pluginInfo, roles);
}
catch (Exception e)
{
Error($"Failed to register role for {type.Name}: {e}");
}
return false;
}
private static bool RegisterColors(Type type, MiraPluginInfo miraPlugin)
{
try
{
return PaletteManager.RegisterColors(type, miraPlugin);
}
catch (Exception e)
{
Error($"Failed to register color class {type.Name}: {e}");
}
return false;
}
private static bool RegisterModifier(Type type, MiraPluginInfo info)
{
try
{
return ModifierManager.RegisterModifier(type, info);
}
catch (Exception e)
{
Error($"Failed to register modifier {type.Name}: {e}");
}
return false;
}
private static bool RegisterButton(Type type, MiraPluginInfo pluginInfo)
{
try
{
return CustomButtonManager.RegisterButton(type, pluginInfo);
}
catch (Exception e)
{
Error($"Failed to register button {type.Name}: {e}");
}
return false;
}
private static bool RegisterGameModeAttribute(Type type, MiraPluginInfo pluginInfo)
{
try
{
return CustomGameModeManager.RegisterGameMode(type, pluginInfo);
}
catch (Exception e)
{
Error($"Failed to register gamemode {type.Name}: {e}");
}
return false;
}
private static bool RegisterLocalTabs(Type type, BasePlugin pluginInfo)
{
try
{
return LocalSettingsManager.RegisterLocalTabs(type, pluginInfo);
}
catch (Exception e)
{
Error($"Failed to register options for {type.Name}: {e}");
}
return false;
}
private static bool RegisterKeybinds(Type type, IMiraPlugin plugin)
{
try
{
return KeybindManager.RegisterKeybinds(type, plugin);
}
catch (Exception e)
{
Error($"Failed to register keybind class {type.Name}: {e}");
}
return false;
}
private static bool RegisterMeetingAbility(Type type, MiraPluginInfo info)
{
try
{
return MeetingButtonManager.RegisterMeetingButton(type, info);
}
catch (Exception e)
{
Error($"Failed to register meeting ability {type.Name}: {e}");
}
return false;
}
private static bool RegisterTargetedMeetingAbility(Type type, MiraPluginInfo info)
{
try
{
return MeetingButtonManager.RegisterTargetedMeetingButton(type, info);
}
catch (Exception e)
{
Error($"Failed to register targeted meeting ability {type.Name}: {e}");
}
return false;
}
}
+7 -3
View File
@@ -119,14 +119,18 @@ public static class CustomRoleManager
pluginInfo.PluginConfig.SaveOnConfigSet = oldConfigSetting;
}
internal static bool RegisterRole(Type type, MiraPluginInfo miraPlugin, List<Type> roles)
internal static bool RegisterRole(in MiraPluginManager.RegistrationContext context)
{
var type = context.Type;
var pluginInfo = context.PluginInfo;
var roles = context.Roles;
if (!(typeof(RoleBehaviour).IsAssignableFrom(type) && typeof(ICustomRole).IsAssignableFrom(type)))
{
return false;
}
if (!ModList.GetById(miraPlugin.PluginId).IsRequiredOnAllClients)
if (!ModList.GetById(pluginInfo.PluginId).IsRequiredOnAllClients)
{
Error("Custom roles are only supported on all clients.");
return false;
@@ -144,7 +148,7 @@ public static class CustomRoleManager
return null;
}
var roleBehaviour = (RoleBehaviour)new GameObject(roleType.Name).DontDestroy().AddComponent(Il2CppType.From(roleType));
var roleBehaviour = new GameObject(roleType.Name).DontDestroy().AddComponent(Il2CppType.From(roleType)).Cast<RoleBehaviour>();
if (roleBehaviour is not ICustomRole customRole)
{
+162 -154
View File
@@ -4,6 +4,7 @@ using System.IO;
using System.Linq;
using System.Reflection;
using System.Xml;
using AmongUs.Data;
using MiraAPI.Utilities;
using Reactor.Localization.Utilities;
using UnityEngine;
@@ -16,6 +17,8 @@ namespace MiraAPI.Translation;
public static class MiraLocaleManager
{
private const string LangDirectory = "mira_languages";
private const string RefPrefix = "@ref:";
private const int MaxDepth = 10;
// Language, XML Name, then Value
@@ -40,6 +43,7 @@ public static class MiraLocaleManager
/// </summary>
public static Dictionary<MiraLanguage, string> LangList { get; } = new()
{
// Vanilla
{ MiraLanguage.English, "en_US" },
{ MiraLanguage.Latam, "es_419" },
{ MiraLanguage.Brazilian, "pt_BR" },
@@ -56,51 +60,26 @@ public static class MiraLocaleManager
{ MiraLanguage.SChinese, "zh_CN" },
{ MiraLanguage.TChinese, "zh_TW" },
{ MiraLanguage.Irish, "ga_IE" },
{ MiraLanguage.Polish, "pl_PL" }, // Custom
{ MiraLanguage.Turkish, "tr_TR" }, // Custom
{ MiraLanguage.Swedish, "sv_SE" }, // Custom
{ MiraLanguage.Lithuanian, "lt_LT" }, // Custom
{ MiraLanguage.Czech, "cs_CZ" }, // Custom
{ MiraLanguage.LChinese, "lzh_CN" }, // Custom
{ MiraLanguage.Greek, "el_GR" }, // Custom
{ MiraLanguage.Arabic, "arb" }, // Custom
{ MiraLanguage.Hebrew, "heb" }, // Custom
// Custom
{ MiraLanguage.Polish, "pl_PL" },
{ MiraLanguage.Turkish, "tr_TR" },
{ MiraLanguage.Swedish, "sv_SE" },
{ MiraLanguage.Lithuanian, "lt_LT" },
{ MiraLanguage.Czech, "cs_CZ" },
{ MiraLanguage.LChinese, "lzh_CN" },
{ MiraLanguage.Greek, "el_GR" },
{ MiraLanguage.Arabic, "arb" },
{ MiraLanguage.Hebrew, "heb" },
};
private static readonly Dictionary<string, MiraLanguage> ReverseLangLookup =
LangList.ToDictionary(x => x.Value, x => x.Key);
/// <summary>
/// Gets a dictionary mapping <see cref="MiraLanguage"/> values to their standard language codes.
/// </summary>
public static Dictionary<MiraLanguage, string> LangCultureList { get; } = new()
{
// Vanilla
{ MiraLanguage.English, "en-US" },
{ MiraLanguage.Latam, "es-419" },
{ MiraLanguage.Brazilian, "pt-BR" },
{ MiraLanguage.Portuguese, "pt-PT" },
{ MiraLanguage.Korean, "ko-KR" },
{ MiraLanguage.Russian, "ru-RU" },
{ MiraLanguage.Dutch, "nl-NL" },
{ MiraLanguage.Filipino, "fil-PH" },
{ MiraLanguage.French, "fr-FR" },
{ MiraLanguage.German, "de-DE" },
{ MiraLanguage.Italian, "it-IT" },
{ MiraLanguage.Japanese, "ja-JP" },
{ MiraLanguage.Spanish, "es-ES" },
{ MiraLanguage.SChinese, "zh-CN" },
{ MiraLanguage.TChinese, "zh-TW" },
{ MiraLanguage.Irish, "ga-IE" },
// Custom
{ MiraLanguage.Polish, "pl-PL" },
{ MiraLanguage.Turkish, "tr-TR" },
{ MiraLanguage.Swedish, "sv-SE" },
{ MiraLanguage.Lithuanian, "lt-LT" },
{ MiraLanguage.Czech, "cs-CZ" },
{ MiraLanguage.LChinese, "lzh-CN" },
{ MiraLanguage.Greek, "el-GR" },
{ MiraLanguage.Arabic, "arb" },
{ MiraLanguage.Hebrew, "heb" },
};
public static Dictionary<MiraLanguage, string> LangCultureList { get; } =
LangList.ToDictionary(x => x.Key, x => x.Value.Replace('_', '-'));
/// <summary>
/// Gets the current language from Among Us settings.
@@ -111,7 +90,7 @@ public static class MiraLocaleManager
{
try
{
var langName = AmongUs.Data.DataManager.Settings.Language.CurrentLanguage;
var langName = DataManager.Settings.Language.CurrentLanguage;
return (MiraLanguage)langName;
}
catch
@@ -121,40 +100,24 @@ public static class MiraLocaleManager
}
}
/// <summary>
/// Registers translations for a mod.
/// Call once per mod during plugin Load().
/// </summary>
/// <param name="modGuid">The mod GUID (e.g., "mira.example").</param>
/// <inheritdoc cref="Register(string, string, Assembly)"/>
[Obsolete("Pass typeof(YourPlugin).Assembly directly to Register for better performance.")]
public static void Register(string modGuid)
{
var callingAssembly = Assembly.GetCallingAssembly();
LoadInternalStrings(callingAssembly, callingAssembly.GetName().Name!, modGuid);
LoadInternalStrings(Assembly.GetCallingAssembly(), modGuid);
}
/// <summary>
/// Registers translations for a mod.
/// Call once per mod during plugin Load().
/// </summary>
/// <param name="modGuid">The mod GUID (e.g., "mira.example").</param>
/// <param name="assembly">The <see cref="Assembly"/> to load the strings from.</param>
/// <inheritdoc cref="Register(string, string, Assembly)"/>
public static void Register(string modGuid, Assembly assembly)
{
LoadInternalStrings(assembly, assembly.GetName().Name!, modGuid);
LoadInternalStrings(assembly, modGuid);
}
/// <summary>
/// Registers translations for a mod.
/// Call once per mod during plugin Load().
/// </summary>
/// <param name="modGuid">The mod GUID (e.g., "mira.example").</param>
/// <param name="internalName">The mod's root namespace (e.g., "mira.api").</param>
/// <inheritdoc cref="Register(string, string, Assembly)"/>
[Obsolete("Pass typeof(YourPlugin).Assembly directly to Register for better performance.")]
public static void Register(string modGuid, string internalName)
{
var callingAssembly = Assembly.GetCallingAssembly();
LoadInternalStrings(callingAssembly, internalName, modGuid);
LoadInternalStrings(Assembly.GetCallingAssembly(), internalName, modGuid);
}
/// <summary>
@@ -169,15 +132,10 @@ public static class MiraLocaleManager
LoadInternalStrings(assembly, internalName, modGuid);
}
/// <summary>
/// Translates a key into the current language.
/// </summary>
/// <param name="key">The string id to find.</param>
/// <param name="fallback">Fallback string to use if no translation is found.</param>
/// <returns>A <see cref="string"/> based on the key provided.</returns>
/// <inheritdoc cref="Get(MiraLanguage, string, string)"/>
public static string Get(string key, string fallback = "")
{
return Get(CurrentLanguage, key, fallback != string.Empty ? fallback : key);
return Get(CurrentLanguage, key, string.IsNullOrEmpty(fallback) ? key : fallback);
}
/// <summary>
@@ -189,34 +147,30 @@ public static class MiraLocaleManager
/// <returns>A <see cref="string"/> based on the key provided.</returns>
public static string Get(MiraLanguage language, string key, string fallback = "")
{
if (Locale.TryGetValue(language, out var translations) &&
translations.TryGetValue(key, out var translation))
{
return translation;
}
var text = Locale.GetValueOrDefault(language)?.GetValueOrDefault(key);
if (Locale.TryGetValue(MiraLanguage.English, out var translationsEng) &&
translationsEng.TryGetValue(key, out var translationEng))
{
return translationEng;
}
if (language != MiraLanguage.English)
text ??= Locale.GetValueOrDefault(MiraLanguage.English)?.GetValueOrDefault(key);
return fallback;
return text ?? fallback;
}
/// <summary>
/// Translates a key into the current language.
/// </summary>
/// <param name="key">The string id to find.</param>
/// <param name="parseList">List of keys to change into other text.</param>
/// <param name="fallback">Fallback string to use if no translation is found.</param>
/// <returns>A <see cref="string"/> based on the key provided.</returns>
/// <inheritdoc cref="GetParsed(MiraLanguage, string, Dictionary{string, string}, string)"/>
public static string GetParsed(
string key,
Dictionary<string, string> parseList,
string fallback = "")
{
return GetParsed(CurrentLanguage, key, parseList, fallback != string.Empty ? fallback : key);
return GetParsed(CurrentLanguage, key, parseList, string.IsNullOrEmpty(fallback) ? key : fallback);
}
/// <inheritdoc cref="GetParsed(MiraLanguage, string, ValueTuple{string, string}[], string)"/>
public static string GetParsed(
string key,
(string, string)[] parseList,
string fallback = "")
{
return GetParsed(CurrentLanguage, key, parseList, string.IsNullOrEmpty(fallback) ? key : fallback);
}
/// <summary>
@@ -233,24 +187,35 @@ public static class MiraLocaleManager
Dictionary<string, string> parseList,
string fallback = "")
{
var text = fallback;
var text = Get(language, key, fallback);
if (Locale.TryGetValue(MiraLanguage.English, out var translationsEng) &&
translationsEng.TryGetValue(key, out var translationEng))
foreach (var (toReplace, value) in parseList)
{
text = translationEng;
text = text.Replace(toReplace, value);
}
if (language is not MiraLanguage.English &&
Locale.TryGetValue(language, out var translations) &&
translations.TryGetValue(key, out var translation))
{
text = translation;
}
return text;
}
foreach (var tmpText in parseList.Where(x => text.Contains(x.Key)))
/// <summary>
/// Translates a key into the current language.
/// </summary>
/// <param name="language">The specific language to prioritize.</param>
/// <param name="key">The string id to find.</param>
/// <param name="parseList">List of keys to change into other text.</param>
/// <param name="fallback">Fallback string to use if no translation is found.</param>
/// <returns>A <see cref="string"/> based on the key provided.</returns>
public static string GetParsed(
MiraLanguage language,
string key,
(string, string)[] parseList,
string fallback = "")
{
var text = Get(language, key, fallback);
foreach (var (toReplace, value) in parseList)
{
text = text.Replace(tmpText.Key, tmpText.Value);
text = text.Replace(toReplace, value);
}
return text;
@@ -268,12 +233,7 @@ public static class MiraLocaleManager
return idPart.StartsWith('#') ? idPart[1..] : $"{modId}.{idPart}.{suffix}";
}
/// <summary>
/// Builds a formatted translation ID string using a mod ID and a specific ID part.
/// </summary>
/// <param name="modId">The mod GUID.</param>
/// <param name="idPart">The core part of the ID. If it starts with '#', the character is stripped.</param>
/// <returns>A formatted translation ID <see cref="string"/>.</returns>
/// <inheritdoc cref="BuildTranslationId(string, string, string)"/>
public static string BuildTranslationId(string modId, string idPart)
{
return idPart.StartsWith('#') ? idPart[1..] : $"{modId}.{idPart}";
@@ -329,16 +289,16 @@ public static class MiraLocaleManager
{
var fileName = Path.GetFileNameWithoutExtension(filePath);
var lang = LangList.ContainsValue(fileName)
? LangList.First(x => x.Value == fileName).Key
: (MiraLanguage)(-1);
if ((int)lang == -1) continue;
if (!ReverseLangLookup.TryGetValue(fileName, out var lang))
{
continue;
}
try
{
Locale.TryAdd(lang, []);
var xmlContent = File.ReadAllText(filePath);
ParseXmlFile(xmlContent, lang, false);
using var fileStream = File.OpenRead(filePath);
ParseXmlFile(fileStream, lang, false);
}
catch (Exception e)
{
@@ -347,6 +307,11 @@ public static class MiraLocaleManager
}
}
private static void LoadInternalStrings(Assembly assembly, string modGuid)
{
LoadInternalStrings(assembly, assembly.GetName().Name!, modGuid);
}
private static void LoadInternalStrings(Assembly assembly, string internalName, string modGuid)
{
var resourcePrefix = $"{internalName}.Resources.Locale.";
@@ -354,27 +319,26 @@ public static class MiraLocaleManager
RegisteredModIds.Add(modGuid);
var atLeastOneLoaded = false;
foreach (var locale in LangList)
foreach (var (lang, name) in LangList)
{
using var resourceStream =
assembly.GetManifestResourceStream(resourcePrefix + locale.Value + ".xml");
using var resourceStream = assembly.GetManifestResourceStream(resourcePrefix + name + ".xml");
if (resourceStream == null)
{
// Silently skipped
continue;
}
using StreamReader reader = new(resourceStream);
var xmlContent = reader.ReadToEnd();
try
{
Locale.TryAdd(locale.Key, []);
ParseXmlFile(xmlContent, locale.Key, true);
Locale.TryAdd(lang, []);
ParseXmlFile(resourceStream, lang, true);
atLeastOneLoaded = true;
}
catch (Exception e)
{
Error($"Failed to load translation {resourcePrefix}{locale.Value}: {e.Message}");
Error($"Failed to load translation {resourcePrefix}{name}: {e.Message}");
}
}
@@ -391,52 +355,96 @@ public static class MiraLocaleManager
/// <param name="language">The language that the xml file corresponds to.</param>
/// <param name="loadingInternal">Flag that indicates if the xml being parsed is internal or not.</param>
public static void ParseXmlFile(string xmlContent, MiraLanguage language, bool loadingInternal)
{
using var stringReader = new StringReader(xmlContent);
using var xmlReader = XmlReader.Create(stringReader);
ParseXml(xmlReader, language, loadingInternal);
}
/// <summary>
/// Parses the provided xml stream into translation keys and values and registers them to the locale manager.
/// </summary>
/// <param name="xmlStream">The stream to the xml content.</param>
/// <param name="language">The language that the xml file corresponds to.</param>
/// <param name="loadingInternal">Flag that indicates if the xml being parsed is internal or not.</param>
public static void ParseXmlFile(Stream xmlStream, MiraLanguage language, bool loadingInternal)
{
using var reader = XmlReader.Create(xmlStream);
ParseXml(reader, language, loadingInternal);
}
private static void ParseXml(XmlReader reader, MiraLanguage language, bool loadingInternal)
{
var dict = Locale[language];
XmlDocument xmlDoc = new();
var total = 0;
var pendingRefs = new Dictionary<string, string>();
try
{
xmlDoc.LoadXml(xmlContent);
var stringNodes = xmlDoc.SelectNodes("/resources/string");
if (stringNodes == null)
while (reader.ReadToFollowing("string"))
{
return;
var name = reader.GetAttribute("name");
if (string.IsNullOrEmpty(name))
continue;
if (loadingInternal && dict.ContainsKey(name))
{
Error($"String for \"{name}\" in {language} was overwritten by a duplicate!");
}
var value = reader.ReadElementContentAsString();
if (value.StartsWith(RefPrefix, StringComparison.Ordinal))
{
pendingRefs[name] = value[RefPrefix.Length..];
}
else
{
value = value.Replace('[', '<')
.Replace(']', '>')
.Replace("<nl>", "\n")
.Replace("<and>", "&");
dict[name] = value;
total++;
}
}
var total = 0;
foreach (XmlNode node in stringNodes)
foreach (var unresolved in pendingRefs)
{
if (node.Attributes?["name"] == null)
var originalKey = unresolved.Key;
var currentTarget = unresolved.Value;
var depth = 0;
var resolved = false;
while (depth < MaxDepth)
{
continue;
if (dict.TryGetValue(currentTarget, out var resolvedValue))
{
dict[originalKey] = resolvedValue;
total++;
resolved = true;
break;
}
if (pendingRefs.TryGetValue(currentTarget, out var nextTarget))
{
currentTarget = nextTarget;
depth++;
}
else
{
Error($"Translation reference '{unresolved.Value}' for '{originalKey}' not found.");
break;
}
}
var name = node.Attributes["name"]!.Value;
var value = node.InnerText;
if (string.IsNullOrEmpty(name)) continue;
if (value.Contains('['))
if (!resolved && depth >= MaxDepth)
{
value = value.Replace('[', '<');
Error($"Circular translation reference or max depth exceeded for '{originalKey}'.");
}
if (value.Contains(']'))
{
value = value.Replace(']', '>');
}
value = value.Replace("<nl>", "\n").Replace("<and>", "&");
if (loadingInternal && Locale[language].ContainsKey(name))
{
Error($"String for \"{name}\" in {language} was overwritten by duplicate!");
}
dict[name] = value;
total++;
}
Info($"Loaded {language.ToDisplayString()} translation with ({total} keys)");
+2 -2
View File
@@ -26,9 +26,9 @@ public abstract class LoadableAsset<T>
/// Converts the <see cref="LoadableAsset{T}"/> into its <typeparamref name="T"/> by loading the asset.
/// </summary>
/// <param name="loadable">The <see cref="LoadableAsset{T}"/> to get the asset from.</param>
public static implicit operator T(LoadableAsset<T> loadable)
public static implicit operator T(LoadableAsset<T>? loadable)
{
return loadable.LoadAsset();
return loadable?.LoadAsset()!;
}
/// <summary>
+6
View File
@@ -96,4 +96,10 @@ public class StateMachineWrapper<T>
_propertyCache[parameterName] = property;
return (TField)property.GetValue(_stateMachine)!;
}
/// <summary>
/// Implicitly converts a state machine wrapper into its <typeparamref name="T"/> instance.
/// </summary>
/// <param name="wrapper">The wrapper.</param>
public static implicit operator T(StateMachineWrapper<T> wrapper) => wrapper.Instance;
}