Paladin: Refactor stopattack UI options + add manually triggered attacks as an experimental feature for prot

proto/paladin.proto

@@ -131,12 +131,14 @@ enum PaladinSeal {
 message PaladinOptions {
 	PaladinSeal primarySeal = 1;
 	PaladinAura aura = 2;
+	bool IsManuallyTriggeringAutoAttacks = 3;
 	bool IsUsingDivineStormStopAttack = 4;
 	bool IsUsingJudgementStopAttack = 5;
 	bool IsUsingCrusaderStrikeStopAttack = 6;
-
-    bool righteousFury = 8;
-    Blessings personalBlessing = 9;
+	bool IsUsingHammerOfTheRighteousStopAttack = 7;
+	bool IsUsingShieldOfRighteousnessStopAttack = 8;
+    bool righteousFury = 9;
+    Blessings personalBlessing = 10;
 }
 
 message RetributionPaladin {

sim/paladin/crusader_strike.go

@@ -20,6 +20,7 @@ func (paladin *Paladin) registerCrusaderStrike() {
 
 	crusaderStrikeSpell := paladin.RegisterSpell(core.SpellConfig{
 		ActionID:    manaMetrics.ActionID,
+		SpellCode:   SpellCode_PaladinCrusaderStrike,
 		SpellSchool: core.SpellSchoolHoly,
 		DefenseType: core.DefenseTypeMelee,
 		ProcMask:    core.ProcMaskMeleeMHSpecial,

sim/paladin/divine_storm.go

@@ -23,6 +23,7 @@ func (paladin *Paladin) registerDivineStorm() {
 
 	divineStormSpell := paladin.RegisterSpell(core.SpellConfig{
 		ActionID:    healthMetrics.ActionID,
+		SpellCode:   SpellCode_PaladinDivineStorm,
 		SpellSchool: core.SpellSchoolPhysical,
 		DefenseType: core.DefenseTypeMelee,
 		ProcMask:    core.ProcMaskMeleeMHSpecial,

sim/paladin/hammer_of_the_righteous.go

@@ -19,6 +19,7 @@ func (paladin *Paladin) registerHammerOfTheRighteous() {
 
 	paladin.GetOrRegisterSpell(core.SpellConfig{
 		ActionID:    core.ActionID{SpellID: int32(proto.PaladinRune_RuneWristHammerOfTheRighteous)},
+		SpellCode:   SpellCode_PaladinHammerOfTheRighteous,
 		SpellSchool: core.SpellSchoolHoly,
 		DefenseType: core.DefenseTypeMelee,
 		ProcMask:    core.ProcMaskMeleeMHSpecial,

sim/paladin/item_sets_pve.go

@@ -408,7 +408,11 @@ var ItemSetWilfullJudgement = core.NewItemSet(core.ItemSet{
 			procChance := 0.2 * float64(paladin.Talents.Reckoning)
 
 			handler := func(sim *core.Simulation, spell *core.Spell, result *core.SpellResult) {
-				paladin.AutoAttacks.ExtraMHAttack(sim, 1, actionID, spell.ActionID)
+				if paladin.Options.IsManuallyTriggeringAutoAttacks {
+					paladin.AutoAttacks.StoreExtraMHAttack(sim, 1, actionID, spell.ActionID)
+				} else {
+					paladin.AutoAttacks.ExtraMHAttack(sim, 1, actionID, spell.ActionID)
+				}
 			}
 
 			core.MakeProcTriggerAura(&c.Unit, core.ProcTrigger{

sim/paladin/paladin.go

@@ -17,19 +17,33 @@ const (
 )
 
 const (
-	SpellCode_PaladinNone = iota
-
+	SpellCode_PaladinNone int32 = 0
+	// Judgements
+	SpellCode_PaladinJudgementOfCommand = 1 << iota
+	SpellCode_PaladinJudgementOfMartyrdom
+	SpellCode_PaladinJudgementOfRighteousness
+	SpellCode_PaladinJudgementOfTheCrusader
+	// Special attacks that enable autoattacks/trigger extra attacks
+	SpellCode_PaladinCrusaderStrike
+	SpellCode_PaladinDivineStorm
+	SpellCode_PaladinHammerOfTheRighteous
+	SpellCode_PaladinShieldOfRighteousness
+	// Other spells
 	SpellCode_PaladinExorcism
 	SpellCode_PaladinHolyShock
 	SpellCode_PaladinHolyWrath
-	SpellCode_PaladinJudgementOfCommand
 	SpellCode_PaladinConsecration
 	SpellCode_PaladinAvengersShield
 	SpellCode_PaladinHolyShield
 	SpellCode_PaladinHolyShieldProc
 	SpellCode_PaladinLayOnHands
 )
 
+const (
+	SpellCode_PaladinJudgements          int32 = SpellCode_PaladinJudgementOfCommand | SpellCode_PaladinJudgementOfMartyrdom | SpellCode_PaladinJudgementOfRighteousness | SpellCode_PaladinJudgementOfTheCrusader
+	SpellCode_PaladinTriggersExtraAttack       = SpellCode_PaladinJudgements | SpellCode_PaladinCrusaderStrike | SpellCode_PaladinDivineStorm | SpellCode_PaladinHammerOfTheRighteous | SpellCode_PaladinShieldOfRighteousness
+)
+
 type SealJudgeCode uint8
 
 const (
@@ -86,6 +100,7 @@ type Paladin struct {
 	enableMultiJudge    bool
 	lingerDuration      time.Duration
 	consumeSealsOnJudge bool
+	stopAttackMacroMask int32
 }
 
 // Implemented by each Paladin spec.
@@ -109,6 +124,8 @@ func (paladin *Paladin) AddPartyBuffs(_ *proto.PartyBuffs) {
 }
 
 func (paladin *Paladin) Initialize() {
+	paladin.stopAttackMacroMask = paladin.getStopAttackMacroMask()
+	paladin.registerStopAttackMacros()
 	paladin.registerRighteousFury()
 	// Judgement and Seals
 	paladin.registerJudgement()
@@ -149,7 +166,6 @@ func (paladin *Paladin) Initialize() {
 	paladin.lingerDuration = time.Millisecond * 400
 	paladin.consumeSealsOnJudge = true
 
-	paladin.registerStopAttackMacros()
 }
 
 func (paladin *Paladin) Reset(_ *core.Simulation) {
@@ -202,22 +218,34 @@ func (paladin *Paladin) ResetPrimarySeal(primarySeal proto.PaladinSeal) {
 }
 
 func (paladin *Paladin) registerStopAttackMacros() {
+	paladin.OnSpellRegistered(func(spell *core.Spell) {
+		if paladin.stopAttackMacroMask&spell.SpellCode != 0 {
+			spell.Flags |= core.SpellFlagBatchStopAttackMacro
+		}
+	})
+}
 
-	if paladin.divineStorm != nil && paladin.Options.IsUsingDivineStormStopAttack {
-		paladin.divineStorm.Flags |= core.SpellFlagBatchStopAttackMacro
+func (paladin *Paladin) getStopAttackMacroMask() int32 {
+	options := paladin.Options
+	if options.IsManuallyTriggeringAutoAttacks {
+		return SpellCode_PaladinTriggersExtraAttack
 	}
 
-	if paladin.crusaderStrike != nil && paladin.Options.IsUsingCrusaderStrikeStopAttack {
-		paladin.crusaderStrike.Flags |= core.SpellFlagBatchStopAttackMacro
+	bitMask := SpellCode_PaladinNone
+
+	spellCodes := []int32{
+		core.TernaryInt32(options.IsUsingJudgementStopAttack, SpellCode_PaladinJudgements, SpellCode_PaladinNone),
+		core.TernaryInt32(options.IsUsingCrusaderStrikeStopAttack, SpellCode_PaladinCrusaderStrike, SpellCode_PaladinNone),
+		core.TernaryInt32(options.IsUsingDivineStormStopAttack, SpellCode_PaladinDivineStorm, SpellCode_PaladinNone),
+		core.TernaryInt32(options.IsUsingHammerOfTheRighteousStopAttack, SpellCode_PaladinHammerOfTheRighteous, SpellCode_PaladinNone),
+		core.TernaryInt32(options.IsUsingShieldOfRighteousnessStopAttack, SpellCode_PaladinShieldOfRighteousness, SpellCode_PaladinNone),
 	}
 
-	for _, spellsJoX := range paladin.allJudgeSpells {
-		for _, v := range spellsJoX {
-			if v != nil && paladin.Options.IsUsingJudgementStopAttack {
-				v.Flags |= core.SpellFlagBatchStopAttackMacro
-			}
-		}
+	for _, spellCode := range spellCodes {
+		bitMask |= spellCode
 	}
+
+	return bitMask
 }
 
 func (paladin *Paladin) ResetCurrentPaladinAura() {

sim/paladin/protection/protection.go

@@ -29,13 +29,8 @@ func NewProtectionPaladin(character *core.Character, options *proto.Player) *Pro
 	pal := paladin.NewPaladin(character, options, protOptions)
 
 	prot := &ProtectionPaladin{
-		Paladin:                         pal,
-		primarySeal:                     protOptions.PrimarySeal,
-		righteousFury:                   protOptions.RighteousFury,
-		IsUsingDivineStormStopAttack:    protOptions.IsUsingDivineStormStopAttack,
-		IsUsingJudgementStopAttack:      protOptions.IsUsingJudgementStopAttack,
-		IsUsingCrusaderStrikeStopAttack: protOptions.IsUsingCrusaderStrikeStopAttack,
-		personalBlessing:                protOptions.PersonalBlessing,
+		Paladin:     pal,
+		primarySeal: protOptions.PrimarySeal,
 	}
 
 	prot.EnableAutoAttacks(prot, core.AutoAttackOptions{
@@ -49,12 +44,7 @@ func NewProtectionPaladin(character *core.Character, options *proto.Player) *Pro
 type ProtectionPaladin struct {
 	*paladin.Paladin
 
-	primarySeal                     proto.PaladinSeal
-	righteousFury                   bool
-	IsUsingDivineStormStopAttack    bool
-	IsUsingJudgementStopAttack      bool
-	IsUsingCrusaderStrikeStopAttack bool
-	personalBlessing                proto.Blessings
+	primarySeal proto.PaladinSeal
 }
 
 func (prot *ProtectionPaladin) GetPaladin() *paladin.Paladin {

sim/paladin/retribution/retribution.go

@@ -29,11 +29,8 @@ func NewRetributionPaladin(character *core.Character, options *proto.Player) *Re
 	pal := paladin.NewPaladin(character, options, retOptions)
 
 	ret := &RetributionPaladin{
-		Paladin:                         pal,
-		primarySeal:                     retOptions.PrimarySeal,
-		IsUsingDivineStormStopAttack:    retOptions.IsUsingDivineStormStopAttack,
-		IsUsingJudgementStopAttack:      retOptions.IsUsingJudgementStopAttack,
-		IsUsingCrusaderStrikeStopAttack: retOptions.IsUsingCrusaderStrikeStopAttack,
+		Paladin:     pal,
+		primarySeal: retOptions.PrimarySeal,
 	}
 
 	ret.EnableAutoAttacks(ret, core.AutoAttackOptions{
@@ -47,10 +44,7 @@ func NewRetributionPaladin(character *core.Character, options *proto.Player) *Re
 type RetributionPaladin struct {
 	*paladin.Paladin
 
-	primarySeal                     proto.PaladinSeal
-	IsUsingDivineStormStopAttack    bool
-	IsUsingJudgementStopAttack      bool
-	IsUsingCrusaderStrikeStopAttack bool
+	primarySeal proto.PaladinSeal
 }
 
 func (ret *RetributionPaladin) GetPaladin() *paladin.Paladin {

sim/paladin/runes.go

@@ -226,7 +226,11 @@ func (paladin *Paladin) registerAegis() {
 		Outcome:    core.OutcomeLanded,
 		ProcChance: procChance,
 		Handler: func(sim *core.Simulation, spell *core.Spell, result *core.SpellResult) {
-			paladin.AutoAttacks.ExtraMHAttack(sim, 1, procID, spell.ActionID)
+			if paladin.Options.IsManuallyTriggeringAutoAttacks {
+				paladin.AutoAttacks.StoreExtraMHAttack(sim, 1, procID, spell.ActionID)
+			} else {
+				paladin.AutoAttacks.ExtraMHAttack(sim, 1, procID, spell.ActionID)
+			}
 		},
 	})
 }

sim/paladin/shield_of_righteousness.go

@@ -19,6 +19,7 @@ func (paladin *Paladin) registerShieldOfRighteousness() {
 
 	paladin.RegisterSpell(core.SpellConfig{
 		ActionID:    core.ActionID{SpellID: int32(proto.PaladinRune_RuneCloakShieldOfRighteousness)},
+		SpellCode:   SpellCode_PaladinShieldOfRighteousness,
 		SpellSchool: core.SpellSchoolHoly,
 		DefenseType: core.DefenseTypeMelee,
 		ProcMask:    core.ProcMaskMeleeMHSpecial,

sim/paladin/som.go

@@ -18,6 +18,7 @@ func (paladin *Paladin) registerSealOfMartyrdom() {
 
 	judgeSpell := paladin.RegisterSpell(core.SpellConfig{
 		ActionID:    core.ActionID{SpellID: 407803},
+		SpellCode:   SpellCode_PaladinJudgementOfMartyrdom,
 		SpellSchool: core.SpellSchoolHoly,
 		DefenseType: core.DefenseTypeMelee,
 		ProcMask:    core.ProcMaskMeleeMHSpecial,

sim/paladin/sor.go

@@ -72,6 +72,7 @@ func (paladin *Paladin) registerSealOfRighteousness() {
 
 		judgeSpell := paladin.RegisterSpell(core.SpellConfig{
 			ActionID:    core.ActionID{SpellID: rank.judge.spellID},
+			SpellCode:   SpellCode_PaladinJudgementOfRighteousness,
 			SpellSchool: core.SpellSchoolHoly,
 			DefenseType: core.DefenseTypeMagic,
 			ProcMask:    core.ProcMaskSpellDamage,

sim/paladin/sotc.go

@@ -51,6 +51,7 @@ func (paladin *Paladin) registerSealOfTheCrusader() {
 
 		judgeSpell := paladin.RegisterSpell(core.SpellConfig{
 			ActionID:    core.ActionID{SpellID: rank.judge.spellID},
+			SpellCode:   SpellCode_PaladinJudgementOfTheCrusader,
 			SpellSchool: core.SpellSchoolHoly,
 			DefenseType: core.DefenseTypeMagic,
 			ProcMask:    core.ProcMaskEmpty,

sim/paladin/talents.go

@@ -109,7 +109,11 @@ func (paladin *Paladin) applyReckoning() {
 		ProcMask:   core.ProcMaskMeleeOrRanged,
 		ProcChance: procChance,
 		Handler: func(sim *core.Simulation, spell *core.Spell, result *core.SpellResult) {
-			paladin.AutoAttacks.ExtraMHAttack(sim, 1, procID, spell.ActionID)
+			if paladin.Options.IsManuallyTriggeringAutoAttacks {
+				paladin.AutoAttacks.StoreExtraMHAttack(sim, 1, procID, spell.ActionID)
+			} else {
+				paladin.AutoAttacks.ExtraMHAttack(sim, 1, procID, spell.ActionID)
+			}
 		},
 	})
 }

ui/protection_paladin/inputs.ts

@@ -46,6 +46,16 @@ export const RighteousFuryToggle = InputHelpers.makeSpecOptionsBooleanIconInput<
 	changeEmitter: (player: Player<Spec.SpecProtectionPaladin>) => TypedEvent.onAny([player.gearChangeEmitter, player.specOptionsChangeEmitter]),
 });
 
+export const ManualAutoAttacksToggle = InputHelpers.makeSpecOptionsBooleanInput<Spec.SpecProtectionPaladin>({
+	fieldName: 'isManuallyTriggeringAutoAttacks',
+	label: 'Manually Triggered Autoattacks',
+	labelTooltip: `\
+	Simulates combat where autoattacks are manually enabled only when the swing timer is ready and turned off again immediately after the melee swing occurs.
+	Enabling this feature also assumes that all rotational abilities that initiate autoattacks (e.g. Hammer of the Righteous) are cast with a stopattack/@target macro.`,
+	showWhen: player => player.sim.getShowExperimental(),
+	changeEmitter: player => TypedEvent.onAny([player.specOptionsChangeEmitter, player.sim.showExperimentalChangeEmitter]),
+});
+
 // The below is used in the custom APL action "Cast Primary Seal".
 // Only shows SoC if it's talented.
 export const PrimarySealSelection = InputHelpers.makeSpecOptionsEnumIconInput<Spec.SpecProtectionPaladin, PaladinSeal>({

ui/protection_paladin/sim.ts

@@ -33,6 +33,21 @@ const SPEC_CONFIG = registerSpecConfig(Spec.SpecProtectionPaladin, {
 				},
 			};
 		},
+		(simUI: IndividualSimUI<Spec.SpecProtectionPaladin>) => {
+			return {
+				updateOn: simUI.player.changeEmitter,
+				getContent: () => {
+					if (simUI.player.getSpecOptions().isManuallyTriggeringAutoAttacks == true) {
+						return `You have enabled Manually Triggered Autoattacks, an experimental feature.
+						  This feature simulates perfect execution of storing extra attacks gained through Rekconing,
+							as well as Wildstrike/HoJ/etc. This is an advanced technique that will be difficult to execute in practice,
+							and any DPS gains with this feature enabled should be treated as a best-case scenario that may not be realized in a real raid encounter.`;
+					} else {
+						return '';
+					}
+				},
+			};
+		},
 	],
 	// All stats for which EP should be calculated.
 	epStats: [
@@ -183,6 +198,7 @@ const SPEC_CONFIG = registerSpecConfig(Spec.SpecProtectionPaladin, {
 			OtherInputs.HpPercentForDefensives,
 			OtherInputs.InspirationUptime,
 			OtherInputs.InFrontOfTarget,
+			ProtectionPaladinInputs.ManualAutoAttacksToggle,
 			//OtherInputs.DistanceFromTarget,
 		],
 	},

ui/retribution_paladin/inputs.ts

@@ -9,17 +9,17 @@ import { TypedEvent } from '../core/typed_event.js';
 // These don't need to be in a separate file but it keeps things cleaner.
 
 export const AuraSelection = InputHelpers.makeSpecOptionsEnumIconInput<Spec.SpecRetributionPaladin, PaladinAura>({
- 	fieldName: 'aura',
- 	values: [
- 		{ value: PaladinAura.NoPaladinAura, tooltip: 'No Aura' },
- 		{ actionId: () => ActionId.fromSpellId(20218), value: PaladinAura.SanctityAura },
- 		//{ actionId: () => ActionId.fromSpellId(10299), value: PaladinAura.DevotionAura },
- 		//{ actionId: () => ActionId.fromSpellId(10299), value: PaladinAura.RetributionAura },
- 		//{ actionId: () => ActionId.fromSpellId(19746), value: PaladinAura.ConcentrationAura },
- 		//{ actionId: () => ActionId.fromSpellId(19888), value: PaladinAura.FrostResistanceAura },
- 		//{ actionId: () => ActionId.fromSpellId(19892), value: PaladinAura.ShadowResistanceAura },
- 		//{ actionId: () => ActionId.fromSpellId(19891), value: PaladinAura.FireResistanceAura },
- 	],
+	fieldName: 'aura',
+	values: [
+		{ value: PaladinAura.NoPaladinAura, tooltip: 'No Aura' },
+		{ actionId: () => ActionId.fromSpellId(20218), value: PaladinAura.SanctityAura },
+		//{ actionId: () => ActionId.fromSpellId(10299), value: PaladinAura.DevotionAura },
+		//{ actionId: () => ActionId.fromSpellId(10299), value: PaladinAura.RetributionAura },
+		//{ actionId: () => ActionId.fromSpellId(19746), value: PaladinAura.ConcentrationAura },
+		//{ actionId: () => ActionId.fromSpellId(19888), value: PaladinAura.FrostResistanceAura },
+		//{ actionId: () => ActionId.fromSpellId(19892), value: PaladinAura.ShadowResistanceAura },
+		//{ actionId: () => ActionId.fromSpellId(19891), value: PaladinAura.FireResistanceAura },
+	],
 });
 
 // The below is used in the custom APL action "Cast Primary Seal".

ui/retribution_paladin/sim.ts

@@ -119,7 +119,13 @@ const SPEC_CONFIG = registerSpecConfig(Spec.SpecRetributionPaladin, {
 	excludeBuffDebuffInputs: [],
 	// Inputs to include in the 'Other' section on the settings tab.
 	otherInputs: {
-		inputs: [OtherInputs.TankAssignment, OtherInputs.InFrontOfTarget, RetributionPaladinInputs.CrusaderStrikeStopAttack, RetributionPaladinInputs.JudgementStopAttack, RetributionPaladinInputs.DivineStormStopAttack],
+		inputs: [
+			OtherInputs.TankAssignment,
+			OtherInputs.InFrontOfTarget,
+			RetributionPaladinInputs.CrusaderStrikeStopAttack,
+			RetributionPaladinInputs.JudgementStopAttack,
+			RetributionPaladinInputs.DivineStormStopAttack,
+		],
 	},
 	encounterPicker: {
 		// Whether to include 'Execute Duration (%)' in the 'Encounter' section of the settings tab.