Add Ninja Burst consolidation features by Judduuk · Pull Request #499 · MKhayle/XIVComboExpanded

Judduuk · 2025-04-04T19:09:54Z

As per Issue: [Request] Ninja - Burst Cooldowns | #496

I have made some changes to reduce some button bloat, mainly around the busy burst window that uses a lot of buttons, and therefore gives strain, mainly to controller players.

This PR solves 2 points:

Mug / Dokumori > Ten Chi Jin > Meisui > Tenri Jindo
Kassatsu > Trick Attack / Kunai's Bane > Assassinate / Dream Within a Dream

These combos have been made and tested in-game and look to work well, but more testing is appreciated, especially as this is my first PR request.

Dokumori, Ten Chi Jin, plus the 3 step mudra combo, meisui, and tenri jindo are all now one button.
Kassatsu will only be replaced by trick attack when kassatsu is off cooldown and shadow walker is active, this is more in line with the current meta, as we ideally want to setup shadow walker before using Kassatsu. This combo also replaces with Dream within a dream when both are off CD also.

Let me know if you require more info on this PR.

Thanks!

kaedys · 2025-04-07T19:59:44Z

+                return NIN.TenChiJin;
+
+            // TCJ sequence
+            // TODO - Find a way to get the mudra steps for ten chi jin consolidated also.


I dug into the Dalamud structure on this a while back, and the job gauge object in Dalamud lacks anything related to mudra steps. So I think a change to that job gauge in Dalamud would be needed, because afaik nothing else except the internal game state would track it (no buffs or anything like that do, afaik).

The only way I could find to get some parse on the steps of TCJ was the differing actionIDs similar to Mudras. They may have changed with the new patch but these were the ones I found below that were working in 7.2:

Ten = 2259, Ninjutsu = 2260, Chi = 2261, Jin = 2263, MudraTen = 18805, MudraChi = 18806, MudraJin = 18807, TCJFumaTen = 18873, TCJFumaChi = 18874, TCJFumaJin = 18875, TCJKatonTen = 18876, TCJRaitonChi = 18877, TCJHyotonJin = 18878, TCJHutonTen = 18879, TCJDotonChi = 18880, TCJSuitonJin = 18881,

They can be used to sequence the TCJ combo like so:

if (OriginalHook(NIN.Ten) == NIN.TCJFumaTen) { return OriginalHook(NIN.Ten); } if (OriginalHook(NIN.Chi) == NIN.TCJRaitonChi) { return OriginalHook(NIN.Chi); } if (OriginalHook(NIN.Jin) == NIN.TCJSuitonJin) { return OriginalHook(NIN.Jin); }

Yep, that was the way I was suggesting in another comment. The central problem is, what Jujitsu changes into only indicate the last symbol used, afaik (except maybe in the case of TCJ, based on the above snippet). When handling standard Mudras, if Ninjitsu is showing, sat, Raiton, that means the last symbol used was Chi, but it could have been Ten Chi or Jin Chi, and afaik there's no way to differentiate that off spell ID during normal usage (outside TCJ)

Yep, TCJ is a special case for this, the previous used action falls out of the usability list, so it filters down on its own each step. A Ten cast will make the other two change their action IDs as it progresses through the possible actionIDs, and a Chi cast creates a different path through it, etc, all with their different action IDs progressing in unique chains. Still no answer on base mudras to chain them together, but TCJ gave that little work-around

Ya, makes sense, during TJC each symbol casts the actual ninjutsu rather than just applying the symbol, so they'd need different spell IDs for that.

kaedys · 2025-04-07T20:02:29Z

+internal class KassatsuTrickDream : CustomCombo
+{
+    protected internal override CustomComboPreset Preset { get; } = CustomComboPreset.NinjaDreamyTrickAttack;
+    protected override uint Invoke(uint actionID, uint lastComboActionID, float comboTime, byte level)
+    {
+        if (actionID == NIN.Kassatsu)
+        {
+            if (!IsCooldownUsable(NIN.Kassatsu) && HasEffect(NIN.Buffs.ShadowWalker))
+                return OriginalHook(NIN.TrickAttack);
+        }
+
+        if (actionID == NIN.Kassatsu && !IsCooldownUsable(NIN.Kassatsu) && !IsCooldownUsable(NIN.TrickAttack))
+            return NIN.DreamWithinADream;
+
+        return actionID;
+    }
+}


I'd strongly recommend implementing this into the existing block for Kassatsu that handles the existing Kassatsu->Trick Attack combo, and making the new 'Dreamy" combo a sub-combo rather than conflicting combo with the existing Kassatsu->Trick Attack combo. Main reason is, the logic between the two is essentially already compatible, and multiple combo blocks using the same action ID are rather bug-prone, especially as logic is rewritten or expanded in the future.

kaedys · 2025-04-07T20:07:45Z

+        if (actionID == NIN.Kassatsu)
+        {
+            if (!IsCooldownUsable(NIN.Kassatsu) && HasEffect(NIN.Buffs.ShadowWalker))
+                return OriginalHook(NIN.TrickAttack);
+        }
+
+        if (actionID == NIN.Kassatsu && !IsCooldownUsable(NIN.Kassatsu) && !IsCooldownUsable(NIN.TrickAttack))
+            return NIN.DreamWithinADream;


You're duplicating a lot of logic in these conditionals. Wouldn't this make more sense as:

Suggested change

if (actionID == NIN.Kassatsu)

{

if (!IsCooldownUsable(NIN.Kassatsu) && HasEffect(NIN.Buffs.ShadowWalker))

return OriginalHook(NIN.TrickAttack);

}

if (actionID == NIN.Kassatsu && !IsCooldownUsable(NIN.Kassatsu) && !IsCooldownUsable(NIN.TrickAttack))

return NIN.DreamWithinADream;

if (actionID == NIN.Kassatsu)

{

if (!IsCooldownUsable(NIN.Kassatsu)

{

if (HasEffect(NIN.Buffs.ShadowWalker))

return OriginalHook(NIN.TrickAttack);

if (!IsCooldownUsable(NIN.TrickAttack))

return NIN.DreamWithinADream;

}

}

Or even:

Suggested change

if (actionID == NIN.Kassatsu)

{

if (!IsCooldownUsable(NIN.Kassatsu) && HasEffect(NIN.Buffs.ShadowWalker))

return OriginalHook(NIN.TrickAttack);

}

if (actionID == NIN.Kassatsu && !IsCooldownUsable(NIN.Kassatsu) && !IsCooldownUsable(NIN.TrickAttack))

return NIN.DreamWithinADream;

if (actionID == NIN.Kassatsu && !IsCooldownUsable(NIN.Kassatsu)

{

if (HasEffect(NIN.Buffs.ShadowWalker))

return OriginalHook(NIN.TrickAttack);

if (!IsCooldownUsable(NIN.TrickAttack))

return NIN.DreamWithinADream;

}

I'd also recommend conditioning DreamWithinADream on it actually being off cooldown, though. As written, you won't ever be able to see the remaining cooldown on Kassatsu unless Trick Attack is available but you lack Shadow Walker. If you do the sequence as planned, it will show the remaining CD on Dream Within a Dream instead until Kassatsu actually comes off cooldown.

kaedys · 2025-04-07T20:16:12Z

+
+            // TCJ sequence
+            // TODO - Find a way to get the mudra steps for ten chi jin consolidated also.
+            if (level >= NIN.Levels.TenChiJin && !IsCooldownUsable(NIN.TenChiJin) && HasEffect(NIN.Buffs.TenChiJin))


Rather than duplicating the first two clauses of this conditional, why not merge this and the conditional above it, with the effect check then being an if/else inside it?

if (level >= NIN.Levels.TenChiJin && !IsCooldownUsable(NIN.TenChiJin) { if (HasEffect(NIN.Buffs.TenChiJin)) { float tcj = FindEffect(NIN.Buffs.TenChiJin).RemainingTime; if (tcj > 5) return OriginalHook(NIN.Ten); if (tcj > 4) return OriginalHook(NIN.Chi); if (tcj > 3) return OriginalHook(NIN.Jin); } else return NIN.TenChiJin; }

Also, using remaining time on TenChiJin is going to be EXTREMELY brittle. Instead, I would recommend checking the OriginalHook() value for one of the Mudras. It will always be Shuriken for the first mudra, and then the 2nd and 3rd will be defined by whichever mudra you're looking at. Best bet, given the sequence desired, would be to look at Jin. So if OriginalHook() of Jin is Shuriken, no mudras have been cast, so return Ten. If Jin's OriginalHook is Hyoton, then one mudra has been cast, so return Chi (ie. Raiton). And then if Jin is showing Suiton, then return Jin as is. That ensures that a small delay doesn't completely screw over the combo and result in something like a Chi Jin Jin Bunny.

kaedys · 2025-04-07T20:18:04Z

+            }
+            else {
+                // Tenri Jindo
+                return OriginalHook(NIN.TenChiJin);


This should be conditioned on having the Tenri Jindo Ready buff, not simply lacking Shadowalker or Meisui being on cooldown.

kaedys · 2025-04-07T20:19:54Z

+    [IconsCombo([NIN.Kassatsu, UTL.ArrowLeft, NIN.TrickAttack, UTL.ArrowLeft,  NIN.DreamWithinADream])]
+    [SectionCombo("Ninjutsu features")]
+    [ConflictingCombos(NinjaKassatsuTrickFeature)]
+    [SecretCustomCombo]
+    [CustomComboInfo("Optimised Kassatsu Trick", "Replace Kassatsu With Trick only while Suiton is up and Kassatsu Is off cooldown. Also replaces with Dream within a dream if both on cooldown.", NIN.JobID)]
+    NinjaDreamyTrickAttack = 3093,


Suggested change

[IconsCombo([NIN.Kassatsu, UTL.ArrowLeft, NIN.TrickAttack, UTL.ArrowLeft, NIN.DreamWithinADream])]

[SectionCombo("Ninjutsu features")]

[ConflictingCombos(NinjaKassatsuTrickFeature)]

[SecretCustomCombo]

[CustomComboInfo("Optimised Kassatsu Trick", "Replace Kassatsu With Trick only while Suiton is up and Kassatsu Is off cooldown. Also replaces with Dream within a dream if both on cooldown.", NIN.JobID)]

NinjaDreamyTrickAttack = 3093,

[IconsCombo([NIN.Kassatsu, UTL.ArrowLeft, NIN.TrickAttack, UTL.ArrowLeft, NIN.DreamWithinADream])]

[SectionCombo("Ninjutsu features")]

[ParentCombo(NinjaKassatsuTrickFeature)]

[SecretCustomCombo]

[CustomComboInfo("Optimised Kassatsu Trick", "Replace Kassatsu with Trick only while Shadow Walker is up and Kassatsu is on cooldown. Also replaces Kassatsu with Dream Within a Dream if both it and Trick Attack are on cooldown.", NIN.JobID)]

NinjaDreamyTrickAttack = 3093,

Recommended rewording. Also, shifting to parented on the existing Kassatsu/Trick Attack combo, rather than conflicting, as I recommended in a prior comment.

kaedys · 2025-04-07T20:27:29Z

+    [IconsCombo([NIN.Dokumori, UTL.ArrowLeft, NIN.TenChiJin, UTL.ArrowLeft, NIN.Ten, UTL.ArrowLeft, NIN.Chi, UTL.ArrowLeft, NIN.Jin, UTL.ArrowLeft, NIN.Meisui])]
+    [SectionCombo("Ninjutsu features")]
+    [ExpandedCustomCombo]
+    [ConflictingCombos(NinjaTCJMeisuiFeature)]
+    [CustomComboInfo("2 Minute Cooldowns Consolidation", "Consolidate Dokumori, TenChiJin (The Move), its combo steps, and Meisui with eachother.", NIN.JobID)]
+    NinjaDokumoriConsolidationCombo = 3025,


Similarly, I think this could be a sub-combo of the existing NinjaTCJMeisuiFeature combo, since it also includes Meisui. However, it should also definitely be an Accessibility rather than Expanded type combo, given how much it is consolidating. I also recommended some rewording below:

Suggested change

[IconsCombo([NIN.Dokumori, UTL.ArrowLeft, NIN.TenChiJin, UTL.ArrowLeft, NIN.Ten, UTL.ArrowLeft, NIN.Chi, UTL.ArrowLeft, NIN.Jin, UTL.ArrowLeft, NIN.Meisui])]

[SectionCombo("Ninjutsu features")]

[ExpandedCustomCombo]

[ConflictingCombos(NinjaTCJMeisuiFeature)]

[CustomComboInfo("2 Minute Cooldowns Consolidation", "Consolidate Dokumori, TenChiJin (The Move), its combo steps, and Meisui with eachother.", NIN.JobID)]

NinjaDokumoriConsolidationCombo = 3025,

[IconsCombo([NIN.Dokumori, UTL.ArrowLeft, NIN.TenChiJin, UTL.ArrowLeft, NIN.Ten, UTL.ArrowLeft, NIN.Chi, UTL.ArrowLeft, NIN.Jin, UTL.ArrowLeft, NIN.Meisui])]

[SectionCombo("Ninjutsu features")]

[AccessibilityCustomCombo]

[ParentCombo(NinjaTCJMeisuiFeature)]

[CustomComboInfo("2 Minute Cooldowns Consolidation", "After Dokumori is used, replace it with Ten Chi Jin (the action), its mudra steps, Meisui, and Tenri Jindo in sequence.", NIN.JobID)]

NinjaDokumoriConsolidationCombo = 3025,

kaedys · 2025-04-07T20:28:02Z

        TenMudra = 18805, // No-cooldown version that only appears during a Mudra cast, after the first symbol
        ChiMudra = 18806,
        JinMudra = 18807;
-


o.O Why was this line removed?

Judduuk · 2025-04-07T21:04:07Z

Thanks for the feedback @kaedys I’ll try get onto this when I get the chance! C sharp and these plugins are new to me but it’s getting there!

MKhayle · 2025-04-10T23:21:19Z

Hello! I'll check this out once I'll have time to test it ingame. I'm currently bedridden and tired, sorry for the delay.

juddulat-cloud added 4 commits April 4, 2025 11:15

Initial commit

ad7e702

Add Ninja Burst Options

e4ddb07

Tidy

d17abc1

Add Tenri Jindo

34fc320

kaedys reviewed Apr 7, 2025

View reviewed changes

Uh oh!

Conversation

Judduuk commented Apr 4, 2025

As per Issue: [Request] Ninja - Burst Cooldowns | #496

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitharr137 Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitharr137 Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaedys Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Judduuk commented Apr 7, 2025

Uh oh!

MKhayle commented Apr 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vitharr137 Aug 9, 2025 •

edited

Loading

vitharr137 Aug 9, 2025 •

edited

Loading

kaedys Apr 7, 2025 •

edited

Loading