mirror of
https://github.com/All-Of-Us-Mods/MiraAPI.git
synced 2026-10-20 01:46:15 +00:00
Fixed annotations with double > annotations
This commit is contained in:
1 parent
8852c014ab
commit
62c8e27535
10 files changed
+17
-17
No files matched your search
@@ -18,7 +18,7 @@ public class CheckForEndVotingEvent : MiraCancelableEvent
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="CheckForEndVotingEvent"/> class.
|
||||
/// </summary>
|
||||
/// <param name="isVotingComplete">><see langword="true"/> if voting is complete, <see langword="false"/> otherwise.</param>
|
||||
/// <param name="isVotingComplete"><see langword="true"/> if voting is complete, <see langword="false"/> otherwise.</param>
|
||||
public CheckForEndVotingEvent(bool isVotingComplete)
|
||||
{
|
||||
IsVotingComplete = isVotingComplete;
|
||||
|
||||
@@ -32,7 +32,7 @@ public class MeetingSelectEvent : MiraEvent
|
||||
/// </summary>
|
||||
/// <param name="playerVoteData">The voter's <see cref="PlayerVoteData"/>.</param>
|
||||
/// <param name="targetId">The target's playerId.</param>
|
||||
/// <param name="allowSelect">>Whether the player is allowed to select the target.</param>
|
||||
/// <param name="allowSelect">Whether the player is allowed to select the target.</param>
|
||||
public MeetingSelectEvent(PlayerVoteData playerVoteData, int targetId, bool allowSelect)
|
||||
{
|
||||
VoteData = playerVoteData;
|
||||
|
||||
@@ -10,7 +10,7 @@ namespace MiraAPI.Events.Vanilla.Meeting.Voting;
|
||||
/// <remarks>
|
||||
/// Initializes a new instance of the <see cref="ProcessVotesEvent"/> class.
|
||||
/// </remarks>
|
||||
/// <param name="votes">>The list of <see cref="CustomVote"/>s that are being processed.</param>
|
||||
/// <param name="votes">The list of <see cref="CustomVote"/>s that are being processed.</param>
|
||||
/// <param name="exiledPlayer">The player to be exiled. Will be <see langword="null"/> if no player is to be exiled.</param>
|
||||
public class ProcessVotesEvent(List<CustomVote> votes, NetworkedPlayerInfo? exiledPlayer = null) : MiraEvent
|
||||
{
|
||||
|
||||
@@ -20,7 +20,7 @@ public static class GameOverManager
|
||||
/// </summary>
|
||||
/// <param name="gameOverType">Type of the <see cref="CustomGameOver"/>.</param>
|
||||
/// <exception cref="ArgumentException">Thrown when the type is not a subclass of <see cref="CustomGameOver"/>, is abstract, or does not have a parameterless constructor.</exception>
|
||||
/// <returns>><see langword="true"/> if the game over was registered successfully, <see langword="false"/> otherwise.</returns>
|
||||
/// <returns><see langword="true"/> if the game over was registered successfully, <see langword="false"/> otherwise.</returns>
|
||||
public static bool RegisterGameOver(Type gameOverType)
|
||||
{
|
||||
if (!typeof(CustomGameOver).IsAssignableFrom(gameOverType))
|
||||
|
||||
@@ -63,26 +63,26 @@ public interface IModdedOption
|
||||
/// <param name="numberOpt">The <see cref="NumberOption"/> template.</param>
|
||||
/// <param name="stringOpt">The <see cref="StringOption"/> template.</param>
|
||||
/// <param name="playerOpt">The <see cref="PlayerOption"/> template.</param>
|
||||
/// <param name="container">>The <see cref="Transform"/> container for the option.</param>
|
||||
/// <returns>>The created <see cref="global::OptionBehaviour"/> object.</returns>
|
||||
/// <param name="container">The <see cref="Transform"/> container for the option.</param>
|
||||
/// <returns>The created <see cref="global::OptionBehaviour"/> object.</returns>
|
||||
OptionBehaviour CreateOption(ToggleOption toggleOpt, NumberOption numberOpt, StringOption stringOpt, PlayerOption playerOpt, Transform container);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value as a <see langword="float"/>.
|
||||
/// </summary>
|
||||
/// <returns>>The value of the option as a <see langword="float"/>.</returns>
|
||||
/// <returns>The value of the option as a <see langword="float"/>.</returns>
|
||||
float GetFloatData();
|
||||
|
||||
/// <summary>
|
||||
/// Gets the <see cref="NetData"/> for the option, used for network synchronization.
|
||||
/// </summary>
|
||||
/// <returns>>Returns the <see cref="NetData"/> object for the option.</returns>
|
||||
/// <returns>Returns the <see cref="NetData"/> object for the option.</returns>
|
||||
NetData GetNetData();
|
||||
|
||||
/// <summary>
|
||||
/// Handles incoming network data for the option.
|
||||
/// </summary>
|
||||
/// <param name="data">>The byte array representing the network data.</param>
|
||||
/// <param name="data">The byte array representing the network data.</param>
|
||||
void HandleNetData(byte[] data);
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -40,9 +40,9 @@ public class OptionPreset
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="OptionPreset"/> class with the specified name and configuration file.
|
||||
/// </summary>
|
||||
/// <param name="name">>The name of the preset.</param>
|
||||
/// <param name="name">The name of the preset.</param>
|
||||
/// <param name="plugin">The plugin associated with the preset.</param>
|
||||
/// <param name="presetConfig">>The configuration file for the preset.</param>
|
||||
/// <param name="presetConfig">The configuration file for the preset.</param>
|
||||
public OptionPreset(string name, MiraPluginInfo plugin, ConfigFile presetConfig)
|
||||
{
|
||||
Name = name;
|
||||
@@ -87,7 +87,7 @@ public class OptionPreset
|
||||
/// <summary>
|
||||
/// Gets whether the specified option is included in the preset.
|
||||
/// </summary>
|
||||
/// <returns>>The value of whether the option is in the preset.</returns>
|
||||
/// <returns>The value of whether the option is in the preset.</returns>
|
||||
public bool IsOptionInPreset(OptionBehaviour baseOption)
|
||||
{
|
||||
var selectedOpt = Plugin.InternalOptions.First(x => x.OptionBehaviour == baseOption);
|
||||
|
||||
@@ -54,7 +54,7 @@ public static class PresetManager
|
||||
/// <summary>
|
||||
/// Loads the <see cref="OptionPreset"/>s for the specified plugin by reading the <see cref="ConfigFile"/>s from the preset directory.
|
||||
/// </summary>
|
||||
/// <param name="plugin">>The plugin for which the <see cref="OptionPreset"/>s should be loaded.</param>
|
||||
/// <param name="plugin">The plugin for which the <see cref="OptionPreset"/>s should be loaded.</param>
|
||||
public static void LoadPresets(MiraPluginInfo plugin)
|
||||
{
|
||||
foreach (var btn in plugin.InternalPresets.Select(x=>x.PresetButton))
|
||||
|
||||
@@ -14,7 +14,7 @@ public static class EnumerableExtensions
|
||||
/// </summary>
|
||||
/// <param name="source">The source <see cref="IEnumerable{T}"/>.</param>
|
||||
/// <typeparam name="T">The type of the elements.</typeparam>
|
||||
/// <returns>>The shuffled <see cref="IEnumerable{T}"/>.</returns>
|
||||
/// <returns>The shuffled <see cref="IEnumerable{T}"/>.</returns>
|
||||
public static IEnumerable<T> Shuffle<T>(this IEnumerable<T> source)
|
||||
{
|
||||
return source.Shuffle(new Random());
|
||||
@@ -26,7 +26,7 @@ public static class EnumerableExtensions
|
||||
/// <param name="source">The source <see cref="IEnumerable{T}"/>.</param>
|
||||
/// <param name="rng">The <see cref="Random"/> instance to use for shuffling.</param>
|
||||
/// <typeparam name="T">The type of the elements.</typeparam>
|
||||
/// <returns>>The shuffled <see cref="IEnumerable{T}"/>.</returns>
|
||||
/// <returns>The shuffled <see cref="IEnumerable{T}"/>.</returns>
|
||||
public static IEnumerable<T> Shuffle<T>(this IEnumerable<T> source, Random rng)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(source);
|
||||
|
||||
@@ -72,7 +72,7 @@ public class StateMachineWrapper<T> where T : Il2CppObjectBase
|
||||
/// </summary>
|
||||
/// <param name="parameterName">The name of the parameter to retrieve.</param>
|
||||
/// <typeparam name="TField">The type of the parameter to retrieve.</typeparam>
|
||||
/// <returns>>The value of the specified parameter.</returns>
|
||||
/// <returns>The value of the specified parameter.</returns>
|
||||
/// <exception cref="MissingFieldException">Thrown if the specified parameter does not exist.</exception>
|
||||
public TField GetParameter<TField>(string parameterName)
|
||||
{
|
||||
|
||||
@@ -19,7 +19,7 @@ public static class VotingUtils
|
||||
/// <summary>
|
||||
/// Gets the exiled player from the list of <see cref="CustomVote"/>s. Returns <see langword="null"/> if no player is to be exiled.
|
||||
/// </summary>
|
||||
/// <param name="votes">>The list of <see cref="CustomVote"/>s to check.</param>
|
||||
/// <param name="votes">The list of <see cref="CustomVote"/>s to check.</param>
|
||||
/// <param name="isTie">Whether the vote is a tie.</param>
|
||||
/// <returns>The player to be exiled. Will be <see langword="null"/> if no player is to be exiled.</returns>
|
||||
public static NetworkedPlayerInfo? GetExiled(List<CustomVote> votes, out bool isTie)
|
||||
|
||||
Reference in new issue
Block a user