Test/itemeffects

proto/common.proto

@@ -25,11 +25,12 @@ message ProtoVersion {
 	// protos need to define an api_version field so that the UI code knows
 	// to up-convert these protos to the new format whenever api_version is
 	// missing (0) or lower than current_version_number.
-	option (current_version_number) = 4;
+	option (current_version_number) = 5;
 
 	// The actual field value is only used within unit tests.
 	int32 saved_version_number = 1;
 }
+
 enum ItemLevelState {
     Base = 0;
     ChallengeMode = -1;
@@ -38,13 +39,15 @@ enum ItemLevelState {
     UpgradeStepThree = 3;
     UpgradeStepFour = 4;
 }
+
 message ScalingItemProperties {
     int32 rand_prop_points = 1;
     double weapon_damage_min = 2;
     double weapon_damage_max = 3;
     map<int32, double> stats = 4; // for compactness
 	int32 ilvl = 6;
 }
+
 enum Spec {
 	SpecUnknown = 0;
 
@@ -925,14 +928,6 @@ enum EnchantType {
 	EnchantTypeOffHand = 5;
 }
 
-// Contains only the Enchant info needed by the sim.
-message SimEnchant {
-        int32 effect_id = 1;
-        repeated double stats = 2;
-        string name = 3; // Only needed for unit tests.
-        ItemType type = 4; // Only needed for unit tests.
-}
-
 // Contains only the Gem info needed by the sim.
 message SimGem {
 	int32 id = 1;

proto/db.proto

@@ -17,6 +17,15 @@ message SimDatabase {
 
 }
 
+// Contains only the Enchant info needed by the sim.
+message SimEnchant {
+        int32 effect_id = 1;
+        string name = 2; // Only needed for unit tests.
+        ItemType type = 3; // Only needed for unit tests.
+        repeated double stats = 4;
+        ItemEffect enchant_effect = 5;
+}
+
 // Contains only the Item info needed by the sim.
 message SimItem {
 	int32 id = 1;
@@ -36,6 +45,7 @@ message SimItem {
 	int32 set_id = 12;
 
 	map<int32, ScalingItemProperties> scaling_options = 13; // keys are the all ItemLevelState variants that this item could potentially have
+	ItemEffect item_effect = 14;
 }
 
 message Consumable {

proto/spell.proto

@@ -4,6 +4,48 @@ package proto;
 option go_package = "./proto";
 
 import "common.proto";
+enum ItemEffectType {
+	EffectTypeNone   = 0;
+	EffectTypeProc   = 1;
+	EffectTypeOnUse = 2;
+  }
+
+
+message ScalingItemEffectProperties {
+	// keys are the numeric values of proto.common.Stat
+	map<int32, double> stats = 1;
+	double rppm_ilvl_modifier = 2;
+}
+  message ItemEffect {
+	int32            buff_id         = 1;
+	string buff_name = 9;
+	ItemEffectType   type            = 2;
+	int32            effect_duration = 3;  // seconds
+
+	map<int32, ScalingItemEffectProperties> scaling_options        = 4;
+
+	oneof effect {
+	  ProcEffect  proc   = 7;
+	  OnUseEffect on_use = 8;
+	}
+  }
+
+  message ProcEffect {
+	double      proc_chance = 1;  // e.g. 0.20 = 20%
+	double 		ppm = 3;
+	int32 rppm_scale = 4;
+	// The key represents a Class enum key
+	map<int32, double> spec_modifiers = 5;
+	int32       icd         = 2;  // internal cooldown in seconds
+  }
+
+  message OnUseEffect {
+	int32 cooldown = 1;  // seconds between uses
+
+	int32 category_id = 11;
+
+	int32 category_cooldown = 8;
+  }
 
 message SpellEffect {
     int32 id = 1;

proto/ui.proto

@@ -96,6 +96,7 @@ message UIItem {
 
 	FactionRestriction faction_restriction = 25;
 	map<int32, ScalingItemProperties> scaling_options = 29; // keys are the other ilvl variants that this item could potentially have
+	ItemEffect item_effect = 30;
 }
 
 enum Expansion {
@@ -205,6 +206,7 @@ message UIEnchant {
 	// Classes that are allowed to use the enchant. Empty indicates no special class restrictions.
 	repeated Class class_allowlist = 11;
 	Profession required_profession = 12;
+	ItemEffect enchant_effect = 14;
 }
 
 message UIGem {

sim/common/cata/damage_procs.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/wowsims/cata/sim/common/shared"
 	"github.com/wowsims/cata/sim/core"
+	"github.com/wowsims/cata/sim/core/proto"
 )
 
 func init() {
@@ -42,7 +43,7 @@ func init() {
 		},
 	})
 
-	core.NewItemEffect(68925, func(agent core.Agent) {
+	core.NewItemEffect(68925, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		// Proc chance determined to be p=.48 by video research - Researched by InDebt & Frostbitten
 		// Research: https://github.com/wowsims/cata/pull/1009#issuecomment-2348700653
@@ -96,7 +97,7 @@ func init() {
 		character.ItemSwap.RegisterProc(68925, aura)
 	})
 
-	core.NewItemEffect(69110, func(agent core.Agent) {
+	core.NewItemEffect(69110, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		// Proc chance determined to be p=.48 by video research - Researched by InDebt & Frostbitten
 		// Research: https://github.com/wowsims/cata/pull/1009#issuecomment-2348700653

sim/common/cata/dragonwrath.go

@@ -193,7 +193,7 @@ func GetDRTSpellConfig(spell *core.Spell) core.SpellConfig {
 }
 
 func init() {
-	core.NewItemEffect(71086, func(a core.Agent) {
+	core.NewItemEffect(71086, func(a core.Agent, _ proto.ItemLevelState) {
 		character := a.GetCharacter()
 		unit := &character.Unit
 		registerSpells(unit)

sim/common/cata/enchant_effects.go

@@ -12,7 +12,7 @@ import (
 func init() {
 
 	// Enchant: 4066, Spell: 74195 - Enchant Weapon - Mending
-	core.NewEnchantEffect(4066, func(agent core.Agent) {
+	core.NewEnchantEffect(4066, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		healthMetrics := character.NewHealthMetrics(core.ActionID{SpellID: 74194})
 
@@ -51,7 +51,7 @@ func init() {
 	// Enchant: 4067, Spell: 74197 - Enchant Weapon - Avalanche
 	// http://elitistjerks.com/f79/t110302-enhsim_cataclysm/p4/#post1832162
 	// Research indicates that the proc itself does not behave as game tables suggest <.<
-	core.NewEnchantEffect(4067, func(agent core.Agent) {
+	core.NewEnchantEffect(4067, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		procSpell := character.RegisterSpell(core.SpellConfig{
 			ActionID:    core.ActionID{SpellID: 74196},
@@ -118,7 +118,7 @@ func init() {
 	})
 
 	// Enchant: 4074, Spell: 74211 - Enchant Weapon - Elemental Slayer
-	core.NewEnchantEffect(4074, func(agent core.Agent) {
+	core.NewEnchantEffect(4074, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		procSpell := character.RegisterSpell(core.SpellConfig{
 			ActionID:    core.ActionID{SpellID: 74208},
@@ -153,7 +153,7 @@ func init() {
 	})
 
 	// Enchant: 4083, Spell: 74223 - Enchant Weapon - Hurricane
-	core.NewEnchantEffect(4083, func(agent core.Agent) {
+	core.NewEnchantEffect(4083, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 
 		procBuilder := func(name string, tag int32) *core.StatBuffAura {
@@ -288,7 +288,7 @@ func init() {
 	})
 
 	// Enchant: 4099, Spell: 74246 - Enchant Weapon - Landslide
-	core.NewEnchantEffect(4099, func(agent core.Agent) {
+	core.NewEnchantEffect(4099, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 
 		mainHand := character.NewTemporaryStatsAura(
@@ -384,12 +384,12 @@ func init() {
 	})
 
 	// Enchant: 4176, Item: 59595 - R19 Threatfinder
-	core.NewEnchantEffect(4176, func(agent core.Agent) {
+	core.NewEnchantEffect(4176, func(agent core.Agent, _ proto.ItemLevelState) {
 		agent.GetCharacter().AddBonusRangedHitPercent(88 / core.PhysicalHitRatingPerHitPercent)
 	})
 
 	// Enchant: 4177, Item: 59596 - Safety Catch Removal Kit
-	core.NewEnchantEffect(4177, func(agent core.Agent) {
+	core.NewEnchantEffect(4177, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		// TODO: This should be ranged-only haste. For now just make it hunter-only.
 		if character.Class == proto.Class_ClassHunter {
@@ -463,7 +463,7 @@ func init() {
 	}
 
 	for _, enchantID := range movementSpeedEnchants {
-		core.NewEnchantEffect(enchantID, func(agent core.Agent) {
+		core.NewEnchantEffect(enchantID, func(agent core.Agent, _ proto.ItemLevelState) {
 			character := agent.GetCharacter()
 			aura := character.NewMovementSpeedAura("Minor Run Speed", core.ActionID{SpellID: 13889}, 0.08)
 

sim/common/cata/gurthalak.go

@@ -28,7 +28,7 @@ func init() {
 		gurthalakItemID := gurthalakItemIDs[version]
 		summonSpellID := []int32{109838, 107818, 109840}[version]
 
-		core.NewItemEffect(gurthalakItemID, func(agent core.Agent) {
+		core.NewItemEffect(gurthalakItemID, func(agent core.Agent, _ proto.ItemLevelState) {
 			var gurthalak GurthalakAgent
 			if gurth, canEquip := agent.(GurthalakAgent); canEquip {
 				gurthalak = gurth

sim/common/cata/metagems.go

@@ -2,6 +2,7 @@ package cata
 
 import (
 	"github.com/wowsims/cata/sim/core"
+	"github.com/wowsims/cata/sim/core/proto"
 	"github.com/wowsims/cata/sim/core/stats"
 )
 
@@ -10,30 +11,30 @@ func init() {
 	// Keep these in order by item ID
 
 	// Fleet Shadowspirit Diamond
-	core.NewItemEffect(52289, func(agent core.Agent) {
+	core.NewItemEffect(52289, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		character.NewMovementSpeedAura("Minor Run Speed", core.ActionID{SpellID: 13889}, 0.08)
 	})
 
 	// Bracing Shadowspirit Diamond
-	core.NewItemEffect(52292, func(agent core.Agent) {
+	core.NewItemEffect(52292, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		character.PseudoStats.ThreatMultiplier *= 0.98
 	})
 
 	// Eternal Shadowspirit Diamond
-	core.NewItemEffect(52293, func(agent core.Agent) {
+	core.NewItemEffect(52293, func(agent core.Agent, _ proto.ItemLevelState) {
 		agent.GetCharacter().PseudoStats.BlockDamageReduction += 0.01
 	})
 
 	// Austere Shadowspirit Diamond
-	core.NewItemEffect(52294, func(agent core.Agent) {
+	core.NewItemEffect(52294, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		character.ApplyEquipScaling(stats.Armor, 1.02)
 	})
 
 	// Effulgent Shadowspirit Diamond
-	core.NewItemEffect(52295, func(agent core.Agent) {
+	core.NewItemEffect(52295, func(agent core.Agent, _ proto.ItemLevelState) {
 		character := agent.GetCharacter()
 		character.PseudoStats.SchoolDamageTakenMultiplier[stats.SchoolIndexArcane] *= 0.98
 		character.PseudoStats.SchoolDamageTakenMultiplier[stats.SchoolIndexFire] *= 0.98
@@ -44,14 +45,14 @@ func init() {
 	})
 
 	// Ember Shadowspirit Diamond
-	core.NewItemEffect(52296, func(agent core.Agent) {
+	core.NewItemEffect(52296, func(agent core.Agent, _ proto.ItemLevelState) {
 		agent.GetCharacter().MultiplyStat(stats.Mana, 1.02)
 	})
 
 	// These are handled in character.go, but create empty effects so they are included in tests.
-	core.NewItemEffect(52291, func(_ core.Agent) {}) // Chaotic Shadowspirit Diamond
-	core.NewItemEffect(52297, func(_ core.Agent) {}) // Revitalizing Shadowspirit Diamond
-	core.NewItemEffect(68778, func(_ core.Agent) {}) // Agile Shadowspirit Diamond
-	core.NewItemEffect(68779, func(_ core.Agent) {}) // Reverberating Shadowspirit Diamond
-	core.NewItemEffect(68780, func(_ core.Agent) {}) // Burning Shadowspirit Diamond
+	core.NewItemEffect(52291, func(_ core.Agent, _ proto.ItemLevelState) {}) // Chaotic Shadowspirit Diamond
+	core.NewItemEffect(52297, func(_ core.Agent, _ proto.ItemLevelState) {}) // Revitalizing Shadowspirit Diamond
+	core.NewItemEffect(68778, func(_ core.Agent, _ proto.ItemLevelState) {}) // Agile Shadowspirit Diamond
+	core.NewItemEffect(68779, func(_ core.Agent, _ proto.ItemLevelState) {}) // Reverberating Shadowspirit Diamond
+	core.NewItemEffect(68780, func(_ core.Agent, _ proto.ItemLevelState) {}) // Burning Shadowspirit Diamond
 }