Activate Equipment

ATT_Turan · 2023-04-15T10:35:57+0900

Activate Equipment 1.2 ATT_Turan Introduction This plugin was a request I received to be able to use equipment for effects in battle. Apparently the request was motivated by Dragon Quest, but it reminded me of the Shining Force and Phantasy Star games. I have tested the basic functionality, please let me know if you encounter any errors. I will consider making compatibility patches if the other plugin is free to use (or one I own, such as a Yanfly product) and unobfuscated. Otherwise, other authors are free to modify this code to make it compatible with theirs so long as I am still credited. Spoiler: Features Using this plugin, you can assign weapons and armor to have the function of consumable items or skills in your database. You will then be able to go into the Items menu in battle, and any equipment with that assignation the current actor has equipped will show up to be used. There are a number of options that can be configured. The default functionality lets the player freely activate equipped items as their turn in battle. You can instead impose a limit so each actor may only activate each item once per battle. If using Yanfly's Item Core, you can also set a specific number of charges per item, and whether or not they recharge automatically. Finally, you can specify a chance that an item will "crack" when activated. This does not impair its basic weapon/armor functionality, but prevents it from being activated again until the item is repaired. This option requires the use of Yanfly's Item Core with the parameters set to make weapons and armor independent items. You can also set a second chance that when an item cracks it will break, destroying and immediately removing the item. Spoiler: Screenshots Spoiler: How to Use Use the following notetag in the notebox of your Weapons or Armor: Example: The word specifies whether the equipment is referencing a skill or item in your database. The ID determines which skill or item. Note that any costs associated with a skill are ignored when activating it from equipment. This notetag limits the equipment to being activated once per actor per battle. Example: would give the equipment a 40% chance to crack This does not change how frequently the equipment can be activated, but gives each activation the specified percent chance to crack. A cracked item still has all of its parameters and functions normally as equipment, but is not available to be activated again in battle. Once it's repaired, it can be activated again normally. This notetag will not function unless your project also has Yanfly's Item Core and weapons and armor are set to be independent items. Example: would give the equipment a 40% chance to break when it cracks This gives the equipment a chance to break and be permanently destroyed each time it cracks. This will have no effect unless the notetag is on the item. Example: This will allow you to create a custom message to display when a piece of equipment breaks. If specified, it will display after the crack message. Example: This will give the equipment a certain number of charges. Activating the equipment in battle spends one charge and equipment cannot be activated when it has no charges left. Charges will replenish at the start of each battle unless otherwise specified. This notetag causes charges to persist between battles instead of refilling automatically. Spoiler: Plugin Commands / Script Calls RepairEquipment This plugin command will repair all cracked equipment owned by the party. RechargeEquipment This plugin command will reset all equipment owned by the party to their maximum charges. CrackRepair(item) This function can be used to repair an individual cracked equipment. This may be useful if you want to have vendors that charge for each repair, or if you want an actor to be able to repair their own items during battle. IsCracked(item) This will return whether a specified weapon/armor is cracked. RechargeItem(item) This function can be used to reset an individual piece of equipment back to its maximum charges. item.charges This variable tracks an item's current number of charges. actor.activating If an actor is activating a piece of equipment, a copy of it will be stored in this variable for the duration of that action. Terms and Credits Free for non-commercial and commercial use. Credit ATT_Turan. Attachments TUR_ActivateEquipment.js 14.3 KB · Views: 52

● ARCHIVED · READ-ONLY

Started by ATT_Turan Apr 15, 2023, 01:35 AM 34 posts Page 2 of 2 View original ↗

ATT_Turan

#21 Apr 17, 2023, 04:39 PM Source

Maliki79 said:
Good point on the charges, but if the dev isn't using independent items, it'll be challenging to do. How do you handle the once per battle use?
I push the item to an array stored on the actor for the duration of the battle. So for the default engine this works perfectly, unless one dual wields the same weapon, in which case activating a weapon counts for both.

I suppose I could track it on the actor by equipment slot, which would help with the dual wielding scenario (and now that I say that I think I should do it :stickytongue:). But it really wouldn't help in terms of multiple charges tracked between battles because there's no way to keep track of an item once it's unequipped.

I welcome any suggestions you have for a different way to implement it. But I'm also okay with just saying "These features are dependent on independent items."
Maliki79

#22 Apr 17, 2023, 05:02 PM Source

I'll give it some thought and see what I can contribute once I get in front of my PC.
Puppet Knight

#23 Apr 17, 2023, 06:54 PM Source

ATT_Turan said:
I suppose I could track it on the actor by equipment slot, which would help with the dual wielding scenario (and now that I say that I think I should do it :stickytongue:). But it really wouldn't help in terms of multiple charges tracked between battles because there's no way to keep track of an item once it's unequipped.
There may be something in how Formar handles the AP tracking of equipment by Actor that could help?:

Fomars Learn Skill From Equipment
ATT_Turan

#24 Apr 17, 2023, 08:17 PM Source

Puppet Knight said:
There may be something in how Formar handles the AP tracking of equipment by Actor that could help?:
In that case, there's no data that's specific to a particular item. If a Short Sword teaches you Slash, then you'll gain AP towards Slash while you're wielding any Short Sword. That's easily stored on the actor.

And if you got some AP toward Slash, unequipped your Short Sword, put it on another Actor, bought another Short Sword (to make sure it's not the same one) and equipped it, you'll still be at the same number of AP already earned. It's not specific to the item.

Similarly, if you wanted to have one Short Sword that gave you 2 AP toward Slash every turn and another Short Sword that gave you 3, it couldn't do that with the default item system. And you can see that in Formar's learnrate parameter - it will apply to all instances of that item.
Maliki79

#25 Apr 17, 2023, 09:27 PM Source

It seems all these additions would require Independent Items.
So I'd say either decide whether you will do your plugin with Ind Items as a dependency, leave it as-is, or consider a extension plugin that can give functionality the regular plugin doesn't provide so devs can choose.

Making it so item charges carry over between battles is not possible without Ind Items. And linking charges to the character can work IF there's no way to switch equips mid-battle AND the charges refresh after battle.

Ultimately up to you, of course.
Robro33

#26 Apr 17, 2023, 10:43 PM Source
Might I suggest making a state notetag that allows you to disable being able to make use of activate equipment? maybe even on a per-slot or per-id basis? Also seconded on the user.activating being useful (didnt know that was a thing but ill have to look into that later).
I was thinking that with those features, a dev could make it so that using the skill through their equipment adds a hidden state (infinite duration, bypasses death removal, removed at battle's end) to the user that increments a counter on the actor on use. then when that counter hits whatever limit is its max, reset the counter and add a state to prevent using the activate equip skill of that weapon slot/id for the rest of the fight alongside a victory effect to clear the counter. something like:

SKILL - Fire
JavaScript:
<After Eval> if (user.activating) // i have no idea how its used user.addState(X); </After Eval>
STATE X - tracks usage count
JavaScript:
<Category: Bypass Death Removal> <Custom Apply Effect> user._fireUsage = user._fireUsage + 1 || 1; if(user._fireUsage >= [max]) user._fireUsage = undefined; user.addState(Y); </Custom Apply Effect> <Custom Victory Effect> user._fireUsage = undefined; </Custom Victory Effect>
STATE Y - seals activate equipment use
JavaScript:
<activateEquipSeal: [weapon/armor] ID>
this is feasable, right?
Sword_of_Dusk

#27 Apr 17, 2023, 11:05 PM Source

@ATT_Turan I know I said this already, but I really didn't expect my query to lead to you creating a plugin just like that. That's some awesome work.

I do have a minor request though. The crack function is neat, but would there be a way to have a version that completely destroys an item? I'd love to be able to properly set up Prayer Rings from DQ, which have a 33.3% chance of breaking after use. No repairs possible.
Maliki79

#28 Apr 18, 2023, 12:16 AM Source

Sword_of_Dusk said:
@ATT_Turan I know I said this already, but I really didn't expect my query to lead to you creating a plugin just like that. That's some awesome work.

I do have a minor request though. The crack function is neat, but would there be a way to have a version that completely destroys an item? I'd love to be able to properly set up Prayer Rings from DQ, which have a 33.3% chance of breaking after use. No repairs possible.
This was exactly why I wanted to integrate the durability plugin. Doable with a little tweaking.
ATT_Turan

#29 Apr 18, 2023, 12:22 AM Source

@Robro33 Can you clarify the intent/point of that? The way you describe your intended usage, it seems like a hack to make limited charges on an item...but if you're going to be using a Yanfly plugin to be stacking the state counters and applying the state category, you might as well just have the Item Core. I'm not sure I see the point.

@Sword_of_Dusk Yes, that shouldn't be hard to add.
Robro33

#30 Apr 18, 2023, 12:38 AM Source

ATT_Turan said:
Can you clarify the intent/point of that?
Ah, my bad. I should have been clearer. I was asking if it were possible to add a note tag to disable being able to activate equipment skills. I had used the limited skills thing as a somewhat relevant and possible use case of it since its not yet in implemented feature that it could be used for, but then just forgot to explain it.
Essentially, just asking if additional ways to limit being able to use activated equipment skills other than "you used x item and it cracked" was feasable. With a state you could add effects that enemies could use to be able to suppress their usage, or make a requirement for the gear to be used being that you need to *not* have a certain state active as some additional examples.
Activated equipment skills' only requirement is to have the gear equipped and I cant immediately think of a way to add mechanics to silence these skills without disabling the ability to use items as a whole, or removing the gear from the slot mid fight (which sounds like a disaster waiting to happen).
zelanius

#31 Apr 18, 2023, 12:39 AM Source

@ATT_Turan , it works beautifully now! I just have to place it after Galv_ActorEquipItems to work.

There is a small issue, where the default text for an empty slot is replaced with a blank text (basically, I have "------" for empty slots in Galv's plugin, but this overrides it with " "). It's a small issue though, with no effect on gameplay anyway, so I doubt a fix here is needed.
ATT_Turan

#32 Apr 18, 2023, 02:56 AM Source

@Robro33 I understand what you're saying. I'll keep it in mind.

@zelanius I actually noticed that during my testing, but I wasn't super sure why it was happening. Making the listing of items compatible with Galv's plugin makes the drawing of the text bounce between two or three functions, so one of them isn't ending up where we expect it to. As you say, it doesn't affect the gameplay, but I have it in my head to see if I can sort it better at some point.

@Sword_of_Dusk Breaking has been added. You can set it at a percent chance and you can give items a custom message to display when they break.

@Maliki79 @Puppet Knight Charges have been added. You can use a notetag to specify whether items recharge between battles. Plugin commands and script calls are provided to recharge items. Yanfly's Item Core with independent items is required for this functionality.
Sword_of_Dusk

#33 Apr 18, 2023, 04:14 AM Source

@ATT_Turan You are da man!
Puppet Knight

#34 Apr 18, 2023, 12:40 PM Source

Will do some MZ compatibility testing for this bad boy today.

Something to note for folks using Battle Core VS that I noticed:

YEP Item Core should be placed above Battle Core VS, to avoid a crash when entering the item menu for an actor that doesnt have a note tagged weapon/armor equipped.

So far so good though. Haven't run into any problems with the base functionality. Testing the new charges function in a few specific cases to make sure it doesn't break in MZ.

A quick question regarding the `RechargeItem(item)` plugin command:

How do we specify the ID of equipment exactly it is if we the functionality is grounded in Independent Items, which creates new IDs for the newly acquired equipment?