Battle Actor Exclusions MV + MZ
A downloadable RPG Maker plugin
Before deploying for Linux on Windows, you must update MV's NW.js runtime.
This plugin allows you to reliably exclude certain actors from battles, also dynamically by making certain states have this effect, without affecting anything outside of battles. (I.e. they will still appear as followers and will not be darkened in the party screen.)
Excluded actors do not take up actor slots in battle, so it's not necessary to order them after other party members in the formation menu.
Additionally, you can always-include all party members in what's considered for "In the Party" conditions in the Conditional Branch command, using a simple plugin parameter toggle. (By default, only non-hidden actors participating in the battle are considered here during battle.)
Additionally, there is a small fix for an edge case where battle processing could stall indefinitely if an actor disappeared while moving. That's likely difficult to trigger otherwise, though.
Load Order
This plugin likely works best if loaded relatively late.
It should be loaded AFTER most other battle plugins.
Plugin Parameters
- Actors
Actors to always exclude from battles. - Actor Note Tag
Actors with this note tag are always exclude from battles. - States
Actors with any of these states are excluded from battles. - Enable engine tweaks?
Installs additional hooks to potentially change engine behaviour.- All in Conditional Branch?
Allows the Conditional Branch command to see all "Actor"s "In the Party" even while in battle.
- All in Conditional Branch?
Plugin Commands
This plugin does not expose any plugin commands.
JavaScript API
This plugin unconditionally sets the global variable `TS_Battle_Actor_Exclusions` when first loaded.
There, the following properties are available:
- actors: number[]
The IDs of the actors to exclude from battle. - noteTag: string
Actors whose note contains this text are excluded from battles.
Inactive if empty after trimming whitespace. - states: number[]
Actors who have any of these states (by ID) are excluded from battles. - considerAllInConditionalBranch: boolean
Controls whether to let the Conditional Branch command consider all party members even in battle.
Requires the "Enable engine tweaks?" plugin parameter to be enabled to be effective. - testAllowActorInBattle(actor: Game_Actor | number): boolean
Returns whether a specific Game_Actor (possibly specified by their ID) would currently be allowed to participate in battle by this plugin.
Compatibility Notes
This plugin was tested on RPG Maker MV 1.6.2 and RPG Maker MZ 1.5.1, uses only the public RPG Maker API, and does not use any platform-specific APIs.
This plugin should be compatible with any deployment target available for RPG Maker MV and MZ, including web and most custom ones.
This plugin is compatible with YEP_BattleEngineCore (v1.51), as long as it is loaded after that battle engine.
Compatibility with VisuMZ_1_BattleCore (Version 1.73) is *likely*, but hard to judge conclusively due to its obfuscated source code. (Not great.)
If you notice issues or glitches in combination with other plugins, please tell me about them, and I'll check if a compatibility tweak is feasible.
Purchase
In order to download this RPG Maker plugin you must purchase it at or above the minimum price of $2.50 USD. You will get access to the following files:
Development log
- Version 1.1.1Mar 25, 2023
Leave a comment
Log in with itch.io to leave a comment.