tweak comment header convention
This commit is contained in:
parent
51e65fc8a0
commit
c4a82418ac
|
@ -22,7 +22,7 @@ namespace StardewModdingApi.Installer
|
|||
internal class InteractiveInstaller
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The absolute path to the directory containing the files to copy into the game folder.</summary>
|
||||
private readonly string BundlePath;
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingApi.Installer
|
|||
internal class Program
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The absolute path of the installer folder.</summary>
|
||||
[SuppressMessage("ReSharper", "AssignNullToNotNullAttribute", Justification = "The assembly location is never null in this context.")]
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Internal.ConsoleWriting
|
|||
internal class ColorfulConsoleWriter
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The console text color for each log level.</summary>
|
||||
private readonly IDictionary<ConsoleLogLevel, ConsoleColor> Colors;
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.Internal
|
|||
internal static class EnvironmentUtility
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Get the OS name from the system uname command.</summary>
|
||||
/// <param name="buffer">The buffer to fill with the resulting string.</param>
|
||||
|
|
|
@ -11,7 +11,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
|
|||
public class NetFieldAnalyzerTests : DiagnosticVerifier
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Sample C# mod code, with a {{test-code}} placeholder for the code in the Entry method to test.</summary>
|
||||
const string SampleProgram = @"
|
||||
|
|
|
@ -11,7 +11,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
|
|||
public class ObsoleteFieldAnalyzerTests : DiagnosticVerifier
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Sample C# mod code, with a {{test-code}} placeholder for the code in the Entry method to test.</summary>
|
||||
const string SampleProgram = @"
|
||||
|
|
|
@ -14,7 +14,7 @@ namespace StardewModdingAPI.ModBuildConfig.Analyzer
|
|||
public class NetFieldAnalyzer : DiagnosticAnalyzer
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The namespace for Stardew Valley's <c>Netcode</c> types.</summary>
|
||||
private const string NetcodeNamespace = "Netcode";
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.ModBuildConfig.Analyzer
|
|||
public class ObsoleteFieldAnalyzer : DiagnosticAnalyzer
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Maps obsolete fields/properties to their non-obsolete equivalent.</summary>
|
||||
private readonly IDictionary<string, string> ReplacedFields = new Dictionary<string, string>
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.ModBuildConfig.Framework
|
|||
internal class ModFileManager
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The name of the manifest file.</summary>
|
||||
private readonly string ManifestFileName = "manifest.json";
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands
|
|||
internal class ArgumentParser : IReadOnlyList<string>
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The command name for errors.</summary>
|
||||
private readonly string CommandName;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
|
|||
internal class AddCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Provides methods for searching and constructing items.</summary>
|
||||
private readonly ItemRepository Items = new ItemRepository();
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
|
|||
internal class ListItemTypesCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Provides methods for searching and constructing items.</summary>
|
||||
private readonly ItemRepository Items = new ItemRepository();
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
|
|||
internal class ListItemsCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Provides methods for searching and constructing items.</summary>
|
||||
private readonly ItemRepository Items = new ItemRepository();
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
|
|||
internal class SetHealthCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Whether to keep the player's health at its maximum.</summary>
|
||||
private bool InfiniteHealth;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
|
|||
internal class SetMoneyCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Whether to keep the player's money at a set value.</summary>
|
||||
private bool InfiniteMoney;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
|
|||
internal class SetStaminaCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Whether to keep the player's stamina at its maximum.</summary>
|
||||
private bool InfiniteStamina;
|
||||
|
|
|
@ -13,7 +13,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.World
|
|||
internal class ClearCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The valid types that can be cleared.</summary>
|
||||
private readonly string[] ValidTypes = { "debris", "fruit-trees", "grass", "trees", "everything" };
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.World
|
|||
internal class FreezeTimeCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The time of day at which to freeze time.</summary>
|
||||
internal static int FrozenTime;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.World
|
|||
internal class SetSeasonCommand : TrainerCommand
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The valid season names.</summary>
|
||||
private readonly string[] ValidSeasons = { "winter", "spring", "summer", "fall" };
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework
|
|||
internal class ItemRepository
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The custom ID offset for items don't have a unique ID in the game.</summary>
|
||||
private readonly int CustomIDOffset = 1000;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands
|
|||
public class ModEntry : Mod
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The commands to handle.</summary>
|
||||
private ITrainerCommand[] Commands;
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.Mods.SaveBackup
|
|||
public class ModEntry : Mod
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The number of backups to keep.</summary>
|
||||
private readonly int BackupsToKeep = 10;
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
using System;
|
||||
using System;
|
||||
|
||||
namespace StardewModdingAPI.Tests
|
||||
{
|
||||
|
@ -6,14 +6,14 @@ namespace StardewModdingAPI.Tests
|
|||
internal static class Sample
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>A random number generator.</summary>
|
||||
private static readonly Random Random = new Random();
|
||||
|
||||
|
||||
/*********
|
||||
** Properties
|
||||
** Accessors
|
||||
*********/
|
||||
/// <summary>Get a sample string.</summary>
|
||||
public static string String()
|
||||
|
|
|
@ -13,7 +13,7 @@ namespace StardewModdingAPI.Tests.Utilities
|
|||
internal class SDateTests
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>All valid seasons.</summary>
|
||||
private static readonly string[] ValidSeasons = { "spring", "summer", "fall", "winter" };
|
||||
|
|
|
@ -20,7 +20,7 @@ namespace StardewModdingAPI.Web.Controllers
|
|||
internal class IndexController : Controller
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The site config settings.</summary>
|
||||
private readonly SiteConfig SiteConfig;
|
||||
|
|
|
@ -19,7 +19,7 @@ namespace StardewModdingAPI.Web.Controllers
|
|||
internal class LogParserController : Controller
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The site config settings.</summary>
|
||||
private readonly SiteConfig Config;
|
||||
|
|
|
@ -28,7 +28,7 @@ namespace StardewModdingAPI.Web.Controllers
|
|||
internal class ModsApiController : Controller
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The mod repositories which provide mod metadata.</summary>
|
||||
private readonly IDictionary<ModRepositoryKey, IModRepository> Repositories;
|
||||
|
|
|
@ -16,7 +16,7 @@ namespace StardewModdingAPI.Web.Controllers
|
|||
internal class ModsController : Controller
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The cache in which to store mod metadata.</summary>
|
||||
private readonly IMemoryCache Cache;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework
|
|||
public class AllowLargePostsAttribute : Attribute, IAuthorizationFilter, IOrderedFilter
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying form options.</summary>
|
||||
private readonly FormOptions FormOptions;
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.Web.Framework
|
|||
internal class BeanstalkEnvPropsConfigProvider : ConfigurationProvider, IConfigurationSource
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The absolute path to the container configuration file on an Amazon EC2 instance.</summary>
|
||||
private const string ContainerConfigPath = @"C:\Program Files\Amazon\ElasticBeanstalk\config\containerconfiguration";
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.Chucklefish
|
|||
internal class ChucklefishClient : IChucklefishClient
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The URL for a mod page excluding the base URL, where {0} is the mod ID.</summary>
|
||||
private readonly string ModPageUrlFormat;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.GitHub
|
|||
internal class GitHubClient : IGitHubClient
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The URL for a GitHub API query for the latest stable release, excluding the base URL, where {0} is the organisation and project name.</summary>
|
||||
private readonly string StableReleaseUrlFormat;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.ModDrop
|
|||
internal class ModDropClient : IModDropClient
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying HTTP client.</summary>
|
||||
private readonly IClient Client;
|
||||
|
|
|
@ -13,7 +13,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.Nexus
|
|||
internal class NexusWebScrapeClient : INexusClient
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The URL for a Nexus mod page for the user, excluding the base URL, where {0} is the mod ID.</summary>
|
||||
private readonly string ModUrlFormat;
|
||||
|
|
|
@ -14,7 +14,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.Pastebin
|
|||
internal class PastebinClient : IPastebinClient
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying HTTP client.</summary>
|
||||
private readonly IClient Client;
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.Web.Framework.LogParsing
|
|||
public class LogParser
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>A regex pattern matching the start of a SMAPI message.</summary>
|
||||
private readonly Regex MessageHeaderPattern = new Regex(@"^\[(?<time>\d\d:\d\d:\d\d) (?<level>[a-z]+) +(?<modName>[^\]]+)\] ", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
|
|||
internal class ChucklefishRepository : RepositoryBase
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying HTTP client.</summary>
|
||||
private readonly IChucklefishClient Client;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
|
|||
internal class GitHubRepository : RepositoryBase
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying GitHub API client.</summary>
|
||||
private readonly IGitHubClient Client;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
|
|||
internal class ModDropRepository : RepositoryBase
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying ModDrop API client.</summary>
|
||||
private readonly IModDropClient Client;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
|
|||
internal class NexusRepository : RepositoryBase
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying Nexus Mods API client.</summary>
|
||||
private readonly INexusClient Client;
|
||||
|
|
|
@ -11,7 +11,7 @@ namespace StardewModdingAPI.Web.Framework.RewriteRules
|
|||
internal class ConditionalRedirectToHttpsRule : IRule
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>A predicate which indicates when the rule should be applied.</summary>
|
||||
private readonly Func<HttpRequest, bool> ShouldRewrite;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework.RewriteRules
|
|||
internal class RedirectToUrlRule : IRule
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Get the new URL to which to redirect (or <c>null</c> to skip).</summary>
|
||||
private readonly Func<HttpRequest, string> NewUrl;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.ViewModels
|
|||
public class LogParserModel
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>A regex pattern matching characters to remove from a mod name to create the slug ID.</summary>
|
||||
private readonly Regex SlugInvalidCharPattern = new Regex("[^a-z0-9]", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
||||
|
|
|
@ -13,7 +13,7 @@ namespace StardewModdingAPI
|
|||
public static class Constants
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The directory path containing the current save's data (if a save is loaded).</summary>
|
||||
private static string RawSavePath => Context.IsSaveLoaded ? Path.Combine(Constants.SavesPath, Constants.GetSaveFolderName()) : null;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Events
|
|||
public class ButtonPressedEventArgs : EventArgs
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The game's current input state.</summary>
|
||||
private readonly SInputState InputState;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Events
|
|||
public class ButtonReleasedEventArgs : EventArgs
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The game's current input state.</summary>
|
||||
private readonly SInputState InputState;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class ContentEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -11,7 +11,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class ControlEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Events
|
|||
public class EventArgsInput : EventArgs
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The buttons to suppress.</summary>
|
||||
private readonly HashSet<SButton> SuppressButtons;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class GameEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class GraphicsEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class InputEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class LocationEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class MenuEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class MineEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Events
|
|||
public class ModMessageReceivedEventArgs : EventArgs
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying message model.</summary>
|
||||
private readonly ModMessageModel Message;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class MultiplayerEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class PlayerEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class SaveEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class SpecialisedEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
|
|||
public static class TimeEvents
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The core event manager.</summary>
|
||||
private static EventManager EventManager;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework
|
|||
internal class CommandManager
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The commands registered with SMAPI.</summary>
|
||||
private readonly IDictionary<string, Command> Commands = new Dictionary<string, Command>(StringComparer.InvariantCultureIgnoreCase);
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Content
|
|||
internal class AssetData<TValue> : AssetInfo, IAssetData<TValue>
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>A callback to invoke when the data is replaced (if any).</summary>
|
||||
private readonly Action<TValue> OnDataReplaced;
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Content
|
|||
internal class AssetDataForImage : AssetData<Texture2D>, IAssetDataForImage
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The minimum value to consider non-transparent.</summary>
|
||||
/// <remarks>On Linux/Mac, fully transparent pixels may have an alpha up to 4 for some reason.</remarks>
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Content
|
|||
internal class AssetInfo : IAssetInfo
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Normalises an asset key to match the cache key.</summary>
|
||||
protected readonly Func<string, string> GetNormalisedPath;
|
||||
|
|
|
@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.Content
|
|||
internal class ContentCache
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying asset cache.</summary>
|
||||
private readonly IDictionary<string, object> Cache;
|
||||
|
|
|
@ -19,7 +19,7 @@ namespace StardewModdingAPI.Framework
|
|||
internal class ContentCoordinator : IDisposable
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>An asset key prefix for assets from SMAPI mod folders.</summary>
|
||||
private readonly string ManagedPrefix = "SMAPI";
|
||||
|
|
|
@ -18,7 +18,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
|
|||
internal abstract class BaseContentManager : LocalizedContentManager, IContentManager
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The central coordinator which manages content managers.</summary>
|
||||
protected readonly ContentCoordinator Coordinator;
|
||||
|
|
|
@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
|
|||
internal class GameContentManager : BaseContentManager
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The assets currently being intercepted by <see cref="IAssetLoader"/> instances. This is used to prevent infinite loops when a loader loads a new asset.</summary>
|
||||
private readonly ContextHash<string> AssetsBeingLoaded = new ContextHash<string>();
|
||||
|
|
|
@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
|
|||
internal class ModContentManager : BaseContentManager
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Encapsulates SMAPI's JSON file parsing.</summary>
|
||||
private readonly JsonHelper JsonHelper;
|
||||
|
|
|
@ -12,7 +12,7 @@ namespace StardewModdingAPI.Framework
|
|||
internal class ContentPack : IContentPack
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Provides an API for loading content assets.</summary>
|
||||
private readonly IContentHelper Content;
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework
|
|||
internal class DeprecationManager
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The deprecations which have already been logged (as 'mod name::noun phrase::version').</summary>
|
||||
private readonly HashSet<string> LoggedDeprecations = new HashSet<string>(StringComparer.InvariantCultureIgnoreCase);
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Events
|
|||
internal class ManagedEvent<TEventArgs> : ManagedEventBase<EventHandler<TEventArgs>>
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying event.</summary>
|
||||
private event EventHandler<TEventArgs> Event;
|
||||
|
@ -98,7 +98,7 @@ namespace StardewModdingAPI.Framework.Events
|
|||
internal class ManagedEvent : ManagedEventBase<EventHandler>
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying event.</summary>
|
||||
private event EventHandler Event;
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Events
|
|||
internal abstract class ManagedEventBase<TEventHandler>
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>A human-readable name for the event.</summary>
|
||||
private readonly string EventName;
|
||||
|
|
|
@ -4,7 +4,7 @@ namespace StardewModdingAPI.Framework.Events
|
|||
internal abstract class ModEventsBase
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying event manager.</summary>
|
||||
protected readonly EventManager EventManager;
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Input
|
|||
internal class GamePadStateBuilder
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The current button states.</summary>
|
||||
private readonly IDictionary<SButton, ButtonState> ButtonStates;
|
||||
|
|
|
@ -6,7 +6,7 @@ namespace StardewModdingAPI.Framework.Logging
|
|||
internal class ConsoleInterceptionManager : IDisposable
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The intercepting console writer.</summary>
|
||||
private readonly InterceptingTextWriter Output;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Logging
|
|||
internal class LogFileManager : IDisposable
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying stream writer.</summary>
|
||||
private readonly StreamWriter Stream;
|
||||
|
|
|
@ -6,7 +6,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class CommandHelper : BaseHelper, ICommandHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The mod using this instance.</summary>
|
||||
private readonly IModMetadata Mod;
|
||||
|
|
|
@ -21,7 +21,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class ContentHelper : BaseHelper, IContentHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>SMAPI's core content logic.</summary>
|
||||
private readonly ContentCoordinator ContentCore;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class ContentPackHelper : BaseHelper, IContentPackHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The content packs loaded for this mod.</summary>
|
||||
private readonly Lazy<IContentPack[]> ContentPacks;
|
||||
|
|
|
@ -11,7 +11,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class DataHelper : BaseHelper, IDataHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Encapsulates SMAPI's JSON file parsing.</summary>
|
||||
private readonly JsonHelper JsonHelper;
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class ModRegistryHelper : BaseHelper, IModRegistry
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying mod registry.</summary>
|
||||
private readonly ModRegistry Registry;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class MultiplayerHelper : BaseHelper, IMultiplayerHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>SMAPI's core multiplayer utility.</summary>
|
||||
private readonly SMultiplayer Multiplayer;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class ReflectionHelper : BaseHelper, IReflectionHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The underlying reflection helper.</summary>
|
||||
private readonly Reflector Reflector;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
|
|||
internal class TranslationHelper : BaseHelper, ITranslationHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The name of the relevant mod for error messages.</summary>
|
||||
private readonly string ModName;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading
|
|||
internal class AssemblyDefinitionResolver : DefaultAssemblyResolver
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The known assemblies.</summary>
|
||||
private readonly IDictionary<string, AssemblyDefinition> Lookup = new Dictionary<string, AssemblyDefinition>();
|
||||
|
|
|
@ -15,7 +15,7 @@ namespace StardewModdingAPI.Framework.ModLoading
|
|||
internal class AssemblyLoader : IDisposable
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>Encapsulates monitoring and logging.</summary>
|
||||
private readonly IMonitor Monitor;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
|
|||
internal class EventFinder : IInstructionHandler
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The full type name for which to find references.</summary>
|
||||
private readonly string FullTypeName;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
|
|||
internal class FieldFinder : IInstructionHandler
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The full type name for which to find references.</summary>
|
||||
private readonly string FullTypeName;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
|
|||
internal class MethodFinder : IInstructionHandler
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The full type name for which to find references.</summary>
|
||||
private readonly string FullTypeName;
|
||||
|
|
|
@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
|
|||
internal class PropertyFinder : IInstructionHandler
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The full type name for which to find references.</summary>
|
||||
private readonly string FullTypeName;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
|
|||
internal class ReferenceToMemberWithUnexpectedTypeFinder : IInstructionHandler
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The assembly names to which to heuristically detect broken references.</summary>
|
||||
private readonly HashSet<string> ValidateReferencesToAssemblies;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
|
|||
internal class ReferenceToMissingMemberFinder : IInstructionHandler
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The assembly names to which to heuristically detect broken references.</summary>
|
||||
private readonly HashSet<string> ValidateReferencesToAssemblies;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading
|
|||
internal static class RewriteHelper
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The comparer which heuristically compares type definitions.</summary>
|
||||
private static readonly TypeReferenceComparer TypeDefinitionComparer = new TypeReferenceComparer();
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
|
|||
internal class FieldReplaceRewriter : FieldFinder
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The new field to reference.</summary>
|
||||
private readonly FieldInfo ToField;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
|
|||
internal class FieldToPropertyRewriter : FieldFinder
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The type whose field to which references should be rewritten.</summary>
|
||||
private readonly Type Type;
|
||||
|
|
|
@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
|
|||
internal class MethodParentRewriter : IInstructionHandler
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The type whose methods to remap.</summary>
|
||||
private readonly Type FromType;
|
||||
|
|
|
@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
|
|||
internal class StaticFieldToConstantRewriter<TValue> : FieldFinder
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The constant value to replace with.</summary>
|
||||
private readonly TValue Value;
|
||||
|
|
|
@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
|
|||
internal class TypeReferenceRewriter : TypeFinder
|
||||
{
|
||||
/*********
|
||||
** Properties
|
||||
** Fields
|
||||
*********/
|
||||
/// <summary>The full type name to which to find references.</summary>
|
||||
private readonly string FromTypeName;
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue