Mirrors/PKHeX
2
0
Fork 0
mirror of https://github.com/kwsch/PKHeX synced 2024-11-23 20:43:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
PKHeX/PKHeX.Core/Editing/Saves/BoxManipulator.cs

71 lines
3.4 KiB
C#
Raw Normal View History

Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
namespace PKHeX.Core
{
public abstract class BoxManipulator
{
protected abstract SaveFile SAV { get; }
Misc updates extract final pkm manipulation logic from pkm editor add xmldoc to boxmanipulator, add utility class for enum->manip fetching fix xmldoc referencing removed enum member relocate boxmanip overview logic to utility class move SAVPaths file pointer to Main for reuse #2109 , will add to autodetect in a later commit open/save dialog with extra extensions: ignore ones already present
2018-09-03 17:30:35 +00:00
/// <summary>
/// Executes the provided <see cref="manip"/> with the provided parameters.
/// </summary>
/// <param name="manip">Manipulation to perform on the <see cref="SAV"/> box data.</param>
/// <param name="box">Single box to modify; if <see cref="allBoxes"/> is set, this param is ignored.</param>
/// <param name="allBoxes">Indicates if all boxes are to be manipulated, or just one box.</param>
/// <param name="reverse">Manipulation action should be inverted (criteria) or reversed (sort).</param>
/// <returns>True if operation succeeded, false if no changes made.</returns>
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
public bool Execute(IBoxManip manip, int box, bool allBoxes, bool reverse = false)
{
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
bool usable = manip.Usable.Invoke(SAV);
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
if (!usable)
return false;
More readonly struct tweaks help dat compiler minor clean elsewhere
2019-10-27 06:18:25 +00:00
var start = allBoxes ? 0 : box;
var stop = allBoxes ? SAV.BoxCount - 1 : box;
var param = new BoxManipParam(start, stop, reverse);
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
var prompt = manip.GetPrompt(allBoxes);
var fail = manip.GetFail(allBoxes);
Misc updates extract final pkm manipulation logic from pkm editor add xmldoc to boxmanipulator, add utility class for enum->manip fetching fix xmldoc referencing removed enum member relocate boxmanip overview logic to utility class move SAVPaths file pointer to Main for reuse #2109 , will add to autodetect in a later commit open/save dialog with extra extensions: ignore ones already present
2018-09-03 17:30:35 +00:00
if (!CanManipulateRegion(param.Start, param.Stop, prompt, fail))
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
return false;
var result = manip.Execute(SAV, param);
Track slot modified count on sort/delete/mod Sorting will always show multiples of boxcount since it repositions empty slots
2019-02-21 01:59:54 +00:00
if (result <= 0)
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
return false;
var success = manip.GetSuccess(allBoxes);
Track slot modified count on sort/delete/mod Sorting will always show multiples of boxcount since it repositions empty slots
2019-02-21 01:59:54 +00:00
FinishBoxManipulation(success, allBoxes, result);
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
return true;
}
Prevent sort/clear reverse on shortcut use Closes #2111 by preventing the user error
2018-09-04 22:01:14 +00:00
/// <summary>
/// Executes the provided <see cref="type"/> with the provided parameters.
/// </summary>
/// <param name="type">Manipulation to perform on the <see cref="SAV"/> box data.</param>
/// <param name="box">Single box to modify; if <see cref="allBoxes"/> is set, this param is ignored.</param>
/// <param name="allBoxes">Indicates if all boxes are to be manipulated, or just one box.</param>
/// <param name="reverse">Manipulation action should be inverted (criteria) or reversed (sort).</param>
/// <returns>True if operation succeeded, false if no changes made.</returns>
public bool Execute(BoxManipType type, int box, bool allBoxes, bool reverse = false)
{
var manip = type.GetManip();
return Execute(manip, box, allBoxes, reverse);
}
Misc updates extract final pkm manipulation logic from pkm editor add xmldoc to boxmanipulator, add utility class for enum->manip fetching fix xmldoc referencing removed enum member relocate boxmanip overview logic to utility class move SAVPaths file pointer to Main for reuse #2109 , will add to autodetect in a later commit open/save dialog with extra extensions: ignore ones already present
2018-09-03 17:30:35 +00:00
/// <summary>
/// Sanity check for modifying the box data.
/// </summary>
/// <param name="start">Start box</param>
/// <param name="end">End box</param>
/// <param name="prompt">Message asking about the operation.</param>
/// <param name="fail">Message indicating the operation cannot be performed.</param>
/// <returns></returns>
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
protected virtual bool CanManipulateRegion(int start, int end, string prompt, string fail) => !SAV.IsAnySlotLockedInBox(start, end);
Misc updates extract final pkm manipulation logic from pkm editor add xmldoc to boxmanipulator, add utility class for enum->manip fetching fix xmldoc referencing removed enum member relocate boxmanip overview logic to utility class move SAVPaths file pointer to Main for reuse #2109 , will add to autodetect in a later commit open/save dialog with extra extensions: ignore ones already present
2018-09-03 17:30:35 +00:00
/// <summary>
/// Called if the <see cref="IBoxManip"/> operation modified any data.
/// </summary>
/// <param name="message">Optional message to show if applicable.</param>
/// <param name="all">Indicates if all boxes were manipulated, or just one box.</param>
Misc updates extract some enums to core, use Enum.GetNames to do string fetch make stamp listbox taller clean up Display*ID setters
2019-02-22 05:54:41 +00:00
/// <param name="count">Count of manipulated slots</param>
Track slot modified count on sort/delete/mod Sorting will always show multiples of boxcount since it repositions empty slots
2019-02-21 01:59:54 +00:00
protected abstract void FinishBoxManipulation(string message, bool all, int count);
Separate box manipulator to ui-less class clear separation of functionality
2018-09-02 18:31:34 +00:00
}
}
Reference in a new issue Copy permalink