PLK_UpPoint

* Terms of Use * No duplication or distribution is permitted. Can be used in commercial games I ask you to specify "Palatkorn" in your game credits only

1) General Workflow

1. Class-Specific Base Stats
   • In the classUpgrades parameter, you can assign base stats for HP, MP, ATK, DEF, MAT, MDF, AGI, and LUK for each class. This ensures that when a character starts or changes classes, it uses those base values in stat calculations.
   • If a class is not explicitly defined in classUpgrades, the plugin falls back on the parameters baseHP, baseMP, etc.
2. Gaining Points on Level Up
   • Each class can specify how many points the actor earns upon leveling up (statusIncreaseAmount) in classUpgrades.
   • If not defined for a specific class, the plugin will fall back on the global statusIncreaseAmount (or the variable defaultIncreaseAmount).
3. Gaining Skill Points via Items
   • If the classUpgrades parameter includes itemSkillPoints for a given class (indicating which item IDs grant points and how many), then when an actor of that class uses one of those items, they gain that specified amount of points.
   • If a class doesn’t have custom values for certain items, or no entry at all, the plugin uses the global defaultItemSkillPoints.
4. Stat Upgrades in a Custom Menu
   • The plugin adds a menu command (e.g. “Upgrade status”) or can be invoked with the Plugin Command openUpPoint.
   • Once the player chooses this command, they enter Scene_PLK_SelectActor_UpPoint, where they select an actor and then transition to Scene_PLK_StatusUpgrade. There, the player can spend 1 point at a time to increase HP, MP, ATK, DEF, etc. Each upgrade reduces the actor’s points by one and increases _paramPlus[...] accordingly.
5. Resetting Upgraded Stats
   • The plugin includes a resetStats function and a commandResetStats to handle returning all upgraded stats to their base values (and restoring or recalculating points).
   • resetItems is a parameter containing JSON that tells the plugin which items (and how many) are required to perform a reset. If the player doesn’t have those items, the reset can’t happen.
6. Window_LevelUpActors
   • The code features a Window_LevelUpActors that shows any actors who still have leftover points (e.g. _points > 0) using an SV battler sprite in a “victory” pose. This serves as a reminder that those actors can still spend their points.

2) Key Plugin Parameters

• UpPointListWindowSkin The name of the window skin file (img/system/) used for some of the relevant windows (e.g., Actor List, Class List).
• PointUpgradeBackground The background image (without “.png”) for the Status Upgrade scene (Scene_PLK_StatusUpgrade).
• PointClassSelectBackground The background image (without “.png”) for the class-selection scene (Scene_PLK_SelectActor_UpPoint).
• classCompletionIcons A struct that maps certain class IDs to an “icon index” if the actor has finished certain conditions. (In the provided code, it doesn’t seem heavily used, but could be used to mark classes as complete.)
• statusIncreaseAmount A fallback value that determines how many points an actor gains when leveling up (if not otherwise specified under a particular class).
• resetItems A JSON array containing itemId and quantity indicating which items and how many are needed to reset stats.
• defaultItemSkillPoints The default number of skill points an actor receives when using an item, if the class doesn’t define its own item-specific point values.
• classUpgrades Defines each class’s base stats (baseHP, baseMP, etc.), how much is gained when pressing “stat upgrade” commands (mhp, mmp, atk, etc.), how many points are gained at level-up (statusIncreaseAmount), and which items grant skill points (itemSkillPoints).
• baseHP, baseMP, baseATK, etc. Fallback base stat values for classes that aren’t otherwise customized.
• Plugin Commands:
  1. setResetItems – Reconfigures which items are used for resetting stats (updates resetItems).
  2. openUpPoint – Jumps directly to the plugin’s status upgrade scene.

3) Summary of How to Use

1. Install the Plugin
   • Place the .js file in js/plugins and enable it in Plugin Manager.
   • Set up the parameters in Plugin Manager as desired.
2. Configure classUpgrades
   • For each class, specify classId.
   • Add base values (like baseHP, baseMP) if you want that class to have unique stats.
   • Add a statusIncreaseAmount to define how many points they get on level up.
   • Optionally include itemSkillPoints for any items that should grant special amounts of points to this class.
3. Leveling Up
   • The plugin automatically checks statusIncreaseAmount (either from the class or a fallback) and adds that many points to the actor upon leveling up.
4. Upgrading Stats
   • Players can access “Upgrade status” in the main menu or use the Plugin Command openUpPoint.
   • This leads to Scene_PLK_SelectActor_UpPoint, then, after selecting a character, to Scene_PLK_StatusUpgrade.
   • The player chooses which stat to upgrade, costing 1 point each time.
5. Resetting Stats
   • If the player chooses “Reset status,” the plugin checks whether the player has enough of the items defined in resetItems.
   • If so, it removes the items, sets _paramPlus back to zero, and recalculates points (usually level * statusIncreaseAmount).

4) Benefits and Considerations

• Class-Based Stat Splits The plugin organizes your paramBase calculations by class, so it’s cleaner than writing complex custom logic each time.
• Easy Customization You can decide how many points each class gets per level and how many are needed to boost various stats.
• Automated Reminders Window_LevelUpActors displays any characters still holding extra points (i.e., _points > 0) so players won’t forget to assign them.
• One-Click Reset The player can easily wipe out all assigned stat upgrades using special items, giving them the freedom to reallocate points as they see fit.