mirror of
https://github.com/kwsch/PKHeX
synced 2024-11-15 16:48:01 +00:00
a608e0b252
Remove some unnecessary properties from SaveFile Enumerate checksum flag results for GC memcard checking Remove unnecessary checks on savefile type Add some documentation Decapitalize some method parameters
41 lines
1.3 KiB
C#
41 lines
1.3 KiB
C#
namespace PKHeX.Core
|
|
{
|
|
/// <summary>
|
|
/// Plugin interface used by an editor to notify third-party code providers.
|
|
/// </summary>
|
|
public interface IPlugin
|
|
{
|
|
/// <summary>
|
|
/// Plugin Name.
|
|
/// </summary>
|
|
string Name { get; }
|
|
|
|
/// <summary>
|
|
/// Plugin Loading Priority (lowest is initialized first).
|
|
/// </summary>
|
|
int Priority { get; }
|
|
|
|
/// <summary>
|
|
/// Entrypoint for the parent to initialize the plugin with provided arguments.
|
|
/// </summary>
|
|
/// <param name="args">Arguments containing objects useful for initializing the plugin.</param>
|
|
void Initialize(params object[] args);
|
|
|
|
/// <summary>
|
|
/// Notifies the plugin that a save file was just loaded.
|
|
/// </summary>
|
|
void NotifySaveLoaded();
|
|
|
|
/// <summary>
|
|
/// Attempts to load a file using the plugin.
|
|
/// </summary>
|
|
/// <param name="filePath">Path to file to be loaded.</param>
|
|
/// <returns></returns>
|
|
bool TryLoadFile(string filePath);
|
|
|
|
/// <summary>
|
|
/// Retrieves the <see cref="ISaveFileProvider"/> object which can provide a <see cref="SaveFile"/>.
|
|
/// </summary>
|
|
ISaveFileProvider SaveFileEditor { get; }
|
|
}
|
|
}
|